一个快速、纯头文件的机器学习库

首页 | 下载 | 文档 | 帮助

下载： 当前稳定版本（4.7.0）

mlpack 是一个直观、快速且灵活的纯头文件 C++ 机器学习库，同时提供与其他语言的绑定。它旨在成为机器学习领域的 LAPACK，目标是实现广泛的机器学习方法和功能，为机器学习研究人员提供一把“瑞士军刀”。

mlpack 轻量级的 C++ 实现使其非常适合部署在生产环境中；同时，它也可以通过 C++ 笔记本进行交互式原型开发。

除了强大的 C++ 接口外，mlpack 还提供了命令行工具、Python 绑定、Julia 绑定、Go 绑定和 R 绑定。

快速链接：

• 快速入门指南：C++， CLI，Python， R，Julia， Go
• mlpack 主页
• mlpack 文档
• 示例仓库
• 教程
• 开发站点（Github）

mlpack 采用 开放治理模式，并由 NumFOCUS 提供财政支持。请考虑进行一次 可抵税捐赠，以帮助项目支付开发者时间、专业服务、差旅、研讨会以及其他各种需求。

0. 目录

1. 引用信息
2. 依赖项
3. 安装
4. 从 C++ 中使用
   1. 减少编译时间
5. 构建 mlpack 的测试套件
6. 更多资源

1. 引用信息

如果您在研究或软件中使用了 mlpack，请使用以下 BibTeX 格式的引用：

