这是一个基于 TensorFlow 的任意阶（≥2）因子分解机实现，灵感来源于论文《带有 libFM 的因子分解机》（http://dl.acm.org/citation.cfm?doid=2168752.2168771）。

该实现支持：

• 密集型和稀疏型输入
• 不同的（基于梯度的）优化方法
• 通过不同损失函数进行分类或回归（已实现逻辑斯谛损失和均方误差损失）
• 通过 TensorBoard 进行日志记录

推理时间与特征数量呈线性关系。

已在 Python 3.5 上测试通过，但也应能在 Python 2.7 上运行。

该实现与 Blondel 等人在论文 [https://arxiv.org/abs/1607.07195] 中描述的实现非常相似，但它是独立开发的，并且早于该论文的首次发表。

依赖项

• scikit-learn
• numpy
• tqdm
• tensorflow 1.0+（已在 1.3 上测试）

安装

稳定版本可以通过 pip install tffm 进行安装。

使用

接口设计与 scikit-learn 模型类似。要训练一个阶数为 6、秩为 10、学习率为 0.01、迭代次数为 100 的 FM 模型，可以使用以下示例代码：

from tffm import TFFMClassifier
model = TFFMClassifier(
    order=6,
    rank=10,
    optimizer=tf.train.AdamOptimizer(learning_rate=0.01),
    n_epochs=100,
    batch_size=-1,
    init_std=0.001,
    input_type='dense'
)
model.fit(X_tr, y_tr, show_progress=True)

更多详细信息请参阅 example.ipynb 和 gpu_benchmark.ipynb。

强烈建议阅读 tffm/core.py 以获取帮助。

测试

只需在终端中运行 python test.py 即可。也可以使用 nosetests，但必须传递 --logging-level=WARNING 标志，以避免在屏幕上打印大量 TensorFlow 日志。

引用

如果您在学术研究中使用本软件，请使用以下 BibTeX 格式引用：

@misc{trofimov2016,
author = {Mikhail Trofimov, Alexander Novikov},
title = {tffm: TensorFlow 实现的任意阶因子分解机},
year = {2016},
publisher = {GitHub},
journal = {GitHub 仓库},
howpublished = {\url{https://github.com/geffy/tffm}},
}

tffm 快速上手指南

tffm 是一个基于 TensorFlow 实现的任意阶（>=2）因子分解机（Factorization Machine）库，支持稠密和稀疏输入、多种优化器及分类/回归任务。

环境准备

系统要求

• Python 3.5+（兼容 Python 2.7）
• TensorFlow 1.0+（推荐 1.3 版本）

前置依赖 请确保已安装以下 Python 库：

• scikit-learn
• numpy
• tqdm

国内加速建议：建议使用清华或阿里镜像源安装依赖，以提升下载速度。

pip install -i https://pypi.tuna.tsinghua.edu.cn/simple scikit-learn numpy tqdm tensorflow==1.3

安装步骤

可以通过 pip 直接安装稳定版：

pip install tffm

若需使用国内镜像加速安装：

pip install -i https://pypi.tuna.tsinghua.edu.cn/simple tffm

基本使用

tffm 的接口设计与 scikit-learn 类似。以下示例展示如何训练一个 6 阶、秩为 10 的 FM 分类模型：

from tffm import TFFMClassifier
import tensorflow as tf

# 初始化模型
model = TFFMClassifier(
    order=6,
    rank=10,
    optimizer=tf.train.AdamOptimizer(learning_rate=0.01),
    n_epochs=100,
    batch_size=-1,
    init_std=0.001,
    input_type='dense'
)

# 训练模型 (X_tr 为特征矩阵，y_tr 为标签)
model.fit(X_tr, y_tr, show_progress=True)

参数说明：

• order: 因子分解机的阶数（>=2）。
• rank: 隐向量的维度。
• optimizer: TensorFlow 优化器对象。
• n_epochs: 训练迭代次数。
• input_type: 输入数据类型，可选 'dense' 或 'sparse'。

更多详细用法请参考项目中的 example.ipynb 或源码 tffm/core.py。