#MLPNeuralNet

MLPNeuralNet 是一个适用于 iOS 和 Mac OS X 的快速 多层感知器 神经网络库。MLPNeuralNet 通过训练好的神经网络对新样本进行预测。它基于 Apple 的 Accelerate 框架，利用向量化操作和硬件加速（如果可用）。

##为什么使用它？ 假设你已经使用 Matlab（或 Python、R）设计了一个预测模型，并希望在 iOS 应用程序中使用它。如果是这样，MLPNeuralNet 正是你所需要的。MLPNeuralNet 专为仅以 前向传播 模式加载和运行模型而设计。

###特性

• 分类、多分类和回归输出
• 向量化实现
• 支持双精度运算
• 多个隐藏层或无隐藏层（此时等同于逻辑回归或线性回归）

##快速示例 让我们部署一个用于 AND 函数（合取）的模型，其工作方式如下：（当然，在实际应用中并不需要为此使用神经网络）

X1	X2	Y
0	0	0
1	0	0
0	1	0
1	1	1

我们的模型具有以下权重和网络配置：

// 使用指定的初始化方法将网络配置和权重传递给模型。
// 注意：您无需在配置中指定偏置单元（上述 +1）。

NSArray *netConfig = @[@2, @1];
double wts[] = {-30, 20, 20};
NSData *weights = [NSData dataWithBytes:wts length:sizeof(wts)];

MLPNeuralNet *model = [[MLPNeuralNet alloc] initWithLayerConfig:netConfig
                                                        weights:weights
                                                     outputMode:MLPClassification];
// 预测模型对新样本的输出
double sample[] = {0, 1};
NSData * vector = [NSData dataWithBytes:sample length:sizeof(sample)];
NSMutableData * prediction = [NSMutableData dataWithLength:sizeof(double)];
[model predictByFeatureVector:vector intoPredictionVector:prediction];

double * assessment = (double *)prediction.bytes;
NSLog(@"模型评估结果为 %f", assessment[0]);

##扩展示例 假设你使用 pybrain 或甚至自己编写的实现训练了一个网络。

// 使用指定的初始化方法将网络配置和权重传递给模型。
// 注意：您无需在配置中指定偏置单元（上述 +1）。

NSArray *netConfig = @[@3, @2, @1];
double wts[] = {b1, w1, w2, w3, b2, w4, w5, w6, b3, w7, w8};
NSData *weights = [NSData dataWithBytes:wts length:sizeof(wts)];

MLPNeuralNet *model = [[MLPNeuralNet alloc] initWithLayerConfig:netConfig
                                                        weights:weights
                                                     outputMode:MLPClassification];
model.hiddenActivationFunction = MLPSigmoid;
model.outputActivationFunction = MLPNone;

// 预测模型对新样本的输出
double sample[] = {0, 1, 2};
NSData * vector = [NSData dataWithBytes:sample length:sizeof(sample)];
NSMutableData * prediction = [NSMutableData dataWithLength:sizeof(double)];
[model predictByFeatureVector:vector intoPredictionVector:prediction];

double * assessment = (double *)prediction.bytes;
NSLog(@"模型评估结果为 %f", assessment[0]);

##开始使用 以下说明描述了如何使用 CocoaPods 设置和安装 MLPNeuralNet。本文档适用于 Xcode 5 和 iOS 7.x 及更高版本的 SDK。如果您不熟悉 CocoaPods，只需克隆仓库并将 MLPNeuralNet 直接作为子项目导入即可。

##通过 CocoaPods 安装 请将以下行添加到您的 Podfile 中。

pod 'MLPNeuralNet', '~> 1.0.0'

##通过 Carthage 安装 请将以下行添加到您的 Cartfile 中。

github "nikolaypavlov/MLPNeuralNet" "master"

##导入 MLPNeuralNet.h 别忘了在您的模型顶部添加以下行：

#import "MLPNeuralNet.h"

##我需要多少权重来初始化 X->Y->Z 网络？ 大多数流行的库（包括 MLPNeuralNet）都会隐式地为除最后一层以外的每一层添加偏置单元。假设包含这些额外的单元，总权重数量为 (X + 1) * Y + (Y + 1) * Z。

##从其他库导入权重。 您可以为部分可用的神经网络软件包执行此操作。

###R nnet 库：

#假设 nnet_model 是一个训练好的神经网络
nnet_model$wts

###Python NeuroLab

#其中 net 参数是一个 neurolab.core.Net 对象
import neurolab as nl
import numpy as np

def getweights(net):
     vec = []
     for layer in net.layers:
         b = layer.np['b']
         w = layer.np['w']
         newvec = np.ravel(np.concatenate((b, np.ravel(w,order='F'))).reshape((layer.ci+1, layer.cn)), order = 'F')
         [vec.append(nv) for nv in newvec]
     return np.array(vec)

###Python neon

import numpy as np

def layer_names(params):
    layer_names = params.keys()
    layer_names.remove('epochs_complete')
    # 根据它们在模型架构中的出现顺序对层进行排序
    # 由于 neon 将索引附加到层名称上，我们将使用该索引来排序
    layer_names.sort(key=lambda x: int(x.split("_")[-1]))
    return layer_names

