引用 fastFM

库 fastFM 是一个学术项目。因此，开发 fastFM 所花费的时间和资源可以通过该软件的引用次数来证明其合理性。如果您在使用 fastFM 的情况下发表了科学论文，请引用以下文章（BibTeX 条目位于 citation.bib）。

Bayer, I. “fastFM: 用于因子分解机的库” 《机器学习研究期刊》第 17 卷，第 1–5 页（2016 年）

fastFM：用于因子分解机的库

此仓库使您能够在 Python（2.7 和 3.x）中使用因子分解机，并采用广为人知的 scikit-learn API。所有性能关键代码均用 C 语言编写，并通过 Cython 进行封装。fastFM 提供随机梯度下降（SGD）、坐标下降（CD）优化算法以及用于贝叶斯推断的马尔可夫链蒙特卡洛（MCMC）。这些求解器可用于回归、分类和排序问题。详细的使用说明可在 在线文档 和 arXiv 中找到。

支持的操作系统

fastFM 在 Linux (Ubuntu 14.04 LTS) 和 OS X Mavericks 上设有持续集成/测试服务器（Travis）。其他操作系统目前未得到积极支持。

使用方法

from fastFM import als
fm = als.FMRegression(n_iter=1000, init_stdev=0.1, rank=2, l2_reg_w=0.1, l2_reg_V=0.5)
fm.fit(X_train, y_train)
y_pred = fm.predict(X_test)

教程及其他信息请参见 这里。C 代码作为 子仓库 可用（github.com/ibayer/fastFM-core），并提供独立的命令行界面。如果您在阅读文档后仍有 疑问，请在 GitHub 上提交问题。

任务	求解器	损失函数
回归	als, mcmc, sgd	均方损失
分类	als, mcmc, sgd	Probit(Map)、Probit、Sigmoid
排序	sgd	BPR

支持的求解器和任务

安装

二进制安装（仅限 64 位）

pip install fastFM

源码安装

请确保 Python 版本与操作系统位数一致，例如 64 位操作系统上运行 32 位 Python 将无法正常工作。

# 安装 cblas 和 python-dev 头文件（仅限 Linux）。
# - cblas 可通过 libatlas-base-dev 或 libopenblas-dev 安装（Ubuntu）
$ sudo apt-get install python-dev libopenblas-dev

# 克隆包含子模块的仓库（或先克隆再执行 `git submodule update --init --recursive`）
$ git clone --recursive https://github.com/ibayer/fastFM.git

# 进入根目录
$ cd fastFM

# 安装 Python 依赖项（Cython>=0.22、numpy、pandas、scipy、scikit-learn）
$ pip install -r ./requirements.txt

# 编译 C 扩展。
$ make                      # 使用默认 Python 版本编译（python）
$ PYTHON=python3 make       # 使用自定义 Python 版本编译（python3）

# 安装 fastFM
$ pip install .

测试

Python 测试（需安装 nose）可通过以下命令运行： nosetests fastFM/fastFM/tests

有关如何运行位于 fastFM/fastFM-core/src/tests 的 C 测试，请参阅 fastFM-core 的 README 文件。

贡献

• 给本仓库加星标：激励贡献者
• 提交问题：报告错误或提出改进建议
• 修正文档中的错误：细微改动也很重要
• 贡献代码

欢迎任何形式的贡献！ 由于该项目托管于 GitHub，我们建议尽早为代码贡献打开拉取请求（PR）。这是获得反馈最快的方式，并且可以让 Travis CI 对您的更改进行检查。

设置 开发环境 所需的大部分信息，您可以参考 https://github.com/scikit-learn/scikit-learn/blob/master/CONTRIBUTING.md 上的优秀指南。请确保您的贡献符合 PEP8 编码规范，并在适当的情况下包含单元测试。更多适用于 fastFM 的宝贵指导原则，请参阅 http://scikit-learn.org/stable/developers/contributing.html#coding-guidelines。

贡献者

• aaossa
• altimin
• bdaskalov
• chezou
• macks22
• takuti
• ibayer

许可证：BSD

fastFM 快速上手指南

fastFM 是一个基于 Python 的因子分解机（Factorization Machines）库，兼容 scikit-learn API。其核心性能代码由 C 编写并通过 Cython 封装，支持回归、分类和排序任务，提供 SGD、CD 及 MCMC 等多种优化算法。

环境准备

系统要求

• 操作系统：推荐 Linux (Ubuntu) 或 macOS。Windows 非官方主动支持平台，可能需额外配置。
• Python 版本：支持 Python 2.7 及 3.x。
• 注意：请确保 Python 位数与操作系统一致（例如：不要在 64 位系统上安装 32 位 Python）。

前置依赖 在安装前，需确保系统已安装 C 编译器及线性代数库。

• Linux (Ubuntu/Debian):

  sudo apt-get install python-dev libopenblas-dev
  # 或者
  sudo apt-get install python3-dev libopenblas-dev
  

• macOS: 通常需安装 Xcode Command Line Tools 及 OpenBLAS (可通过 Homebrew: brew install openblas)。

安装步骤

方式一：二进制安装（推荐，仅限 64 位系统）

最简单的方式是通过 pip 直接安装预编译包：

pip install fastFM

(国内用户如遇下载慢，可添加清华源：pip install fastFM -i https://pypi.tuna.tsinghua.edu.cn/simple)

方式二：源码安装（适用于自定义环境或开发）

若二进制安装失败或需要最新代码，请按以下步骤操作：

1. 克隆仓库（包含子模块）：

   git clone --recursive https://github.com/ibayer/fastFM.git
   cd fastFM
   

2. 安装 Python 依赖：

   pip install -r ./requirements.txt
   

3. 编译 C 扩展：

   # 使用默认 Python 版本编译
   make
   
   # 或者指定 Python 3 编译
   PYTHON=python3 make
   

4. 安装库：

   pip install .
   

基本使用

fastFM 的使用风格与 scikit-learn 高度一致。以下是一个使用 ALS (Alternating Least Squares) 求解器进行回归预测的最小示例：

from fastFM import als

# 初始化模型
# n_iter: 迭代次数, init_stdev: 初始化标准差, rank: 因子维度
# l2_reg_w: w 的 L2 正则化, l2_reg_V: V 的 L2 正则化
fm = als.FMRegression(n_iter=1000, init_stdev=0.1, rank=2, l2_reg_w=0.1, l2_reg_V=0.5)

# 训练模型
fm.fit(X_train, y_train)

# 预测结果
y_pred = fm.predict(X_test)

支持的任务与求解器概览：

• 回归 (Regression): 支持 als, mcmc, sgd
• 分类 (Classification): 支持 als, mcmc, sgd
• 排序 (Ranking): 支持 sgd (BPR Loss)