@article{mlpack2023,
    title     = {mlpack 4：一个快速、纯头文件的 C++ 机器学习库},
    author    = {Ryan R. Curtin 和 Marcus Edel 和 Omar Shrit 和 
                 Shubham Agrawal 和 Suryoday Basak 和 James J. Balamuta 和 
                 Ryan Birmingham 和 Kartik Dutt 和 Dirk Eddelbuettel 和 
                 Rishabh Garg 和 Shikhar Jaiswal 和 Aakash Kaushik 和 
                 Sangyeon Kim 和 Anjishnu Mukherjee 和 Nanubala Gnana Sai 和 
                 Nippun Sharma 和 Yashwant Singh Parihar 和 Roshan Swain 和 
                 Conrad Sanderson},
    journal   = {Journal of Open Source Software},
    volume    = {8},
    number    = {82},
    pages     = {5026},
    year      = {2023},
    doi       = {10.21105/joss.05026},
    url       = {https://doi.org/10.21105/joss.05026}
}

引用有助于 mlpack 的发展与改进。

2. 参考文献

mlpack 需要以下额外依赖项：

• C++17 编译器
• Armadillo   >= 10.8
• ensmallen  >= 2.10.0
• cereal     >= 1.1.2

mlpack 自带了 STB、httplib 和 dr_libs 等纯头文件库，分别用于图像加载、数据集下载和音频加载支持。如果您更倾向于使用系统中已有的版本，请参阅 编译选项。

如果您手动编译 Armadillo，请确保已启用 LAPACK 和 BLAS。

3. 安装

详细的安装说明可在 安装 mlpack 页面找到。

4. 在 C++ 中的使用

当通过 make install 安装了头文件后，在应用程序中使用 mlpack 只需包含相应的头文件即可。因此，您的程序应包含 mlpack 头文件：

#include <mlpack.hpp>

在链接时，请确保链接到 Armadillo 库。假设您的示例程序名为 my_program.cpp，编译器为 GCC，并且您希望启用 OpenMP 支持（推荐）和优化选项，则可以按以下方式编译：

g++ -O3 -std=c++17 -o my_program my_program.cpp -larmadillo -fopenmp

请注意，如果您希望序列化（保存或加载）神经网络，应在包含 <mlpack.hpp> 之前定义 #define MLPACK_ENABLE_ANN_SERIALIZATION。如果不定义该宏而代码尝试序列化神经网络，将会导致编译错误。

MLPACK_ENABLE_ANN_SERIALIZATION 允许您使用 arma::mat 作为矩阵类型来序列化网络。您也可以定义 MLPACK_ENABLE_ANN_SERIALIZATION_FMAT 来使用 arma::fmat 进行序列化。

警告： 较旧版本的 OpenBLAS（0.3.26 及更早版本）在编译时使用 pthreads 时，可能会启动过多的线程进行计算，从而导致性能显著下降。而使用 OpenMP 编译的 OpenBLAS 版本则不会出现此问题。有关详细信息及简单解决方案，请参阅 测试构建指南。

另请参阅：

• 安装文档中的 测试程序编译部分，
• C++ 快速入门，以及
• 示例仓库，其中包含一些 mlpack 在 C++ 中的应用示例及其对应的 Makefile。

4.1. 减少编译时间

mlpack 是一个高度依赖模板的库，若不加以注意，项目的编译时间可能会非常长。幸运的是，有几种方法可以有效减少编译时间：

• 如果您只使用 mlpack 的某个特定组件，可以单独包含相应头文件，例如 <mlpack/methods/decision_tree.hpp>，而不是包含 <mlpack.hpp>。这样可以减少编译器的工作量。

• 仅在代码中需要序列化神经网络时才使用 MLPACK_ENABLE_ANN_SERIALIZATION 宏定义。启用该宏会显著增加编译时间，因为编译器必须为每种可能的层类型生成代码。（正是由于额外的大量编译开销，该宏默认未启用。）

• 如果您在多个 .cpp 文件中使用 mlpack，可以考虑使用 extern templates，使编译器只需对每个模板实例化一次；在每个需要使用 mlpack 模板类型的 .cpp 文件中添加显式模板实例化声明，然后在其他文件中使用 extern 声明来告知编译器该模板已在另一文件中定义。

此外，还有预编译头文件、编译器选项、ccache 等其他策略可用于进一步优化编译效率。

5. 构建 mlpack 的测试套件

请参阅安装说明中的 构建测试部分。

6. 更多资源

针对用户和开发者，我们提供了更多文档资料。

• 文档主页

要了解 mlpack 在短期和中期内的开发目标，请参阅 愿景文档。

如果您遇到问题、发现 bug 或需要帮助，可以访问 mlpack 帮助页面，或前往 mlpack 的 GitHub 仓库。此外，您也可以在 Matrix 上的 #mlpack 频道寻求帮助；更多信息请参阅 社区页面。

mlpack 快速上手指南

mlpack 是一个快速、灵活且仅包含头文件的 C++ 机器学习库，旨在成为机器学习领域的"瑞士军刀"。它提供了直观的 C++ 接口，并支持 Python、R、Julia、Go 等多种语言绑定。

1. 环境准备

系统要求

• 编译器：支持 C++17 标准的编译器（如 GCC 7+ 或 Clang 5+）
• 构建工具：CMake, Make

前置依赖

安装 mlpack 前，请确保系统已安装以下库（版本需满足最低要求）：

依赖库	最低版本	说明
Armadillo	>= 10.8	线性代数库（编译时需启用 LAPACK 和 BLAS）
ensmallen	>= 2.10.0	优化库
cereal	>= 1.1.2	序列化库

注意：mlpack 内部已捆绑 STB (图像加载), cpp-httplib (数据集下载), 和 dr_libs (音频加载) 库，通常无需单独安装。若使用 Ubuntu/Debian 系统，可通过包管理器一键安装主要依赖：

sudo apt-get install libarmadillo-dev libensmallen-dev libcereal-dev

2. 安装步骤

方式一：使用包管理器（推荐 Linux 用户）

对于 Ubuntu/Debian 用户，可直接安装预编译版本：

sudo apt-get update
sudo apt-get install mlpack libmlpack-dev

方式二：源码编译安装（通用）

若需最新版本或自定义配置，请按以下步骤操作：

1. 下载源码 访问官网下载最新稳定版 (4.7.0) 或使用 git 克隆：

   wget https://www.mlpack.org/files/mlpack-4.7.0.tar.gz
   tar -xzf mlpack-4.7.0.tar.gz
   cd mlpack-4.7.0
   

2. 创建构建目录并配置

   mkdir build
   cd build
   cmake ..
   

   注：若依赖库安装在非标准路径，可使用 -D 参数指定，例如 -DARMADILLO_INCLUDE_DIR=/path/to/armadillo/include。

3. 编译与安装

   make -j4
   sudo make install
   

3. 基本使用 (C++)

mlpack 是头文件库，安装后只需在代码中包含主头文件即可使用。

最简单的示例

创建一个名为 my_program.cpp 的文件：

#include <mlpack.hpp>

int main()
{
  // 打印 mlpack 版本信息
  std::cout << "mlpack version: " << MLPACK_VERSION << std::endl;
  
  // 示例：创建一个简单的数据矩阵
  arma::mat data = {{1.0, 2.0}, {3.0, 4.0}, {5.0, 6.0}};
  
  std::cout << "Data matrix created successfully." << std::endl;
  return 0;
}

编译命令

使用 GCC 编译上述程序，需链接 Armadillo 库并开启优化（推荐开启 OpenMP 支持）：

g++ -O3 -std=c++17 -o my_program my_program.cpp -larmadillo -fopenmp

运行程序

./my_program

进阶提示：减少编译时间

mlpack 模板丰富，全量引入可能导致编译较慢。若仅需特定算法（如决策树），建议单独引入头文件以加速编译：

// 推荐做法：只引入需要的模块
#include <mlpack/methods/decision_tree.hpp>

// 而不是
// #include <mlpack.hpp>

注意：若需保存或加载神经网络模型，必须在包含 <mlpack.hpp> 之前定义宏： #define MLPACK_ENABLE_ANN_SERIALIZATION