NeoML 是一个端到端的机器学习框架，允许您构建、训练和部署机器学习模型。该框架由 ABBYY 的工程师用于计算机视觉和自然语言处理任务，包括图像预处理、分类、文档布局分析、OCR 以及从结构化和非结构化文档中提取数据。

主要特性：

• 支持超过 100 种层类型的神经网络
• 传统机器学习：20 多种算法（分类、回归、聚类等）
• 支持 CPU 和 GPU，推理速度快
• ONNX 支持
• 支持的语言：Python、C++、Java、Objective-C
• 跨平台：相同的代码可以在 Windows、Linux、macOS、iOS 和 Android 上运行

目录

• 构建与安装
  • 支持的平台
  • 第三方依赖
  • 构建功能齐全的 C++ 版本
  • 构建适用于 Java 和 Objective-C 的推理版本
• 快速入门
• API 描述
  • 基本原理
    • 平台无关性
    • 数学引擎无关性
    • 多线程支持
    • ONNX 支持
    • 序列化格式
    • GPU 支持
    • FineObj
  • C++ 接口
    • 算法库 NeoML
    • NeoMathEngine
  • Python 模块
  • Java 接口
  • Objective-C 接口
• 许可证

构建与安装

支持的平台

完整版 C++ 库已在以下平台上测试过：

目标操作系统	编译器	架构
Windows 7 及以上（CPU 和 GPU）	MSVC 2019 及以上	x86, x86_64
Ubuntu 14 及以上（CPU）	gcc 5.4 及以上	x86_64
MacOS 10.11 及以上（CPU）	Apple clang 12 及以上	arm64, x86_64
iOS 11 及以上（CPU、GPU）	Apple clang 12 及以上	arm64-v8a, x86_64
Android 5.0 及以上（CPU），Android 7.0 及以上（GPU）	clang 7 及以上	armeabi-v7a, arm64-v8a, x86, x86_64

推理版 Java 和 Objective-C 库已在以下平台上测试过：

目标操作系统	编译器	架构
iOS 11 及以上（CPU、GPU）	Apple clang 12 及以上	arm64-v8a, x86_64
Android 5.0 及以上（CPU），Android 7.0 及以上（GPU）	clang 7 及以上	armeabi-v7a, arm64-v8a, x86, x86_64

第三方依赖

该库使用 CMake 构建（推荐版本 3.18 及以上）。

为了在 Windows、Linux 和 macOS 上获得最佳的 CPU 性能，我们使用 Intel MKL。

在 GPU 上进行计算时，您可以选择在 Windows 或 Linux 上使用 CUDA（版本 11.2 upd.1），或在 Windows、Linux 或 Android 上使用 Vulkan（版本 1.1.130 及以上）。

我们还使用 Google Test 进行测试，并使用 Google Protocol Buffers 来处理 ONNX 模型格式。

为了加速 x86_64 处理器上的某些卷积操作，我们使用非常高效的 JIT 代码生成器 xbyak。

构建功能齐全的 C++ 版本

有关如何为不同平台构建 C++ 库版本的说明，请参阅 此处。

构建适用于 Java 和 Objective-C 的推理版本

有关如何构建仅用于运行已训练神经网络的 Java 和 Objective-C 版本的说明，请参阅 此处。

快速入门

几个带有示例代码的教程将帮助您开始使用该库：

• 训练并使用一个简单的网络
• 使用梯度提升进行分类
• 使用 k-means 算法进行数据聚类

API 描述

基本原则

该库在设计时遵循以下原则：

平台无关性

用户界面与由数学引擎实现的底层计算完全分离。

您只需在程序启动时指定用于计算的数学引擎类型。此外，您还可以选择根据检测到的设备配置自动选择数学引擎。

无论您选择哪种数学引擎，您的机器学习代码其余部分都将保持不变。

数学引擎独立性

每个神经网络仅使用一个数学引擎实例，并且其所有层都必须使用相同的数学引擎创建。如果您选择了 GPU 数学引擎，则所有计算都将由 GPU 完成。这意味着您不能为“轻量级”计算（如向量相加）使用 CPU，而为“重量级”计算（如矩阵乘法）使用 GPU。我们引入这一限制是为了避免设备之间不必要的同步和数据交换。

多线程支持

数学引擎接口是线程安全的；同一个实例可以在不同的网络和不同的线程中使用。

需要注意的是，这可能会带来一定的同步开销。

然而，神经网络实现并非线程安全；网络只能在一个线程中运行。

ONNX 支持

NeoML 库也可以处理由其他框架创建的模型，只要这些模型支持 ONNX 格式即可。请参阅 导入 API 的说明。不过，您无法将 NeoML 训练的模型导出为 ONNX 格式。

序列化格式

该库使用自定义的二进制格式（由 CArchive 和 CArchiveFile 实现）来保存和加载训练好的模型。

GPU 支持

在 GPU 上进行计算通常可以显著提升数学运算的性能。NeoML 库在模型训练和推理过程中均可使用 GPU。此功能为可选设置，具体取决于您的硬件和软件环境。

要在 GPU 上运行，该库需要满足以下条件：

• Windows：支持 CUDA® 11.2 upd. 1 的 NVIDIA® GPU 显卡。
• iOS：Apple A7 及以上型号的 GPU。
• Android：支持 Vulkan 1.0 的设备。
• Linux/macOS：目前尚不支持 GPU 计算。

FineObj

NeoML 库源自 ABBYY 的内部基础设施。出于各种原因，ABBYY 使用名为 FineObj 的跨平台框架。因此，开源版本中使用了该框架的一些基础组件。请参阅 通用类说明。

C++ 接口

NeoML 包含两个 C++ 库：

