什么是xLearn？

xLearn是一个高性能、易用且可扩展的机器学习工具包，包含了线性回归（LR）、因子分解机（FM）和领域感知因子分解机（FFM）等模型，这些模型均可用于解决大规模机器学习问题。xLearn尤其适用于处理大规模稀疏数据的机器学习任务。许多现实世界的数据集都涉及高维稀疏特征向量，例如推荐系统中类别和用户的数量可能达到百万级别。在这种情况下，如果你之前使用过liblinear、libfm或libffm，那么现在xLearn将是你的另一个更优选择。

开始使用！（英文）

开始使用！（中文）

性能

xLearn基于高性能的C++代码开发，并经过精心设计与优化。我们的系统旨在最大化CPU和内存的利用率，提供缓存友好的计算方式，并支持无锁学习。通过结合这些技术优势，xLearn相比同类系统性能提升了5到13倍。

易用性

xLearn不依赖任何第三方库，用户只需克隆代码并使用CMake进行编译即可。此外，xLearn还为数据科学家提供了非常简洁的Python和命令行接口，并支持许多在机器学习和数据挖掘竞赛中广泛使用的实用功能，如交叉验证、早停等。

可扩展性

xLearn可用于解决大规模机器学习问题。它支持外存训练模式，仅需利用个人电脑的硬盘即可处理超大规模数据（TB级别）。

如何贡献

xLearn已经由众多活跃的社区成员开发和使用。你的帮助对提升xLearn的质量至关重要。

• 如果你发现xLearn中的任何bug，请提交贡献。
• 提出你希望在xLearn中看到的新功能。
• 参与测试工作，以提高系统的可靠性。
• 完善文档，使其更加清晰易懂。
• 分享示例代码，与其他用户交流经验。
• 如果在开发过程中遇到问题，请提交issue。

请注意，所有issue和贡献请使用英语提交，以便所有人都能从中受益。

最新动态

• 2019年10月13日 Andrew Kane 为xLearn添加了Ruby绑定！

• 2019年4月25日 xLearn 0.4.4版本发布。主要更新：

  • 支持Python DMatrix
  • 更好的Windows支持
  • 修复了上一版本中的bug

• 2019年3月25日 xLearn 0.4.3版本发布。主要更新：

  • 修复了上一版本中的bug

• 2019年3月12日 xLearn 0.4.2版本发布。主要更新：

  • 发布了Windows版本的xLearn

• 2019年1月30日 xLearn 0.4.1版本发布。主要更新：

  • 数据读取器更加灵活

• 2018年11月22日 xLearn 0.4.0版本发布。主要更新：

  • 修复了上一版本中的bug
  • 为xLearn新增了在线学习功能

• 2018年11月10日 xLearn 0.3.8版本发布。主要更新：

  • 修复了上一版本中的bug
  • 更新了早停机制

• 2018年11月8日，xLearn获得了2000颗星！恭喜！

• 2018年10月29日 xLearn 0.3.7版本发布。主要更新：

  • 新增了增量读取器，可节省50%的内存开销

• 2018年10月22日 xLearn 0.3.5版本发布。主要更新：

  • 修复了0.3.4中的bug

• 2018年10月21日 xLearn 0.3.4版本发布。主要更新：

  • 修复了磁盘训练中的bug
  • 支持新的文件格式

• 2018年10月14日 xLearn 0.3.3版本发布。主要更新：

  • 修复了预测任务中的段错误
  • 更新了早停机制

• 2018年9月21日 xLearn 0.3.2版本发布。主要更新：

  • 修复了上一版本中的bug
  • 模型输出新增TXT格式

• 2018年9月8日，xLearn启用了新Logo：

• 2018年9月7日，中文文档正式上线！

• 2018年3月8日 xLearn 0.3.0版本发布。主要更新：

  • 修复了上一版本中的bug
  • 解决了磁盘学习中的内存泄漏问题
  • 支持TXT格式的模型检查点
  • 支持Scikit-Learn API

• 2017年12月18日 xLearn 0.2.0版本发布。主要更新：

  • 修复了上一版本中的bug
  • 支持通过pip安装
  • 新增文档
  • FTRL算法速度更快

• 2017年11月24日，xLearn的第一个版本（0.1.0）发布！

xLearn 快速上手指南

xLearn 是一个高性能、易用且可扩展的机器学习包，专为解决大规模稀疏数据问题（如推荐系统）而设计。它支持线性模型 (LR)、因子分解机 (FM) 和域感知因子分解机 (FFM)，在性能上比同类库快 5-13 倍。

环境准备

• 操作系统：Linux, macOS, Windows
• 编译器：支持 C++11 的编译器 (如 g++, clang++)
• 构建工具：CMake (版本 2.8 或更高)
• 语言支持：
  • Python (可选，需安装 pip 和 setuptools)
  • Ruby (可选，社区贡献版)
• 依赖项：xLearn 不依赖任何第三方 C++ 库，开箱即用。

安装步骤

你可以选择通过源码编译安装（推荐以获得最佳性能）或使用 Python pip 安装。

方法一：源码编译安装 (通用)

# 1. 克隆仓库
git clone https://github.com/aksnzhy/xLearn.git
cd xlearn

# 2. 创建构建目录并进入
mkdir build && cd build

# 3. 使用 CMake 配置
cmake ..

# 4. 编译
make -j4

# 5. (可选) 安装到系统路径
sudo make install

方法二：Python Pip 安装

pip install xlearn

提示：国内用户若遇到下载慢的问题，可使用国内镜像源加速安装： pip install xlearn -i https://pypi.tuna.tsinghua.edu.cn/simple

基本使用

xLearn 提供了简洁的 Python API 和命令行接口 (CLI)。以下展示最简单的 Python 使用流程，包含模型训练与预测。

Python 示例

import xlearn as xl

# 1. 初始化模型 (以 FFM 为例)
ffm_model = xl.ffm()

# 2. 设置参数
ffm_model.setTrain("./train_data.txt")  # 训练数据
ffm_model.setValidate("./test_data.txt") # 验证数据 (用于早停)
ffm_model.setTask("binary")             # 任务类型：binary (二分类) 或 multi-class
ffm_model.setSign(0.1)                  # 符号函数参数
ffm_model.setLambda(0.002)              # 正则化系数
ffm_model.setEpoch(10)                  # 迭代次数

# 3. 训练模型
# 启用早停机制 (early stop)，当验证集误差不再下降时自动停止
ffm_model.fit()

# 4. 预测
ffm_model.setTest("./test_data.txt")
ffm_model.predict("./output.txt")

命令行 (CLI) 示例

如果你更喜欢直接使用命令行工具：

# 训练模型
./xlearn_train ./train_data.txt -m ./model.out -v ./test_data.txt --task binary --epoch 10

# 进行预测
./xlearn_predict ./test_data.txt ./model.out -o ./output.txt

数据格式说明

xLearn 默认支持 LibSVM 格式或 xLearn 特有的文本格式。对于大规模稀疏数据，建议将类别特征转换为 ID 形式输入。