注意: 我们建议用户迁移到 Yggdrasil Decision Forests (YDF)。YDF 训练的模型与 TF-DF 相同，但速度更快且功能更丰富。更多信息请参阅 迁移指南。

TensorFlow 决策森林 (TF-DF) 是一个用于在 TensorFlow 中训练、运行和解释 决策森林 模型（例如随机森林、梯度提升树）的库。TF-DF 支持分类、回归和排序任务。

TF-DF 基于 Yggdrasil Decision Forest (YDF，一个用 C++、JavaScript、CLI 和 Go 编写的用于训练和使用决策森林的库）。TF-DF 模型与 YDF 的模型 兼容, 反之亦然。

TensorFlow 决策森林适用于 Linux 和 Mac 系统。Windows 用户可以通过 WSL + Linux 使用该库。

使用示例

一个最简化的端到端流程如下：

import tensorflow_decision_forests as tfdf
import pandas as pd

# 将数据集加载到 Pandas 数据框中。
train_df = pd.read_csv("project/train.csv")
test_df = pd.read_csv("project/test.csv")

# 将数据集转换为 TensorFlow 数据集。
train_ds = tfdf.keras.pd_dataframe_to_tf_dataset(train_df, label="my_label")
test_ds = tfdf.keras.pd_dataframe_to_tf_dataset(test_df, label="my_label")

# 训练模型
model = tfdf.keras.RandomForestModel()
model.fit(train_ds)

# 查看模型。
model.summary()

# 评估模型。
model.evaluate(test_ds)

# 导出为 TensorFlow SavedModel。
# 注意：该模型与 Yggdrasil 决策森林兼容。
model.save("project/model")

Google I/O 演示

文档与资源

以下资源可供使用：

• TF-DF 在 TensorFlow.org 上（API 参考、指南和教程）
• 教程（在 tensorflow.org 上）
• YDF 文档（同样适用于 TF-DF）
• 问题追踪器
• 已知问题
• 变更日志
• 更多示例

安装

要安装 TensorFlow 决策森林，请运行：

pip3 install tensorflow_decision_forests --upgrade

更多详细信息、故障排除及替代安装方案，请参阅 安装页面。

贡献

欢迎为 TensorFlow 决策森林和 Yggdrasil 决策森林做出贡献。如果您希望参与贡献，请务必阅读 开发者手册 和 贡献指南。

引用

如果您在科学出版物中使用了 TensorFlow 决策森林，请引用以下论文： Yggdrasil 决策森林：一个快速且可扩展的决策森林库。

Bibtex

@inproceedings{GBBSP23,
  author       = {Mathieu Guillame{-}Bert and
                  Sebastian Bruch and
                  Richard Stotz and
                  Jan Pfeifer},
  title        = {Yggdrasil Decision Forests: {A} Fast and Extensible Decision Forests
                  Library},
  booktitle    = {Proceedings of the 29th {ACM} {SIGKDD} Conference on Knowledge Discovery
                  and Data Mining, {KDD} 2023, Long Beach, CA, USA, August 6-10, 2023},
  pages        = {4068--4077},
  year         = {2023},
  url          = {https://doi.org/10.1145/3580305.3599933},
  doi          = {10.1145/3580305.3599933},
}

原文

Yggdrasil 决策森林：一个快速且可扩展的决策森林库，Guillame-Bert 等人，KDD 2023：4068–4077。doi：10.1145/3580305.3599933

联系方式

您可以通过电子邮件 decision-forests-contact@google.com 联系核心开发团队。

致谢

TensorFlow 决策森林由以下人员开发：

• Mathieu Guillame-Bert (gbm AT google DOT com)
• Jan Pfeifer (janpf AT google DOT com)
• Richard Stotz (richardstotz AT google DOT com)
• Sebastian Bruch (sebastian AT bruch DOT io)
• Arvind Srinivasan (arvnd AT google DOT com)

许可证

Apache License 2.0

TensorFlow Decision Forests 快速上手指南

重要提示：官方建议新用户迁移至 Yggdrasil Decision Forests (YDF)。YDF 能训练与 TF-DF 相同的模型，但速度更快且功能更丰富。如需了解迁移细节，请参考官方迁移指南。

TensorFlow Decision Forests (TF-DF) 是一个用于在 TensorFlow 中训练、运行和解释决策森林模型（如随机森林、梯度提升树）的库。它支持分类、回归和排序任务，底层由 C++ 编写的 Yggdrasil Decision Forests 驱动。

环境准备

• 操作系统：
  • Linux
  • macOS
  • Windows：需通过 WSL (Windows Subsystem for Linux) 使用。
• 前置依赖：
  • Python 3.x
  • TensorFlow
  • Pandas (用于数据处理示例)

安装步骤

使用 pip 进行安装。国内开发者如遇下载缓慢，可指定清华或阿里镜像源加速安装。

标准安装命令：

pip3 install tensorflow_decision_forests --upgrade

使用国内镜像源加速（推荐）：

pip3 install tensorflow_decision_forests --upgrade -i https://pypi.tuna.tsinghua.edu.cn/simple

注：更多安装细节及故障排查请参阅官方安装文档。

基本使用

以下是一个完整的端到端最小化示例，展示如何加载数据、训练随机森林模型并进行评估。

import tensorflow_decision_forests as tfdf
import pandas as pd

# 1. 使用 Pandas 加载数据集
train_df = pd.read_csv("project/train.csv")
test_df = pd.read_csv("project/test.csv")

# 2. 将数据集转换为 TensorFlow 数据集
# label 参数指定目标列名
train_ds = tfdf.keras.pd_dataframe_to_tf_dataset(train_df, label="my_label")
test_ds = tfdf.keras.pd_dataframe_to_tf_dataset(test_df, label="my_label")

# 3. 创建并训练模型 (此处以随机森林为例)
model = tfdf.keras.RandomForestModel()
model.fit(train_ds)

# 4. 查看模型结构
model.summary()

# 5. 评估模型性能
model.evaluate(test_ds)

# 6. 导出为 TensorFlow SavedModel
# 注意：导出的模型与 Yggdrasil Decision Forests 兼容
model.save("project/model")

后续资源

• 官方教程：TensorFlow.org 教程页面
• API 文档：TF-DF on TensorFlow.org
• 底层引擎文档：YDF Documentation