更新（2021年2月1日）

注意！

本仓库将不再维护，请查看我们的新仓库，其中的 Deep Forest 在效率上有了重大改进。

详情请见：

• 仓库：https://github.com/LAMDA-NJU/Deep-Forest
• 文档：https://deep-forest.readthedocs.io/
• PyPI 上的包：https://pypi.org/project/deep-forest/

---

您可以通过 pip 安装新版 gcForest：

pip install deep-forest

本仓库中的旧版本（gcForest v1.1.1）仅作为算法的示例使用。

---

gcForest v1.1.1 来了！

这是 gcForest 实现的官方克隆版。（由于学校服务器有时不稳定，我们将其官方克隆放置在 GitHub 上）

官方软件包网站：http://lamda.nju.edu.cn/code_gcForest.ashx

本软件包按“原样”提供，仅供学术用途。您可以自行承担风险运行它。如用于其他目的，请联系周志华教授（zhouzh@lamda.nju.edu.cn）。

说明：基于 [1] 提出的 gcForest 的 Python 2.7 实现。
包含 gcForest 库的演示实现以及一些演示客户端脚本，以展示如何使用该代码。
该实现足够灵活，允许您修改模型或适配自己的数据集。

参考文献：[1] Z.-H. Zhou 和 J. Feng. 深度森林：迈向深度神经网络的替代方案。
IJCAI-2017。 (https://arxiv.org/abs/1702.08835v2 )

要求：本软件包基于 Python 2.7 开发，请确保已安装 requirements.txt 中列出的所有依赖项。

注意：本软件包由冯骥先生（http://lamda.nju.edu.cn/fengj/）开发并维护。如有关于代码的问题，请随时联系冯骥先生（fengj@lamda.nju.edu.cn），或在此处提交问题。

新增功能：

• 类 Scikit-Learn 风格的 API
• 更多详细示例
• 如果您希望使用 XGBoost 作为基分类器，支持 GPU
• 支持 Python 3.5（v1.1.1）

v1.1.1 Python 3.5 兼容性：该软件包应适用于 Python 3.5。目前尚未完全测试，但看起来应该没问题。

v1.1.1 Bug 修复：当对同一模型进行多次预测时，如果使用池化层，结果将保持一致。此 bug 仅出现在 Scikit-Learn 风格的 API 中，现在新 API 也已修复。

快速入门

使用该库最简单的方式如下：

from gcforest.gcforest import GCForest
gc = GCForest(config) # config 应为字典
X_train_enc = gc.fit_transform(X_train, y_train)
y_pred = gc.predict(X_test)

就是这样。有关详细用法，请参阅 /examples/demo_mnist.py。

如需早期版本及原始论文中报告的更多模型配置，请参考：

• v1.0

支持的基分类器

gcForest 内部的基分类器可以是任何分类器。本库支持以下分类器：

• RandomForestClassifier
• XGBClassifier
• ExtraTreesClassifier
• LogisticRegression
• SGDClassifier

如需添加其他分类器，您可以手动从 lib/gcforest/estimators/__init__.py 中添加。

自定义模型结构

使用单个 JSON 文件定义您的模型。

• 如果您只需要级联森林结构，只需编写一个 JSON 文件即可。可参考 /examples/demo_mnist-ca.json。（这里的 -ca 表示级联）

• 如果您同时需要细粒度森林和级联森林，则还需要指定模型的细粒度结构。可参考 /examples/demo_mnist-gc.json。

• 然后，使用 gcforest.utils.config_utils.load_json 加载您的 JSON 文件。

  config = load_json(your_json_file)
  gc = GCForest(config) # 就这样
  

  并运行 python examples/demo_mnist.py --model examples/yourmodel.json

在 Python 脚本中定义模型。

• 您也可以直接在 Python 脚本中定义模型结构。模型配置应为 Python 字典，可参考 /examples/demo_mnist.py 中的 get_toy_config 作为示例。

支持的 API

• fit_transform(X_train,y_train)
• fit_transform(X_train,y_train, X_test=X_test, y_test=y_test), 这允许您在训练过程中评估模型。
• set_keep_model_in_mem(False). 如果您的内存不足，可将其设置为 False。（默认为 True）。如果您将其设置为 False，则需要使用 fit_transform(X_train,y_train, X_test=X_test, y_test=y_test) 来评估模型。
• predict(X_test)
• transform(X_test)

支持的数据类型

如果您仅使用级联层，X_train、X_test 的合法数据类型为：

• 形状为 (n_samples, n_features) 的 2D NumPy 数组。
• 3D 或 4D NumPy 数组也可接受。例如，传递形状为 (60000, 28, 28) 或 (60000, 3, 28, 28) 的 X_train，会自动被重塑为 (60000, 784)/(60000, 2352)。

如果您需要使用细粒度层，X_train、X_test 必须是 4D NumPy 数组

• 对于图像类数据，维度应为 (n_samples, n_channels, n_height, n_width)
• 对于序列类数据，维度应为 (n_samples, n_features, seq_len, 1)。例如，IMDB 数据的 n_features 为 1，而音乐 MFCC 数据的 n_features 则为 13。

其他

请阅读 examples/demo_mnist.py 以获取详细教程。

软件包依赖

本软件包基于 Python 2.7 开发，当前版本不建议使用更高版本的 Python。

在运行代码之前，请执行以下命令以安装依赖项： pip install -r requirements.txt

早期版本

如需早期版本，请参考：

• v1.0

祝编程愉快！

gcForest 快速上手指南

重要提示：本仓库（gcForest v1.1.1）已停止维护，仅作为算法原理的参考实现。官方推荐使用新一代 Deep Forest，其在效率上有显著提升。

• 新版仓库：https://github.com/LAMDA-NJU/Deep-Forest
• 安装新版：pip install deep-forest

以下指南针对本仓库版本（gcForest v1.1.1），适用于需要复现原始论文算法或学习原理的场景。

环境准备

• 操作系统：Linux / macOS / Windows
• Python 版本：
  • 推荐：Python 2.7（原生开发环境）
  • 兼容：Python 3.5（v1.1.1 版本已支持，但建议充分测试）
• 前置依赖： 本项目依赖 numpy, scikit-learn, xgboost 等库。请确保在安装前已准备好编译环境（如 gcc/g++）。

安装步骤

1. 克隆代码仓库或下载源码包。
2. 进入项目目录，安装依赖包：

pip install -r requirements.txt

国内加速建议：若下载依赖较慢，可使用国内镜像源加速安装：

pip install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple

(注：若需直接使用新版 Deep Forest，请运行 pip install deep-forest)

基本使用

gcForest 提供了类似 Scikit-Learn 的 API 风格，最简单的使用流程如下：

1. 最小化代码示例

from gcforest.gcforest import GCForest

# config 是一个字典，定义模型结构（可参考 examples/demo_mnist.py 中的 get_toy_config）
config = {
    "cascade": [
        {
            "layer": 0,
            "estimators": [
                {"n_estimators": 100, "max_depth": None, "min_samples_split": 2, "n_jobs": -1},
                {"n_estimators": 100, "max_depth": None, "min_samples_split": 2, "n_jobs": -1}
            ],
            "classes": 10,
            "estimator_names": ["random_forest", "random_forest"],
            "estimator_params": [{"n_estimators": 100, "max_depth": None, "min_samples_split": 2, "n_jobs": -1}, {"n_estimators": 100, "max_depth": None, "min_samples_split": 2, "n_jobs": -1}]
        }
    ]
}

# 初始化模型
gc = GCForest(config)

# 训练并转换数据 (X_train: 特征，y_train: 标签)
X_train_enc = gc.fit_transform(X_train, y_train)

# 预测
y_pred = gc.predict(X_test)

2. 加载自定义配置文件

你也可以通过 JSON 文件定义复杂的级联森林结构（包含细粒度层和级联层）：

from gcforest.utils.config_utils import load_json
from gcforest.gcforest import GCForest

# 加载 JSON 配置文件
config = load_json("your_model_config.json")

# 初始化并运行
gc = GCForest(config)
X_train_enc = gc.fit_transform(X_train, y_train)
y_pred = gc.predict(X_test)

运行示例脚本参考：

python examples/demo_mnist.py --model examples/yourmodel.json

3. 支持的基础分类器

在配置中，gcForest 支持以下基础分类器作为节点：

• RandomForestClassifier
• XGBClassifier (支持 GPU 加速)
• ExtraTreesClassifier
• LogisticRegression
• SGDClassifier

如需添加其他分类器，可手动修改 lib/gcforest/estimators/__init__.py。