YDF（尤格德拉希尔决策森林）是一个用于训练、评估、解释和部署随机森林、梯度提升决策树、CART 和孤立森林模型的库。

更多关于 YDF 的信息，请参阅 文档。

安装

要从 PyPI 安装 YDF，请运行：

pip install ydf -U

使用示例

import ydf
import pandas as pd

# 使用 Pandas 加载数据集
ds_path = "https://raw.githubusercontent.com/google/yggdrasil-decision-forests/main/yggdrasil_decision_forests/test_data/dataset/"
train_ds = pd.read_csv(ds_path + "adult_train.csv")
test_ds = pd.read_csv(ds_path + "adult_test.csv")

# 训练一个梯度提升树模型
model = ydf.GradientBoostedTreesLearner(label="income").train(train_ds)

# 查看模型（输入特征、训练日志、结构等）
model.describe()

# 评估模型（例如 ROC、准确率、混淆矩阵、置信区间）
model.evaluate(test_ds)

# 生成预测
model.predict(test_ds)

# 分析模型（例如部分依赖图、变量重要性）
model.analyze(test_ds)

# 测量模型的推理速度
model.benchmark(test_ds)

# 保存模型
model.save("/tmp/my_model")

使用 C++ API 的示例。

auto dataset_path = "csv:train.csv";

// 列出训练数据集中的列
DataSpecification spec;
CreateDataSpec(dataset_path, false, {}, &spec);

// 创建训练配置
TrainingConfig train_config;
train_config.set_learner("RANDOM_FOREST");
train_config.set_task(Task::CLASSIFICATION);
train_config.set_label("my_label");

// 训练模型
std::unique_ptr<AbstractLearner> learner;
GetLearner(train_config, &learner);
auto model = learner->Train(dataset_path, spec);

// 导出模型
SaveModel("my_model", model.get());

（基于 examples/beginner.cc）

下一步

请查看 入门教程 🧭。

引用

如果您在科学出版物中使用了尤格德拉希尔决策森林，请引用以下论文： Yggdrasil Decision Forests：一种快速且可扩展的决策森林库。

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},
}

原始

尤格德拉希尔决策森林：一种快速且可扩展的决策森林库，Guillame-Bert 等人，KDD 2023：4068-4077。doi：10.1145/3580305.3599933

联系方式

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

致谢

尤格德拉希尔决策森林和 TensorFlow Decision Forests 由以下人员开发：

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

贡献

欢迎为 TensorFlow Decision Forests 和尤格德拉希尔决策森林做出贡献。如果您想参与贡献，请查看 贡献指南。

许可证

Apache 许可协议 2.0

Yggdrasil Decision Forests 快速上手指南

环境准备

• 系统要求：支持 Windows、macOS、Linux
• 前置依赖：Python 3.7+（推荐使用 Python 3.8 或以上）
• 推荐使用 pip 安装，无需额外编译依赖

国内用户可使用清华镜像加速安装：
pip install ydf -U -i https://pypi.tuna.tsinghua.edu.cn/simple

安装步骤

pip install ydf -U

基本使用

import ydf
import pandas as pd

# 加载数据集
ds_path = "https://raw.githubusercontent.com/google/yggdrasil-decision-forests/main/yggdrasil_decision_forests/test_data/dataset/"
train_ds = pd.read_csv(ds_path + "adult_train.csv")
test_ds = pd.read_csv(ds_path + "adult_test.csv")

# 训练梯度提升树模型
model = ydf.GradientBoostedTreesLearner(label="income").train(train_ds)

# 查看模型信息
model.describe()

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

# 生成预测
model.predict(test_ds)

# 保存模型
model.save("/tmp/my_model")