算法库 NeoML

该库提供了实现各种高级算法的 C++ 对象。它由以下几个部分组成：

• 神经网络
• 分类与回归算法
• 聚类算法
• 辅助算法

NeoMathEngine

用于计算的数学引擎是一个独立的模块，实现了算法库中使用的底层数学函数。用户也可以直接调用这些函数，但通常情况下并不需要。

该模块针对不同平台有不同的实现方式，其中特别包括一个利用 GPU 进行计算的实现。

数学引擎还是一组 C++ 接口，详细说明请参见 此处。

Python 模块

Python 模块的详细文档可在 readthedocs.io 上找到。

Java 接口

为了在 Java 和 Kotlin 中使用该库的推理版本，我们提供了 Java 接口。

Objective-C 接口

为了在 Swift 和 Objective-C 中使用该库的推理版本，我们提供了 Objective-C 接口。

许可证

版权所有 © 2016–2020 ABBYY Production LLC。根据 Apache License, Version 2.0 许可。请参阅 许可证文件。

NeoML 快速上手指南

NeoML 是一个端到端的机器学习框架，支持构建、训练和部署模型。它由 ABBYY 工程师开发，广泛应用于计算机视觉和自然语言处理任务（如图像分类、OCR、文档布局分析等）。该框架支持超过 100 种神经网络层类型及 20 多种传统机器学习算法，并提供 Python、C++、Java 和 Objective-C 接口，可在 Windows、Linux、macOS、iOS 和 Android 上跨平台运行。

环境准备

系统要求

NeoML 的核心 C++ 库已在以下平台测试通过：

目标系统	编译器	架构
Windows 7+ (CPU/GPU)	MSVC 2019+	x86, x86_64
Ubuntu 14+ (CPU)	gcc 5.4+	x86_64
macOS 10.11+ (CPU)	Apple clang 12+	arm64, x86_64
iOS 11+ (CPU/GPU)	Apple clang 12+	arm64-v8a, x86_64
Android 5.0+ (CPU), 7.0+ (GPU)	clang 7+	armeabi-v7a, arm64-v8a, x86, x86_64

注意：目前 Linux 和 macOS 版本暂不支持 GPU 加速。Windows 需配备支持 CUDA 11.2 upd.1 的 NVIDIA 显卡；Android 设备需支持 Vulkan 1.0。

前置依赖

构建项目需要以下工具：

• CMake: 推荐版本 3.18 或更高。
• Intel MKL: (可选) 用于在 Windows/Linux/macOS 上获得最佳 CPU 性能。
• CUDA: (可选，仅 Windows/Linux) 用于 GPU 加速，版本需为 11.2 upd.1。
• Vulkan SDK: (可选，Windows/Linux/Android) 用于 GPU 加速，版本 1.1.130+。
• 其他: Google Test (测试用), Protocol Buffers (ONNX 支持), xbyak (x86_64 JIT 加速)。

安装步骤

NeoML 主要通过源码编译安装。以下是构建完整功能 C++ 版本的通用步骤（以 Linux/CMake 为例）：

1. 克隆仓库

   git clone https://github.com/ABBYY/NeoML.git
   cd NeoML
   

2. 创建构建目录并配置

   mkdir build
   cd build
   cmake .. -DCMAKE_BUILD_TYPE=Release
   # 若需启用 GPU (Windows/Linux with CUDA)，添加: -DUSE_CUDA=ON
   # 若需启用 Intel MKL，添加: -DUSE_MKL=ON
   

3. 编译与安装

   cmake --build . --config Release
   sudo make install
   

Python 用户提示：编译完成后，可在构建目录中找到 Python 模块。具体安装细节请参考官方文档 NeoML/docs/en/Installation/cpp.md。对于仅需推理功能的 Java 或 Objective-C 版本，请参阅 NeoML/docs/en/Installation/inference.md。

基本使用

以下示例展示如何使用 NeoML 进行简单的机器学习任务。更多教程（如梯度提升分类、K-Means 聚类）请参考 NeoML/docs/en/Tutorial/ 目录。

Python 示例：训练并使用简单神经网络

确保已正确编译并安装 Python 模块后，即可导入使用：

import neoml

# 1. 初始化数学引擎 (自动选择可用的 CPU 或 GPU)
math_engine = neoml.MathEngine()

# 2. 创建简单的全连接神经网络
# 假设输入维度为 10，输出类别为 2
dnn = neoml.Dnn(math_engine)
input_layer = dnn.add_input_layer("input", [10])
fc_layer = dnn.add_fully_connected_layer("fc", input_layer, 2)
dnn.add_softmax_layer("output", fc_layer)

# 3. 准备数据 (此处仅为示意，实际需替换为真实数据)
# X_train: 训练特征, y_train: 训练标签
# X_test: 测试特征
X_train = [[0.1]*10, [0.9]*10] 
y_train = [0, 1]

# 4. 训练模型
dnn.train(X_train, y_train, epochs=10)

# 5. 推理预测
predictions = dnn.predict([X_train[0]])
print(f"Prediction: {predictions}")

C++ 核心概念

在 C++ 中使用时，需遵循以下原则：

• 平台无关性：代码逻辑与底层计算引擎分离，只需在启动时指定 MathEngine 类型。
• 线程安全：MathEngine 实例是线程安全的，但 Dnn (神经网络) 实例只能在单线程中运行。
• 序列化：使用 CArchive 和 CArchiveFile 保存和加载训练好的模型（二进制格式）。
• ONNX 支持：可以导入其他框架训练的 ONNX 模型进行推理，但暂不支持将 NeoML 模型导出为 ONNX。

详细 API 文档请访问 NeoML ReadTheDocs。