Python 包介绍

本文档将对 Python 的 xgboost 包进行基本介绍。Python 包由 3 种不同的接口组成，包括原生接口、scikit-learn 接口和 dask 接口。有关 dask 接口的介绍，请参阅使用 Dask 分布式 XGBoost。

其他有用的链接列表

安装 XGBoost

要安装 XGBoost，请按照安装指南中的说明进行操作。

要验证您的安装，请在 Python 中运行以下命令

import xgboost as xgb

数据接口

XGBoost Python 模块能够从许多不同类型的数据格式加载数据，包括 CPU 和 GPU 数据结构。有关支持的数据类型的完整列表，请参阅支持的 Python 数据结构。有关文本输入格式的详细描述，请访问DMatrix 的文本输入格式。

输入数据存储在 DMatrix 对象中。对于 sklearn 估计器接口，根据选择的算法和输入，会创建 DMatrix 或 QuantileDMatrix，详情请参阅 sklearn API 参考。我们将在这里使用 DMatrix 来说明一些基本的输入类型。

将 NumPy 数组加载到 DMatrix 中

data = np.random.rand(5, 10)  # 5 entities, each contains 10 features
label = np.random.randint(2, size=5)  # binary target
dtrain = xgb.DMatrix(data, label=label)

将 scipy.sparse 数组加载到 DMatrix 中

csr = scipy.sparse.csr_matrix((dat, (row, col)))
dtrain = xgb.DMatrix(csr)

将 Pandas 数据帧加载到 DMatrix 中

data = pandas.DataFrame(np.arange(12).reshape((4,3)), columns=['a', 'b', 'c'])
label = pandas.DataFrame(np.random.randint(2, size=4))
dtrain = xgb.DMatrix(data, label=label)

将 DMatrix 保存为 XGBoost 二进制文件

data = np.random.rand(5, 10)  # 5 entities, each contains 10 features
label = np.random.randint(2, size=5)  # binary target
dtrain.save_binary('train.buffer')

缺失值可以在 DMatrix 构造函数中用默认值替换

dtrain = xgb.DMatrix(data, label=label, missing=np.NaN)

需要时可以设置权重

w = np.random.rand(5, 1)
dtrain = xgb.DMatrix(data, label=label, missing=np.NaN, weight=w)

设置参数

XGBoost 可以使用一对列表或字典来设置参数。例如

Booster 参数

param = {'max_depth': 2, 'eta': 1, 'objective': 'binary:logistic'}
param['nthread'] = 4
param['eval_metric'] = 'auc'

您还可以指定多个评估指标

param['eval_metric'] = ['auc', 'ams@0']

# alternatively:
# plst = param.items()
# plst += [('eval_metric', 'ams@0')]

指定验证集以观察性能

evallist = [(dtrain, 'train'), (dtest, 'eval')]

训练

训练模型需要参数列表和数据集。

num_round = 10
bst = xgb.train(param, dtrain, num_round, evallist)

训练后，模型可以保存为 JSON 或 UBJSON

bst.save_model('model.ubj')

模型及其特征图也可以转储到文本文件中。

# dump model
bst.dump_model('dump.raw.txt')
# dump model with feature map
bst.dump_model('dump.raw.txt', 'featmap.txt')

保存的模型可以按如下方式加载

bst = xgb.Booster({'nthread': 4})  # init model
bst.load_model('model.ubj')  # load model data

xgboost.Booster 中的 update 和 boost 等方法仅供内部使用。包装函数 xgboost.train 会进行一些预配置，包括设置缓存和其他一些参数。

提前停止

如果您有验证集，可以使用提前停止来找到最佳的 Boosting 轮数。提前停止要求 evals 中至少有一个集合。如果有多个，它将使用最后一个。

train(..., evals=evals, early_stopping_rounds=10)

模型将一直训练，直到验证分数不再提高。验证误差需要至少每 early_stopping_rounds 减少一次才能继续训练。

如果发生提前停止，模型将具有两个额外的字段：bst.best_score、bst.best_iteration。请注意，xgboost.train() 将返回最后一次迭代的模型，而不是最佳模型。

这适用于需要最小化的指标（RMSE、log loss 等）和需要最大化的指标（MAP、NDCG、AUC）。请注意，如果您指定多个评估指标，param['eval_metric'] 中的最后一个将用于提前停止。

预测

经过训练或加载的模型可以对数据集进行预测。

# 7 entities, each contains 10 features
data = np.random.rand(7, 10)
dtest = xgb.DMatrix(data)
ypred = bst.predict(dtest)

如果在训练期间启用了提前停止，您可以使用 bst.best_iteration 从最佳迭代中获取预测

ypred = bst.predict(dtest, iteration_range=(0, bst.best_iteration + 1))

绘图

您可以使用绘图模块来绘制重要性和输出树。

要绘制重要性，请使用 xgboost.plot_importance()。此函数需要安装 matplotlib。

xgb.plot_importance(bst)

要通过 matplotlib 绘制输出树，请使用 xgboost.plot_tree()，指定目标树的序号。此函数需要 graphviz 和 matplotlib。

xgb.plot_tree(bst, num_trees=2)

当您使用 IPython 时，您可以使用 xgboost.to_graphviz() 函数，它将目标树转换为 graphviz 实例。graphviz 实例会在 IPython 中自动渲染。

xgb.to_graphviz(bst, num_trees=2)

Scikit-Learn 接口

XGBoost 为一些预定义的模型（包括回归、分类和排序）提供了易于使用的 scikit-learn 接口。有关更多信息，请参阅使用 Scikit-Learn 估计器接口。

# Use "hist" for training the model.
reg = xgb.XGBRegressor(tree_method="hist", device="cuda")
# Fit the model using predictor X and response y.
reg.fit(X, y)
# Save model into JSON format.
reg.save_model("regressor.json")

用户在需要时仍然可以访问底层的 Booster 模型

booster: xgb.Booster = reg.get_booster()