def getweights(file_name):
    vec = []
    # 从磁盘加载存储的模型文件（应具有 prm 扩展名）
    params = pkl.load(open(file_name, 'r'))
    layers = layer_names(params)
    
    for layer in layers:
        # 确保我们的模型已激活偏置，否则在此处添加零
        b = params[layer]['biases']
        w = params[layer]['weights']

        newvec = np.ravel(np.hstack((b,w)))
        [vec.append(nv) for nv in newvec]
    return vec

# 一个调用示例
getweights(expanduser('~/data/workout-dl/workout-ep100.prm'))

###Python keras

import numpy as np

def get_weights_from_keras_model(model):
    vec = np.array([])
    for i in range(0, len(model.get_weights()), 2):
        bias = model.get_weights()[i + 1]
        weights_matrix = model.get_weights()[i]

        newvec = np.ravel(np.concatenate((bias.reshape(-1, 1), weights_matrix.T), axis=1))
        vec = np.append(vec, newvec)
    return np.array(vec)

性能基准测试

在本次测试中，神经网络的结构逐层扩展，从 1 -> 1 的配置逐步增加到 200 -> 200 -> 200 -> 1 的配置。每一步都会使用随机输入向量和权重来计算输出并进行性能基准测试。因此，总权重数量也相应地从 2 增加到 80601。我明白这个测试相当理想化，但希望它能够说明性能情况。如果您能提出更好的测试方法，我将非常乐意接受！ :)

单元测试

MLPNeuralNet 在 /MLPNeuralNetTests 子目录中包含了一套多样化的单元测试。您可以在 Xcode 中使用 MLPNeuralNet 方案来运行这些测试。

致谢

MLPNeuralNet 的灵感来源于：

• Andrew Ng 的机器学习课程。
• Jeff Leek 的数据分析课程。

鸣谢：

• 神经网络图片取自 维基百科共享资源。

联系方式

维护者：Mykola Pavlov (me@nikolaypavlov.com)

请告诉我您是如何将 MLPNeuralNet 应用于实际问题中的。

许可证

MLPNeuralNet 采用 BSD 许可证发布。更多信息请参阅 LICENSE 文件。

MLPNeuralNet 快速上手指南

MLPNeuralNet 是一个专为 iOS 和 Mac OS X 设计的高性能多层感知机（MLP）神经网络库。它基于 Apple 的 Accelerate Framework 构建，利用矢量运算和硬件加速，非常适合将在 Matlab、Python 或 R 中训练好的模型部署到苹果生态应用中。

注意：该库仅支持**前向传播（预测）**模式，不支持在移动端进行模型训练。

环境准备

• 操作系统：macOS (开发环境)
• 目标平台：iOS 7.0+ 或 macOS 10.9+
• 开发工具：Xcode 5 或更高版本
• 依赖框架：Apple Accelerate Framework (系统自带，无需额外安装)
• 语言支持：Objective-C (可通过桥接头文件在 Swift 中使用)

安装步骤

你可以通过 CocoaPods 或 Carthage 进行安装，也可以直接作为子项目导入。

方式一：使用 CocoaPods（推荐）

在项目的 Podfile 中添加以下内容：

pod 'MLPNeuralNet', '~> 1.0.0'

然后在终端执行：

pod install

方式二：使用 Carthage

在项目的 Cartfile 中添加以下内容：

github "nikolaypavlov/MLPNeuralNet" "master"

然后在终端执行：

carthage update --platform iOS

方式三：手动导入

如果不熟悉上述工具，可以直接克隆仓库并将 MLPNeuralNet 文件夹拖入 Xcode 项目中作为子项目。

无论采用哪种方式，请确保在使用前导入头文件：

#import "MLPNeuralNet.h"

基本使用

以下示例演示如何加载一个预训练的“与门 (AND)"逻辑模型并进行预测。

1. 配置网络与权重

假设你的网络结构为 2 个输入节点 -> 1 个输出节点。

• 网络配置：@[@2, @1] (无需包含偏置单元)。
• 权重数据：需按照 (上一层节点数 + 1) * 当前层节点数 的顺序排列（包含偏置权重）。

2. 代码示例

// 1. 定义网络层级配置 (输入层 2 节点，输出层 1 节点)
NSArray *netConfig = @[@2, @1];

// 2. 定义权重数组 (包含偏置项 b=-30, 权重 w1=20, w2=20)
double wts[] = {-30, 20, 20};
NSData *weights = [NSData dataWithBytes:wts length:sizeof(wts)];

// 3. 初始化模型
// outputMode 可选：MLPClassification (分类), MLPRegression (回归)
MLPNeuralNet *model = [[MLPNeuralNet alloc] initWithLayerConfig:netConfig
                                                        weights:weights
                                                     outputMode:MLPClassification];

// 4. 准备输入样本 (例如：0 和 1)
double sample[] = {0, 1};
NSData *vector = [NSData dataWithBytes:sample length:sizeof(sample)];

// 5. 创建用于接收预测结果的缓冲区
NSMutableData *prediction = [NSMutableData dataWithLength:sizeof(double)];

// 6. 执行预测
[model predictByFeatureVector:vector intoPredictionVector:prediction];

// 7. 获取结果
double *assessment = (double *)prediction.bytes;
NSLog(@"Model assessment is %f", assessment[0]);

关于权重数量的计算

如果你的网络结构为 X -> Y -> Z，由于库会自动为除最后一层外的每层添加偏置单元，你需要初始化的权重总数为： (X + 1) * Y + (Y + 1) * Z

你可以从 Python (Keras, Neurolab, Neon) 或 R (nnet) 等训练框架中提取权重并转换为上述格式传入。