Python API 参考 

备注

在调用回归器的 score 时使用的 $R^2$ 评分，从版本 0.23 开始使用 multioutput='uniform_average' 以保持与 r2_score() 的默认值一致。这会影响所有多输出回归器的 score 方法（除了 MultiOutputRegressor）。

set_fit_request(*, base_margin='$UNCHANGED$', base_margin_eval_set='$UNCHANGED$', eval_set='$UNCHANGED$', feature_weights='$UNCHANGED$', sample_weight='$UNCHANGED$', sample_weight_eval_set='$UNCHANGED$', verbose='$UNCHANGED$', xgb_model='$UNCHANGED$')

传递给 fit 方法的请求元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config()）。请参阅用户指南了解路由机制的工作原理。

每个参数的选项是：

True: 请求元数据，并在提供时传递给 fit。如果未提供元数据，则忽略该请求。
False: 不请求元数据，元估计器不会将其传递给 fit。
None: 不需要元数据，如果用户提供了元数据，元估计器将引发错误。
str: 元数据应使用此给定别名传递给元估计器，而不是原始名称。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你更改某些参数的请求，而不更改其他参数。

Added in version 1.3.

备注

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用。否则它不会有任何效果。

参数:

base_margin (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 base_margin 参数的元数据路由。
base_margin_eval_set (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 base_margin_eval_set 参数的元数据路由。
eval_set (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 eval_set 参数的元数据路由。
feature_weights (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 feature_weights 参数的元数据路由。
sample_weight (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 sample_weight 参数的元数据路由。
sample_weight_eval_set (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 sample_weight_eval_set 参数的元数据路由。
verbose (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 verbose 参数的元数据路由。
xgb_model (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 xgb_model 参数的元数据路由。
self (XGBRegressor)

返回:

self – 更新后的对象。

返回类型:

set_params(**params)

设置此估计器的参数。修改了 sklearn 方法以允许未知的 kwargs。这允许使用在 sklearn 网格搜索中未定义为成员变量的 xgboost 参数的完整范围。

返回类型:: self
参数:: params (Any)

set_predict_request(*, base_margin='$UNCHANGED$', iteration_range='$UNCHANGED$', output_margin='$UNCHANGED$', validate_features='$UNCHANGED$')

传递给 predict 方法的请求元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config()）。请参阅用户指南了解路由机制的工作原理。

每个参数的选项是：

True: 请求元数据，并在提供时传递给 predict。如果未提供元数据，则忽略请求。
False: 不请求元数据，元估计器不会将其传递给 predict。
None: 不需要元数据，如果用户提供了元数据，元估计器将引发错误。
str: 元数据应使用此给定别名传递给元估计器，而不是原始名称。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你更改某些参数的请求，而不更改其他参数。

Added in version 1.3.

备注

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用。否则它不会有任何效果。

参数:

base_margin (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 base_margin 参数的元数据路由。
iteration_range (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 iteration_range 参数的元数据路由。
output_margin (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 output_margin 参数的元数据路由。
validate_features (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 validate_features 参数的元数据路由。
self (XGBRegressor)

返回:

self – 更新后的对象。

返回类型:

set_score_request(*, sample_weight='$UNCHANGED$')

传递给 score 方法的请求元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config()）。请参阅用户指南了解路由机制的工作原理。

每个参数的选项是：

True: 请求元数据，并在提供时传递给 score。如果未提供元数据，则忽略请求。
False: 不需要元数据，元估计器不会将其传递给 score。
None: 不需要元数据，如果用户提供了元数据，元估计器将引发错误。
str: 元数据应使用此给定别名传递给元估计器，而不是原始名称。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你更改某些参数的请求，而不更改其他参数。

Added in version 1.3.

备注

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用。否则它不会有任何效果。

参数:

sample_weight (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – score 方法中 sample_weight 参数的元数据路由。
self (XGBRegressor)

返回:

self – 更新后的对象。

返回类型:

class xgboost.XGBClassifier(*, objective='binary:logistic', **kwargs)[源代码]

基类：XGBModel, ClassifierMixin

XGBoost 分类的 scikit-learn API 实现。更多信息请参见使用 Scikit-Learn 估计器接口。

参数:

n_estimators (Optional[int]) – 提升轮数。
max_depth (Optional[int]) – 基学习器的最大树深度。
max_leaves (Optional[int]) – 最大叶子数；0 表示无限制。
max_bin (Optional[int]) – 如果使用基于直方图的算法，每个特征的最大箱数
grow_policy (Optional[str]) – 树生长策略。 - depthwise: 倾向于在离节点最近的节点进行分割， - lossguide: 倾向于在损失变化最大的节点进行分割。
learning_rate (Optional[float]) – 提升学习率（xgb 的“eta”）
verbosity (Optional[int]) – 冗长程度。有效值为 0（静默） - 3（调试）。
objective (Union[str, xgboost.sklearn._SklObjWProto, Callable[[Any, Any], Tuple[numpy.ndarray, numpy.ndarray]], NoneType]) – 指定学习任务以及相应的学习目标或自定义目标函数。对于自定义目标，请参阅自定义目标和评估指标和自定义目标和指标以获取更多信息，以及函数签名的结尾注释。
booster (Optional[str]) – 指定使用哪个增强器：gbtree、gblinear 或 dart。
tree_method (Optional[str]) – 指定要使用的树方法。默认为自动。如果此参数设置为默认，XGBoost 将选择最保守的可用选项。建议从参数文档中研究此选项树方法
n_jobs (Optional[int]) – 用于运行 xgboost 的并行线程数。当与其他 Scikit-Learn 算法（如网格搜索）一起使用时，您可以选择并行化哪个算法并平衡线程。创建线程争用将显著减慢两个算法。
gamma (Optional[float]) – (min_split_loss) 在树的叶节点上进行进一步分区所需的最小损失减少量。
min_child_weight (Optional[float]) – 子节点中所需的实例权重（Hessian）的最小和。
max_delta_step (Optional[float]) – 我们允许每棵树的权重估计的最大增量步长。
subsample (Optional[float]) – 训练实例的子样本比例。
sampling_method (Optional[str]) – 采样方法。仅由 hist 树方法的 GPU 版本使用。 - uniform: 均匀选择随机训练实例。 - gradient_based: 当梯度和 Hessian 较大时，以更高概率选择随机训练实例。（参见 CatBoost）
colsample_bytree (Optional[float]) – 构建每棵树时列的子样本比例。
colsample_bylevel (Optional[float]) – 每个级别的列子样本比率。
colsample_bynode (Optional[float]) – 每次分割的列子样本比例。
reg_alpha (Optional[float]) – 权重的L1正则化项（xgb的alpha）。
reg_lambda (Optional[float]) – 权重上的L2正则化项（xgb的lambda）。
scale_pos_weight (Optional[float]) – 正负权重的平衡。
base_score (Optional[float]) – 所有实例的初始预测分数，全局偏置。
random_state (Union[numpy.random.mtrand.RandomState, numpy.random._generator.Generator, int, NoneType]) – 随机数种子。 .. 注意:: 使用 shotgun updater 的 gblinear booster 是非确定性的，因为它使用了 Hogwild 算法。
missing (float) – 数据中需要作为缺失值存在的值。默认为 numpy.nan。
num_parallel_tree (Optional[int]) – 用于增强随机森林。
monotone_constraints (Union[Dict[str, int], str, NoneType]) – 变量单调性的约束。更多信息请参见教程。
interaction_constraints (Union[str, List[Tuple[str]], NoneType]) – 表示允许交互的约束条件。约束条件必须以嵌套列表的形式指定，例如 [[0, 1], [2, 3, 4]]，其中每个内部列表是一组允许相互交互的特征索引。更多信息请参见教程。
importance_type (Optional[str]) – 特征重要性类型用于feature_importances_属性： * 对于树模型，可以是”gain”、”weight”、”cover”、”total_gain”或”total_cover”。 * 对于线性模型，仅定义了”weight”，它是无偏差的归一化系数。
device (Optional[str]) –

Added in version 2.0.0.

设备序号，可用选项为 cpu、cuda 和 gpu。
validate_parameters (Optional[bool]) – 对未知参数发出警告。
enable_categorical (bool) – 详情请参见 DMatrix 的相同参数。
feature_types (Optional[Sequence[str]]) –

Added in version 1.7.0.

用于指定特征类型而不构建数据框。详情请参见 DMatrix。
max_cat_to_onehot (Optional[int]) –

Added in version 1.6.0.

备注

此参数为实验性

决定XGBoost是否应使用独热编码进行分类数据分割的阈值。当类别数量小于阈值时，选择独热编码，否则类别将被分割到子节点中。此外，需要设置 enable_categorical 以支持分类特征。详情请参见分类数据和分类特征的参数。
max_cat_threshold (Optional[int]) –

Added in version 1.7.0.

备注

此参数为实验性

每个分割考虑的最大类别数。仅用于基于分区的分割，以防止过拟合。此外，enable_categorical 需要设置为支持分类特征。详情请参见分类数据和分类特征的参数。
multi_strategy (Optional[str]) –

Added in version 2.0.0.

备注

此参数正在开发中。

用于训练多目标模型的策略，包括多目标回归和多类分类。更多信息请参见多重输出。
- one_output_per_tree: 每个目标一个模型。
- multi_output_tree: 使用多目标树。
eval_metric (Union[str, List[str], Callable, NoneType]) –

Added in version 1.6.0.

用于监控训练结果和提前停止的指标。它可以是一个字符串或字符串列表，作为XGBoost中预定义指标的名称（参见doc/parameter.rst），也可以是 sklearn.metrics 中的一个指标，或者是任何其他类似于 sklearn.metrics 的用户定义指标。

如果提供了自定义目标，那么自定义指标应实现相应的反向链接函数。

与 scikit-learn 中常用的 scoring 参数不同，当提供一个可调用对象时，它被假定为一个成本函数，默认情况下 XGBoost 将在早停期间最小化结果。

For advanced usage on Early stopping like directly choosing to maximize instead of minimize, see xgboost.callback.EarlyStopping.

更多信息请参见自定义目标和评估指标和自定义目标和指标。
```
from sklearn.datasets import load_diabetes
from sklearn.metrics import mean_absolute_error
X, y = load_diabetes(return_X_y=True)
reg = xgb.XGBRegressor(
    tree_method="hist",
    eval_metric=mean_absolute_error,
)
reg.fit(X, y, eval_set=[(X, y)])
```
early_stopping_rounds (Optional[int]) –

Added in version 1.6.0.
- 激活早停机制。验证指标需要在每 early_stopping_rounds 轮中至少改善一次以继续训练。这需要在 fit() 中至少有一个 eval_set 项。
- 如果发生早停，模型将有两个额外的属性：best_score 和 best_iteration。这些属性用于 predict() 和 apply() 方法，以在推理过程中确定最佳的树的数量。如果用户想要访问完整的模型（包括早停后构建的树），他们可以在这些推理方法中指定 iteration_range。此外，其他实用工具如模型绘图也可以使用整个模型。
- 如果你倾向于在 best_iteration 之后丢弃树，可以考虑使用回调函数 xgboost.callback.EarlyStopping。
- 如果 eval_set 中有多个项目，最后一个条目将用于提前停止。如果 eval_metric 中有多个指标，最后一个指标将用于提前停止。
callbacks (Optional[List[xgboost.callback.TrainingCallback]]) – 在每次迭代结束时应用的回调函数列表。可以通过使用回调 API 来使用预定义的回调。 .. 注意:
kwargs (Optional[Any]) – XGBoost Booster对象的关键字参数。参数的完整文档可以在这里找到。尝试通过构造函数参数和 **kwargs 字典同时设置参数将导致 TypeError。

apply(X, iteration_range=None)

返回每个样本在每棵树上的预测叶子。如果模型是使用早期停止训练的，那么会自动使用 best_iteration。

参数:

X (array_like, shape=[n_samples, n_features]) – 输入特征矩阵。
iteration_range (Tuple[int | integer, int | integer] | None) – 参见 predict()。

返回:

X_leaves – 对于 X 中的每个数据点 x 和每棵树，返回 x 最终所在的叶子的索引。叶子在 [0; 2**(self.max_depth+1)) 范围内编号，编号中可能存在间隙。

返回类型:

array_like, shape=[n_samples, n_trees]

property best_iteration: int: 通过早期停止获得的最佳迭代。此属性是基于0的，例如，如果最佳迭代是第一轮，那么 best_iteration 为 0。

property best_score: float: 通过早期停止获得的最佳分数。

property coef_: ndarray

Coefficients 属性

备注

系数仅针对线性学习器定义

系数仅在选择线性模型作为基础学习器时定义（booster=gblinear）。对于其他基础学习器类型，如树学习器（booster=gbtree），则未定义。

返回:: coef_
返回类型:: 形状为 [n_features] 或 [n_classes, n_features] 的数组

evals_result()

返回评估结果。

如果将 eval_set 传递给 fit() 函数，你可以调用 evals_result() 来获取所有传递的 eval_sets 的评估结果。当 eval_metric 也被传递给 fit() 函数时，evals_result 将包含传递给 fit() 函数的 eval_metrics。

返回的评估结果是一个字典：

{'validation_0': {'logloss': ['0.604835', '0.531479']},
 'validation_1': {'logloss': ['0.41965', '0.17686']}}

返回类型:: evals_result

property feature_importances_: ndarray

特征重要性属性，返回结果取决于 importance_type 参数。当模型使用多类/多标签/多目标数据集训练时，特征重要性是“平均”所有目标的。“平均”是基于重要性类型定义的。例如，如果重要性类型是“total_gain”，那么分数是所有树中每个分裂的损失变化的总和。

返回:

feature_importances_ (形状为 [n_features] 的数组，多类情况除外)
线性模型，返回形状为 (n_features, n_classes) 的数组

property feature_names_in_: ndarray: 在 fit() 过程中看到的特征名称。仅当 X 的特征名称均为字符串时定义。

fit(X, y, *, sample_weight=None, base_margin=None, eval_set=None, verbose=True, xgb_model=None, sample_weight_eval_set=None, base_margin_eval_set=None, feature_weights=None)[源代码]

拟合梯度提升分类器。

请注意，多次调用 fit() 将导致模型对象从头开始重新拟合。要从之前的检查点恢复训练，请显式传递 xgb_model 参数。

参数:

X (Any) – 功能矩阵。查看各种 XGBoost 函数支持的数据结构以获取支持的类型列表。当 tree_method 设置为 hist 时，内部将使用 QuantileDMatrix 而不是 DMatrix 以节省内存。然而，当输入数据的设备与算法不匹配时，这会影响性能。例如，如果输入是CPU上的numpy数组，但训练使用 cuda，则数据首先在CPU上处理，然后传输到GPU。
y (Any) – 标签
sample_weight (Any | None) – 实例权重
base_margin (Any | None) – 每个实例的全局偏差。详情请参见拦截。
eval_set (Sequence[Tuple[Any, Any]] | None) – 用于作为验证集的 (X, y) 元组对列表，将计算这些验证集的指标。验证指标将帮助我们跟踪模型的性能。
verbose (bool | int | None) – 如果 verbose 为 True 并且使用了评估集，验证集上的评估指标会在每次提升阶段打印到标准输出。如果 verbose 是一个整数，评估指标会在每 verbose 次提升阶段打印。最后一次提升阶段或通过 early_stopping_rounds 找到的提升阶段也会被打印。
xgb_model (Booster | str | XGBModel | None) – 存储的XGBoost模型文件名或’Booster’实例 XGBoost模型，在训练前加载（允许训练继续）。
sample_weight_eval_set (Sequence[Any] | None) – 形式为 [L_1, L_2, …, L_n] 的列表，其中每个 L_i 是一个类似数组的对象，存储第 i 个验证集的实例权重。
base_margin_eval_set (Sequence[Any] | None) – 形式为 [M_1, M_2, …, M_n] 的列表，其中每个 M_i 是一个存储第 i 个验证集的基边界的类似数组的对象。
feature_weights (Any | None) – 每个特征的权重，定义了在使用colsample时每个特征被选中的概率。所有值必须大于0，否则会抛出 ValueError。

返回类型:

XGBClassifier

get_booster()

获取此模型的底层 xgboost Booster。

当未调用 fit 时，这将引发异常

返回:: booster
返回类型:: a xgboost booster of underlying model

get_metadata_routing()

获取此对象的元数据路由。

请查看用户指南以了解路由机制的工作原理。

返回:: routing – 一个封装了路由信息的 MetadataRequest。
返回类型:: MetadataRequest

get_num_boosting_rounds()

获取xgboost的增强轮数。

返回类型:: int

get_params(deep=True)

获取参数。

参数:: deep (bool)
返回类型:: Dict[str, Any]

get_xgb_params()

获取 xgboost 特定的参数。

返回类型:: Dict[str, Any]

property intercept_: ndarray

截距（偏差）属性

对于基于树的模型，返回值是 base_score。

返回:: 拦截_
返回类型:: 形状为 (1,) 或 [n_classes] 的数组

load_model(fname)

从文件或字节数组加载模型。

模型以XGBoost内部格式保存，该格式在各种XGBoost接口中通用。Python Booster对象的辅助属性（如feature_names）仅在使用JSON或UBJSON（默认）格式时保存。更多信息请参见模型IO。

model.load_model("model.json")
# or
model.load_model("model.ubj")

参数:: fname (str | bytearray | PathLike) – 输入文件名或内存缓冲区（另见 save_raw）
返回类型:: None

property n_features_in_: int: 在 fit() 期间看到的特征数量。

predict(X, output_margin=False, validate_features=True, base_margin=None, iteration_range=None)[源代码]

使用 X 进行预测。如果模型是使用早期停止训练的，那么会自动使用 best_iteration。估计器默认使用 inplace_predict，如果数据和估计器之间的设备不匹配，则会回退到使用 DMatrix。

备注

此函数仅对 gbtree 和 dart 线程安全。

参数:

X (Any) – 用于预测的数据。
output_margin (bool) – 是否输出未经转换的原始边距值。
validate_features (bool) – 当此项为 True 时，验证 Booster 和数据的 feature_names 是否相同。否则，假设 feature_names 是相同的。
base_margin (Any | None) – 每个实例的全局偏差。详情请参见拦截。
iteration_range (Tuple[int | integer, int | integer] | None) – 指定用于预测的树层。例如，如果一个随机森林经过100轮训练。指定 iteration_range=(10, 20)，那么只有在此期间[10, 20)（半开集）轮次内构建的森林用于此次预测。 .. versionadded:: 1.4.0

返回类型:

prediction

predict_proba(X, validate_features=True, base_margin=None, iteration_range=None)[源代码]

预测每个 X 样本属于给定类别的概率。如果模型是使用早停法训练的，那么会自动使用 best_iteration。估计器默认使用 inplace_predict，如果数据和估计器之间的设备不匹配，则会回退到使用 DMatrix。

备注

此函数仅对 gbtree 和 dart 线程安全。

参数:

X (Any) – 功能矩阵。查看各种 XGBoost 函数支持的数据结构以获取支持的类型列表。
validate_features (bool) – 当此项为 True 时，验证 Booster 和数据的 feature_names 是否相同。否则，假设 feature_names 是相同的。
base_margin (Any | None) – 每个实例的全局偏差。详情请参见拦截。
iteration_range (Tuple[int | integer, int | integer] | None) – 指定在预测中使用哪一层树。例如，如果一个随机森林被训练了100轮。指定 iteration_range=(10, 20)，那么只有在这 [10, 20)（半开区间）轮中构建的森林被用于此次预测。

返回:

一个形状为 (n_samples, n_classes) 的 numpy 数组，表示每个数据样本属于某一类的概率。

返回类型:

prediction

save_model(fname)

将模型保存到文件中。

模型以XGBoost内部格式保存，该格式在各种XGBoost接口中通用。Python Booster对象的辅助属性（如feature_names）仅在使用JSON或UBJSON（默认）格式时保存。更多信息请参见模型IO。

model.save_model("model.json")
# or
model.save_model("model.ubj")

参数:: fname (str | PathLike) – 输出文件名
返回类型:: None

score(X, y, sample_weight=None)

返回给定测试数据和标签的平均准确率。

在多标签分类中，这是子集准确率，这是一个严格的度量标准，因为你要求每个样本的每个标签集都被正确预测。

参数:

X (array-like of shape (n_samples, n_features)) – 测试样本。
y (array-like of shape (n_samples,) or (n_samples, n_outputs)) – X 的真实标签。
sample_weight (array-like of shape (n_samples,), default=None) – 样本权重。

返回:

score – self.predict(X) 相对于 y 的平均准确率。

返回类型:

set_fit_request(*, base_margin='$UNCHANGED$', base_margin_eval_set='$UNCHANGED$', eval_set='$UNCHANGED$', feature_weights='$UNCHANGED$', sample_weight='$UNCHANGED$', sample_weight_eval_set='$UNCHANGED$', verbose='$UNCHANGED$', xgb_model='$UNCHANGED$')

传递给 fit 方法的请求元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config()）。请参阅用户指南了解路由机制的工作原理。

每个参数的选项是：

True: 请求元数据，并在提供时传递给 fit。如果未提供元数据，则忽略该请求。
False: 不请求元数据，元估计器不会将其传递给 fit。
None: 不需要元数据，如果用户提供了元数据，元估计器将引发错误。
str: 元数据应使用此给定别名传递给元估计器，而不是原始名称。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你更改某些参数的请求，而不更改其他参数。

Added in version 1.3.

备注

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用。否则它不会有任何效果。

参数:

base_margin (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 base_margin 参数的元数据路由。
base_margin_eval_set (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 base_margin_eval_set 参数的元数据路由。
eval_set (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 eval_set 参数的元数据路由。
feature_weights (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 feature_weights 参数的元数据路由。
sample_weight (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 sample_weight 参数的元数据路由。
sample_weight_eval_set (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 sample_weight_eval_set 参数的元数据路由。
verbose (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 verbose 参数的元数据路由。
xgb_model (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 xgb_model 参数的元数据路由。
self (XGBClassifier)

返回:

self – 更新后的对象。

返回类型:

set_params(**params)

设置此估计器的参数。修改了 sklearn 方法以允许未知的 kwargs。这允许使用在 sklearn 网格搜索中未定义为成员变量的 xgboost 参数的完整范围。

返回类型:: self
参数:: params (Any)

set_predict_proba_request(*, base_margin='$UNCHANGED$', iteration_range='$UNCHANGED$', validate_features='$UNCHANGED$')

传递给 predict_proba 方法的请求元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config()）。请参阅用户指南了解路由机制的工作原理。

每个参数的选项是：

True: 请求元数据，并在提供时传递给 predict_proba。如果未提供元数据，则忽略该请求。
False: 不请求元数据，元估计器不会将其传递给 predict_proba。
None: 不需要元数据，如果用户提供了元数据，元估计器将引发错误。
str: 元数据应使用此给定别名传递给元估计器，而不是原始名称。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你更改某些参数的请求，而不更改其他参数。

Added in version 1.3.

备注

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用。否则它不会有任何效果。

参数:

base_margin (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict_proba 中 base_margin 参数的元数据路由。
iteration_range (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict_proba 中 iteration_range 参数的元数据路由。
validate_features (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict_proba 中的 validate_features 参数的元数据路由。
self (XGBClassifier)

返回:

self – 更新后的对象。

返回类型:

set_predict_request(*, base_margin='$UNCHANGED$', iteration_range='$UNCHANGED$', output_margin='$UNCHANGED$', validate_features='$UNCHANGED$')

传递给 predict 方法的请求元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config()）。请参阅用户指南了解路由机制的工作原理。

每个参数的选项是：

True: 请求元数据，并在提供时传递给 predict。如果未提供元数据，则忽略请求。
False: 不请求元数据，元估计器不会将其传递给 predict。
None: 不需要元数据，如果用户提供了元数据，元估计器将引发错误。
str: 元数据应使用此给定别名传递给元估计器，而不是原始名称。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你更改某些参数的请求，而不更改其他参数。

Added in version 1.3.

备注

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用。否则它不会有任何效果。

参数:

base_margin (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 base_margin 参数的元数据路由。
iteration_range (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 iteration_range 参数的元数据路由。
output_margin (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 output_margin 参数的元数据路由。
validate_features (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 validate_features 参数的元数据路由。
self (XGBClassifier)

返回:

self – 更新后的对象。

返回类型:

set_score_request(*, sample_weight='$UNCHANGED$')

传递给 score 方法的请求元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config()）。请参阅用户指南了解路由机制的工作原理。

每个参数的选项是：

True: 请求元数据，并在提供时传递给 score。如果未提供元数据，则忽略请求。
False: 不需要元数据，元估计器不会将其传递给 score。
None: 不需要元数据，如果用户提供了元数据，元估计器将引发错误。
str: 元数据应使用此给定别名传递给元估计器，而不是原始名称。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你更改某些参数的请求，而不更改其他参数。

Added in version 1.3.

备注

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用。否则它不会有任何效果。

参数:

sample_weight (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – score 方法中 sample_weight 参数的元数据路由。
self (XGBClassifier)

返回:

self – 更新后的对象。

返回类型:

class xgboost.XGBRanker(*, objective='rank:ndcg', **kwargs)[源代码]

基类：XGBModel, XGBRankerMixIn

XGBoost 排名的 Scikit-Learn API 实现。

请参阅 Learning to Rank 以获取介绍。

更多信息请参见使用 Scikit-Learn 估计器接口。

参数:

n_estimators (Optional[int]) – 梯度提升树的数量。等同于提升轮数。
max_depth (Optional[int]) – 基学习器的最大树深度。
max_leaves (Optional[int]) – 最大叶子数；0 表示无限制。
max_bin (Optional[int]) – 如果使用基于直方图的算法，每个特征的最大箱数
grow_policy (Optional[str]) – 树生长策略。 - depthwise: 倾向于在离节点最近的节点进行分割， - lossguide: 倾向于在损失变化最大的节点进行分割。
learning_rate (Optional[float]) – 提升学习率（xgb 的“eta”）
verbosity (Optional[int]) – 冗长程度。有效值为 0（静默） - 3（调试）。
objective (Union[str, xgboost.sklearn._SklObjWProto, Callable[[Any, Any], Tuple[numpy.ndarray, numpy.ndarray]], NoneType]) – 指定学习任务以及相应的学习目标或自定义目标函数。对于自定义目标，请参阅自定义目标和评估指标和自定义目标和指标以获取更多信息，以及函数签名的结尾注释。
booster (Optional[str]) – 指定使用哪个增强器：gbtree、gblinear 或 dart。
tree_method (Optional[str]) – 指定要使用的树方法。默认为自动。如果此参数设置为默认，XGBoost 将选择最保守的可用选项。建议从参数文档中研究此选项树方法
n_jobs (Optional[int]) – 用于运行 xgboost 的并行线程数。当与其他 Scikit-Learn 算法（如网格搜索）一起使用时，您可以选择并行化哪个算法并平衡线程。创建线程争用将显著减慢两个算法。
gamma (Optional[float]) – (min_split_loss) 在树的叶节点上进行进一步分区所需的最小损失减少量。
min_child_weight (Optional[float]) – 子节点中所需的实例权重（Hessian）的最小和。
max_delta_step (Optional[float]) – 我们允许每棵树的权重估计的最大增量步长。
subsample (Optional[float]) – 训练实例的子样本比例。
sampling_method (Optional[str]) – 采样方法。仅由 hist 树方法的 GPU 版本使用。 - uniform: 均匀选择随机训练实例。 - gradient_based: 当梯度和 Hessian 较大时，以更高概率选择随机训练实例。（参见 CatBoost）
colsample_bytree (Optional[float]) – 构建每棵树时列的子样本比例。
colsample_bylevel (Optional[float]) – 每个级别的列子样本比率。
colsample_bynode (Optional[float]) – 每次分割的列子样本比例。
reg_alpha (Optional[float]) – 权重的L1正则化项（xgb的alpha）。
reg_lambda (Optional[float]) – 权重上的L2正则化项（xgb的lambda）。
scale_pos_weight (Optional[float]) – 正负权重的平衡。
base_score (Optional[float]) – 所有实例的初始预测分数，全局偏置。
random_state (Union[numpy.random.mtrand.RandomState, numpy.random._generator.Generator, int, NoneType]) – 随机数种子。 .. 注意:: 使用 shotgun updater 的 gblinear booster 是非确定性的，因为它使用了 Hogwild 算法。
missing (float) – 数据中需要作为缺失值存在的值。默认为 numpy.nan。
num_parallel_tree (Optional[int]) – 用于增强随机森林。
monotone_constraints (Union[Dict[str, int], str, NoneType]) – 变量单调性的约束。更多信息请参见教程。
interaction_constraints (Union[str, List[Tuple[str]], NoneType]) – 表示允许交互的约束条件。约束条件必须以嵌套列表的形式指定，例如 [[0, 1], [2, 3, 4]]，其中每个内部列表是一组允许相互交互的特征索引。更多信息请参见教程。
importance_type (Optional[str]) – 特征重要性类型用于feature_importances_属性： * 对于树模型，可以是”gain”、”weight”、”cover”、”total_gain”或”total_cover”。 * 对于线性模型，仅定义了”weight”，它是无偏差的归一化系数。
device (Optional[str]) –

Added in version 2.0.0.

设备序号，可用选项为 cpu、cuda 和 gpu。
validate_parameters (Optional[bool]) – 对未知参数发出警告。
enable_categorical (bool) – 详情请参见 DMatrix 的相同参数。
feature_types (Optional[Sequence[str]]) –

Added in version 1.7.0.

用于指定特征类型而不构建数据框。详情请参见 DMatrix。
max_cat_to_onehot (Optional[int]) –

Added in version 1.6.0.

备注

此参数为实验性

决定XGBoost是否应使用独热编码进行分类数据分割的阈值。当类别数量小于阈值时，选择独热编码，否则类别将被分割到子节点中。此外，需要设置 enable_categorical 以支持分类特征。详情请参见分类数据和分类特征的参数。
max_cat_threshold (Optional[int]) –

Added in version 1.7.0.

备注

此参数为实验性

每个分割考虑的最大类别数。仅用于基于分区的分割，以防止过拟合。此外，enable_categorical 需要设置为支持分类特征。详情请参见分类数据和分类特征的参数。
multi_strategy (Optional[str]) –

Added in version 2.0.0.

备注

此参数正在开发中。

用于训练多目标模型的策略，包括多目标回归和多类分类。更多信息请参见多重输出。
- one_output_per_tree: 每个目标一个模型。
- multi_output_tree: 使用多目标树。
eval_metric (Union[str, List[str], Callable, NoneType]) –

Added in version 1.6.0.

用于监控训练结果和提前停止的指标。它可以是一个字符串或字符串列表，作为XGBoost中预定义指标的名称（参见doc/parameter.rst），也可以是 sklearn.metrics 中的一个指标，或者是任何其他类似于 sklearn.metrics 的用户定义指标。

如果提供了自定义目标，那么自定义指标应实现相应的反向链接函数。

与 scikit-learn 中常用的 scoring 参数不同，当提供一个可调用对象时，它被假定为一个成本函数，默认情况下 XGBoost 将在早停期间最小化结果。

For advanced usage on Early stopping like directly choosing to maximize instead of minimize, see xgboost.callback.EarlyStopping.

更多信息请参见自定义目标和评估指标和自定义目标和指标。
```
from sklearn.datasets import load_diabetes
from sklearn.metrics import mean_absolute_error
X, y = load_diabetes(return_X_y=True)
reg = xgb.XGBRegressor(
    tree_method="hist",
    eval_metric=mean_absolute_error,
)
reg.fit(X, y, eval_set=[(X, y)])
```
early_stopping_rounds (Optional[int]) –

Added in version 1.6.0.
- 激活早停机制。验证指标需要在每 early_stopping_rounds 轮中至少改善一次以继续训练。这需要在 fit() 中至少有一个 eval_set 项。
- 如果发生早停，模型将有两个额外的属性：best_score 和 best_iteration。这些属性用于 predict() 和 apply() 方法，以在推理过程中确定最佳的树的数量。如果用户想要访问完整的模型（包括早停后构建的树），他们可以在这些推理方法中指定 iteration_range。此外，其他实用工具如模型绘图也可以使用整个模型。
- 如果你倾向于在 best_iteration 之后丢弃树，可以考虑使用回调函数 xgboost.callback.EarlyStopping。
- 如果 eval_set 中有多个项目，最后一个条目将用于提前停止。如果 eval_metric 中有多个指标，最后一个指标将用于提前停止。
callbacks (Optional[List[xgboost.callback.TrainingCallback]]) – 在每次迭代结束时应用的回调函数列表。可以通过使用回调 API 来使用预定义的回调。 .. 注意:
kwargs (Optional[Any]) – XGBoost Booster对象的关键字参数。参数的完整文档可以在:doc:`这里 </parameter>`找到。尝试通过构造函数参数和**kwargs字典同时设置参数将导致TypeError。

apply(X, iteration_range=None)[源代码]

返回每个样本在每棵树上的预测叶子。如果模型是使用早期停止训练的，那么会自动使用 best_iteration。

参数:

X (array_like, shape=[n_samples, n_features]) – 输入特征矩阵。
iteration_range (Tuple[int | integer, int | integer] | None) – 参见 predict()。

返回:

X_leaves – 对于 X 中的每个数据点 x 和每棵树，返回 x 最终所在的叶子的索引。叶子在 [0; 2**(self.max_depth+1)) 范围内编号，编号中可能存在间隙。

返回类型:

array_like, shape=[n_samples, n_trees]

property best_iteration: int: 通过早期停止获得的最佳迭代。此属性是基于0的，例如，如果最佳迭代是第一轮，那么 best_iteration 为 0。

property best_score: float: 通过早期停止获得的最佳分数。

property coef_: ndarray

Coefficients 属性

备注

系数仅针对线性学习器定义

系数仅在选择线性模型作为基础学习器时定义（booster=gblinear）。对于其他基础学习器类型，如树学习器（booster=gbtree），则未定义。

返回:: coef_
返回类型:: 形状为 [n_features] 或 [n_classes, n_features] 的数组

evals_result()

返回评估结果。

如果将 eval_set 传递给 fit() 函数，你可以调用 evals_result() 来获取所有传递的 eval_sets 的评估结果。当 eval_metric 也被传递给 fit() 函数时，evals_result 将包含传递给 fit() 函数的 eval_metrics。

返回的评估结果是一个字典：

{'validation_0': {'logloss': ['0.604835', '0.531479']},
 'validation_1': {'logloss': ['0.41965', '0.17686']}}

返回类型:: evals_result

property feature_importances_: ndarray

特征重要性属性，返回结果取决于 importance_type 参数。当模型使用多类/多标签/多目标数据集训练时，特征重要性是“平均”所有目标的。“平均”是基于重要性类型定义的。例如，如果重要性类型是“total_gain”，那么分数是所有树中每个分裂的损失变化的总和。

返回:

feature_importances_ (形状为 [n_features] 的数组，多类情况除外)
线性模型，返回形状为 (n_features, n_classes) 的数组

property feature_names_in_: ndarray: 在 fit() 过程中看到的特征名称。仅当 X 的特征名称均为字符串时定义。

fit(X, y, *, group=None, qid=None, sample_weight=None, base_margin=None, eval_set=None, eval_group=None, eval_qid=None, verbose=False, xgb_model=None, sample_weight_eval_set=None, base_margin_eval_set=None, feature_weights=None)[源代码]

拟合梯度提升排序器

请注意，多次调用 fit() 将导致模型对象从头开始重新拟合。要从之前的检查点恢复训练，请显式传递 xgb_model 参数。

参数:

X (Any) – 功能矩阵。有关支持的类型列表，请参阅各种 XGBoost 函数支持的数据结构。当这是一个 pandas.DataFrame 或 cudf.DataFrame 时，它可能包含一个名为 qid 的特殊列，用于指定查询索引。使用特殊列与使用 qid 参数相同，只是它与 sklearn 实用函数（如 sklearn.model_selection.cross_validation()）兼容。同样的约定适用于 XGBRanker.score() 和 XGBRanker.predict() 。 +—–+—————-+—————-+ | qid | feat_0 | feat_1 | +—–+—————-+—————-+ | 0 | $x_{00}$ | $x_{01}$ | +—–+—————-+—————-+ | 1 | $x_{10}$ | $x_{11}$ | +—–+—————-+—————-+ | 1 | $x_{20}$ | $x_{21}$ | +—–+—————-+—————-+ 当 tree_method 设置为 hist 时，内部将使用 QuantileDMatrix 而不是 DMatrix 以节省内存。然而，当输入数据的设备与算法不匹配时，这会影响性能。例如，如果输入是 CPU 上的 numpy 数组，但训练使用 cuda ，则数据首先在 CPU 上处理，然后传输到 GPU。
y (Any) – 标签
group (Any | None) – 训练数据中每个查询组的大小。应该有与训练数据中查询组数量相同的元素。如果设置为 None，则用户必须提供 qid。
qid (Any | None) – 每个训练样本的查询ID。应具有n_samples的大小。如果设置为None，则用户必须提供组或X中的特殊列。
sample_weight (Any | None) –
查询组权重

备注

权重是针对排名任务的每个组别

在排序任务中，每个查询组/ID分配一个权重（而不是每个数据点）。这是因为我们只关心每个组内数据点的相对顺序，因此为单个数据点分配权重是没有意义的。
base_margin (Any | None) – 每个实例的全局偏差。详情请参见拦截。
eval_set (Sequence[Tuple[Any, Any]] | None) – 用于作为验证集的 (X, y) 元组对列表，将计算这些验证集的指标。验证指标将帮助我们跟踪模型的性能。
eval_group (Sequence[Any] | None) – 一个列表，其中 eval_group[i] 是包含 eval_set 中第 i 对所有查询组大小的列表。
eval_qid (Sequence[Any] | None) – 一个列表，其中 eval_qid[i] 是包含 eval_set 中第 i 对的查询 ID 的数组。X 中的特殊列约定同样适用于验证数据集。
verbose (bool | int | None) – 如果 verbose 为 True 并且使用了评估集，验证集上的评估指标会在每次提升阶段打印到标准输出。如果 verbose 是一个整数，评估指标会在每 verbose 次提升阶段打印。最后一次提升阶段或通过 early_stopping_rounds 找到的提升阶段也会被打印。
xgb_model (Booster | str | XGBModel | None) – 存储的XGBoost模型文件名或’Booster’实例 XGBoost模型，在训练前加载（允许训练继续）。
sample_weight_eval_set (Sequence[Any] | None) – 形式为 [L_1, L_2, …, L_n] 的列表，其中每个 L_i 是第 i 个验证集上的组权重列表。 .. 注意:: 权重是按组分配的，用于排名任务在排名任务中，每个查询组分配一个权重（而不是每个数据点）。这是因为我们只关心每个组内数据点的相对顺序，因此为单个数据点分配权重是没有意义的。
base_margin_eval_set (Sequence[Any] | None) – 形式为 [M_1, M_2, …, M_n] 的列表，其中每个 M_i 是一个存储第 i 个验证集的基边界的类似数组的对象。
feature_weights (Any | None) – 每个特征的权重，定义了在使用colsample时每个特征被选中的概率。所有值必须大于0，否则会抛出 ValueError。

返回类型:

XGBRanker

get_booster()

获取此模型的底层 xgboost Booster。

当未调用 fit 时，这将引发异常

返回:: booster
返回类型:: a xgboost booster of underlying model

get_metadata_routing()

获取此对象的元数据路由。

请查看用户指南以了解路由机制的工作原理。

返回:: routing – 一个封装了路由信息的 MetadataRequest。
返回类型:: MetadataRequest

get_num_boosting_rounds()

获取xgboost的增强轮数。

返回类型:: int

get_params(deep=True)

获取参数。

参数:: deep (bool)
返回类型:: Dict[str, Any]

get_xgb_params()

获取 xgboost 特定的参数。

返回类型:: Dict[str, Any]

property intercept_: ndarray

截距（偏差）属性

对于基于树的模型，返回值是 base_score。

返回:: 拦截_
返回类型:: 形状为 (1,) 或 [n_classes] 的数组

load_model(fname)

从文件或字节数组加载模型。

模型以XGBoost内部格式保存，该格式在各种XGBoost接口中通用。Python Booster对象的辅助属性（如feature_names）仅在使用JSON或UBJSON（默认）格式时保存。更多信息请参见模型IO。

model.load_model("model.json")
# or
model.load_model("model.ubj")

参数:: fname (str | bytearray | PathLike) – 输入文件名或内存缓冲区（另见 save_raw）
返回类型:: None

property n_features_in_: int: 在 fit() 期间看到的特征数量。

predict(X, output_margin=False, validate_features=True, base_margin=None, iteration_range=None)[源代码]

使用 X 进行预测。如果模型是使用早期停止训练的，那么会自动使用 best_iteration。估计器默认使用 inplace_predict，如果数据和估计器之间的设备不匹配，则会回退到使用 DMatrix。

备注

此函数仅对 gbtree 和 dart 线程安全。

参数:

X (Any) – 用于预测的数据。
output_margin (bool) – 是否输出未经转换的原始边距值。
validate_features (bool) – 当此项为 True 时，验证 Booster 和数据的 feature_names 是否相同。否则，假设 feature_names 是相同的。
base_margin (Any | None) – 每个实例的全局偏差。详情请参见拦截。
iteration_range (Tuple[int | integer, int | integer] | None) – 指定用于预测的树层。例如，如果一个随机森林经过100轮训练。指定 iteration_range=(10, 20)，那么只有在此期间[10, 20)（半开集）轮次内构建的森林用于此次预测。 .. versionadded:: 1.4.0

返回类型:

prediction

save_model(fname)

将模型保存到文件中。

模型以XGBoost内部格式保存，该格式在各种XGBoost接口中通用。Python Booster对象的辅助属性（如feature_names）仅在使用JSON或UBJSON（默认）格式时保存。更多信息请参见模型IO。

model.save_model("model.json")
# or
model.save_model("model.ubj")

参数:: fname (str | PathLike) – 输出文件名
返回类型:: None

score(X, y)[源代码]

使用最后一个评估指标对数据进行评分。如果模型是使用早停训练的，那么会自动使用 best_iteration。

参数:

X (Union[pd.DataFrame, cudf.DataFrame]) – 功能矩阵。一个带有特殊 qid 列的 DataFrame。
y (Any) – 标签

返回:

排名器第一个评估指标的结果。

返回类型:

score

set_fit_request(*, base_margin='$UNCHANGED$', base_margin_eval_set='$UNCHANGED$', eval_group='$UNCHANGED$', eval_qid='$UNCHANGED$', eval_set='$UNCHANGED$', feature_weights='$UNCHANGED$', group='$UNCHANGED$', qid='$UNCHANGED$', sample_weight='$UNCHANGED$', sample_weight_eval_set='$UNCHANGED$', verbose='$UNCHANGED$', xgb_model='$UNCHANGED$')

传递给 fit 方法的请求元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config()）。请参阅用户指南了解路由机制的工作原理。

每个参数的选项是：

True: 请求元数据，并在提供时传递给 fit。如果未提供元数据，则忽略该请求。
False: 不请求元数据，元估计器不会将其传递给 fit。
None: 不需要元数据，如果用户提供了元数据，元估计器将引发错误。
str: 元数据应使用此给定别名传递给元估计器，而不是原始名称。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你更改某些参数的请求，而不更改其他参数。

Added in version 1.3.

备注

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用。否则它不会有任何效果。

参数:

base_margin (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 base_margin 参数的元数据路由。
base_margin_eval_set (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 base_margin_eval_set 参数的元数据路由。
eval_group (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 中 eval_group 参数的元数据路由。
eval_qid (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 eval_qid 参数的元数据路由。
eval_set (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 eval_set 参数的元数据路由。
feature_weights (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 feature_weights 参数的元数据路由。
group (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 中 group 参数的元数据路由。
qid (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 中 qid 参数的元数据路由。
sample_weight (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 sample_weight 参数的元数据路由。
sample_weight_eval_set (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 sample_weight_eval_set 参数的元数据路由。
verbose (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 verbose 参数的元数据路由。
xgb_model (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 xgb_model 参数的元数据路由。
self (XGBRanker)

返回:

self – 更新后的对象。

返回类型:

set_params(**params)

设置此估计器的参数。修改了 sklearn 方法以允许未知的 kwargs。这允许使用在 sklearn 网格搜索中未定义为成员变量的 xgboost 参数的完整范围。

返回类型:: self
参数:: params (Any)

set_predict_request(*, base_margin='$UNCHANGED$', iteration_range='$UNCHANGED$', output_margin='$UNCHANGED$', validate_features='$UNCHANGED$')

传递给 predict 方法的请求元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config()）。请参阅用户指南了解路由机制的工作原理。

每个参数的选项是：

True: 请求元数据，并在提供时传递给 predict。如果未提供元数据，则忽略请求。
False: 不请求元数据，元估计器不会将其传递给 predict。
None: 不需要元数据，如果用户提供了元数据，元估计器将引发错误。
str: 元数据应使用此给定别名传递给元估计器，而不是原始名称。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你更改某些参数的请求，而不更改其他参数。

Added in version 1.3.

备注

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用。否则它不会有任何效果。

参数:

base_margin (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 base_margin 参数的元数据路由。
iteration_range (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 iteration_range 参数的元数据路由。
output_margin (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 output_margin 参数的元数据路由。
validate_features (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 validate_features 参数的元数据路由。
self (XGBRanker)

返回:

self – 更新后的对象。

返回类型:

class xgboost.XGBRFRegressor(*, learning_rate=1.0, subsample=0.8, colsample_bynode=0.8, reg_lambda=1e-05, **kwargs)[源代码]

基类：XGBRegressor

XGBoost 随机森林回归的 scikit-learn API。更多信息请参见使用 Scikit-Learn 估计器接口。

参数:

n_estimators (Optional[int]) – 随机森林中拟合的树的数量。
max_depth (Optional[int]) – 基学习器的最大树深度。
max_leaves (Optional[int]) – 最大叶子数；0 表示无限制。
max_bin (Optional[int]) – 如果使用基于直方图的算法，每个特征的最大箱数
grow_policy (Optional[str]) – 树生长策略。 - depthwise: 倾向于在离节点最近的节点进行分割， - lossguide: 倾向于在损失变化最大的节点进行分割。
learning_rate (Optional[float]) – 提升学习率（xgb 的“eta”）
verbosity (Optional[int]) – 冗长程度。有效值为 0（静默） - 3（调试）。
objective (Union[str, xgboost.sklearn._SklObjWProto, Callable[[Any, Any], Tuple[numpy.ndarray, numpy.ndarray]], NoneType]) – 指定学习任务以及相应的学习目标或自定义目标函数。对于自定义目标，请参阅自定义目标和评估指标和自定义目标和指标以获取更多信息，以及函数签名的结尾注释。
booster (Optional[str]) – 指定使用哪个增强器：gbtree、gblinear 或 dart。
tree_method (Optional[str]) – 指定要使用的树方法。默认为自动。如果此参数设置为默认，XGBoost 将选择最保守的可用选项。建议从参数文档中研究此选项树方法
n_jobs (Optional[int]) – 用于运行 xgboost 的并行线程数。当与其他 Scikit-Learn 算法（如网格搜索）一起使用时，您可以选择并行化哪个算法并平衡线程。创建线程争用将显著减慢两个算法。
gamma (Optional[float]) – (min_split_loss) 在树的叶节点上进行进一步分区所需的最小损失减少量。
min_child_weight (Optional[float]) – 子节点中所需的实例权重（Hessian）的最小和。
max_delta_step (Optional[float]) – 我们允许每棵树的权重估计的最大增量步长。
subsample (Optional[float]) – 训练实例的子样本比例。
sampling_method (Optional[str]) – 采样方法。仅由 hist 树方法的 GPU 版本使用。 - uniform: 均匀选择随机训练实例。 - gradient_based: 当梯度和 Hessian 较大时，以更高概率选择随机训练实例。（参见 CatBoost）
colsample_bytree (Optional[float]) – 构建每棵树时列的子样本比例。
colsample_bylevel (Optional[float]) – 每个级别的列子样本比率。
colsample_bynode (Optional[float]) – 每次分割的列子样本比例。
reg_alpha (Optional[float]) – 权重的L1正则化项（xgb的alpha）。
reg_lambda (Optional[float]) – 权重上的L2正则化项（xgb的lambda）。
scale_pos_weight (Optional[float]) – 正负权重的平衡。
base_score (Optional[float]) – 所有实例的初始预测分数，全局偏置。
random_state (Union[numpy.random.mtrand.RandomState, numpy.random._generator.Generator, int, NoneType]) – 随机数种子。 .. 注意:: 使用 shotgun updater 的 gblinear booster 是非确定性的，因为它使用了 Hogwild 算法。
missing (float) – 数据中需要作为缺失值存在的值。默认为 numpy.nan。
num_parallel_tree (Optional[int]) – 用于增强随机森林。
monotone_constraints (Union[Dict[str, int], str, NoneType]) – 变量单调性的约束。更多信息请参见教程。
interaction_constraints (Union[str, List[Tuple[str]], NoneType]) – 表示允许交互的约束条件。约束条件必须以嵌套列表的形式指定，例如 [[0, 1], [2, 3, 4]]，其中每个内部列表是一组允许相互交互的特征索引。更多信息请参见教程。
importance_type (Optional[str]) – 特征重要性类型用于feature_importances_属性： * 对于树模型，可以是”gain”、”weight”、”cover”、”total_gain”或”total_cover”。 * 对于线性模型，仅定义了”weight”，它是无偏差的归一化系数。
device (Optional[str]) –

Added in version 2.0.0.

设备序号，可用选项为 cpu、cuda 和 gpu。
validate_parameters (Optional[bool]) – 对未知参数发出警告。
enable_categorical (bool) – 详情请参见 DMatrix 的相同参数。
feature_types (Optional[Sequence[str]]) –

Added in version 1.7.0.

用于指定特征类型而不构建数据框。详情请参见 DMatrix。
max_cat_to_onehot (Optional[int]) –

Added in version 1.6.0.

备注

此参数为实验性

决定XGBoost是否应使用独热编码进行分类数据分割的阈值。当类别数量小于阈值时，选择独热编码，否则类别将被分割到子节点中。此外，需要设置 enable_categorical 以支持分类特征。详情请参见分类数据和分类特征的参数。
max_cat_threshold (Optional[int]) –

Added in version 1.7.0.

备注

此参数为实验性

每个分割考虑的最大类别数。仅用于基于分区的分割，以防止过拟合。此外，enable_categorical 需要设置为支持分类特征。详情请参见分类数据和分类特征的参数。
multi_strategy (Optional[str]) –

Added in version 2.0.0.

备注

此参数正在开发中。

用于训练多目标模型的策略，包括多目标回归和多类分类。更多信息请参见多重输出。
- one_output_per_tree: 每个目标一个模型。
- multi_output_tree: 使用多目标树。
eval_metric (Union[str, List[str], Callable, NoneType]) –

Added in version 1.6.0.

用于监控训练结果和提前停止的指标。它可以是一个字符串或字符串列表，作为XGBoost中预定义指标的名称（参见doc/parameter.rst），也可以是 sklearn.metrics 中的一个指标，或者是任何其他类似于 sklearn.metrics 的用户定义指标。

如果提供了自定义目标，那么自定义指标应实现相应的反向链接函数。

与 scikit-learn 中常用的 scoring 参数不同，当提供一个可调用对象时，它被假定为一个成本函数，默认情况下 XGBoost 将在早停期间最小化结果。

For advanced usage on Early stopping like directly choosing to maximize instead of minimize, see xgboost.callback.EarlyStopping.

更多信息请参见自定义目标和评估指标和自定义目标和指标。
```
from sklearn.datasets import load_diabetes
from sklearn.metrics import mean_absolute_error
X, y = load_diabetes(return_X_y=True)
reg = xgb.XGBRegressor(
    tree_method="hist",
    eval_metric=mean_absolute_error,
)
reg.fit(X, y, eval_set=[(X, y)])
```
early_stopping_rounds (Optional[int]) –

Added in version 1.6.0.
- 激活早停机制。验证指标需要在每 early_stopping_rounds 轮中至少改善一次以继续训练。这需要在 fit() 中至少有一个 eval_set 项。
- 如果发生早停，模型将有两个额外的属性：best_score 和 best_iteration。这些属性用于 predict() 和 apply() 方法，以在推理过程中确定最佳的树的数量。如果用户想要访问完整的模型（包括早停后构建的树），他们可以在这些推理方法中指定 iteration_range。此外，其他实用工具如模型绘图也可以使用整个模型。
- 如果你倾向于在 best_iteration 之后丢弃树，可以考虑使用回调函数 xgboost.callback.EarlyStopping。
- 如果 eval_set 中有多个项目，最后一个条目将用于提前停止。如果 eval_metric 中有多个指标，最后一个指标将用于提前停止。
callbacks (Optional[List[xgboost.callback.TrainingCallback]]) – 在每次迭代结束时应用的回调函数列表。可以通过使用回调 API 来使用预定义的回调。 .. 注意:
kwargs (Optional[Any]) – XGBoost Booster对象的关键字参数。参数的完整文档可以在这里找到。尝试通过构造函数参数和 **kwargs 字典同时设置参数将导致 TypeError。

apply(X, iteration_range=None)

返回每个样本在每棵树上的预测叶子。如果模型是使用早期停止训练的，那么会自动使用 best_iteration。

参数:

X (array_like, shape=[n_samples, n_features]) – 输入特征矩阵。
iteration_range (Tuple[int | integer, int | integer] | None) – 参见 predict()。

返回:

X_leaves – 对于 X 中的每个数据点 x 和每棵树，返回 x 最终所在的叶子的索引。叶子在 [0; 2**(self.max_depth+1)) 范围内编号，编号中可能存在间隙。

返回类型:

array_like, shape=[n_samples, n_trees]

property best_iteration: int: 通过早期停止获得的最佳迭代。此属性是基于0的，例如，如果最佳迭代是第一轮，那么 best_iteration 为 0。

property best_score: float: 通过早期停止获得的最佳分数。

property coef_: ndarray

Coefficients 属性

备注

系数仅针对线性学习器定义

系数仅在选择线性模型作为基础学习器时定义（booster=gblinear）。对于其他基础学习器类型，如树学习器（booster=gbtree），则未定义。

返回:: coef_
返回类型:: 形状为 [n_features] 或 [n_classes, n_features] 的数组

evals_result()

返回评估结果。

如果将 eval_set 传递给 fit() 函数，你可以调用 evals_result() 来获取所有传递的 eval_sets 的评估结果。当 eval_metric 也被传递给 fit() 函数时，evals_result 将包含传递给 fit() 函数的 eval_metrics。

返回的评估结果是一个字典：

{'validation_0': {'logloss': ['0.604835', '0.531479']},
 'validation_1': {'logloss': ['0.41965', '0.17686']}}

返回类型:: evals_result

property feature_importances_: ndarray

特征重要性属性，返回结果取决于 importance_type 参数。当模型使用多类/多标签/多目标数据集训练时，特征重要性是“平均”所有目标的。“平均”是基于重要性类型定义的。例如，如果重要性类型是“total_gain”，那么分数是所有树中每个分裂的损失变化的总和。

返回:

feature_importances_ (形状为 [n_features] 的数组，多类情况除外)
线性模型，返回形状为 (n_features, n_classes) 的数组

property feature_names_in_: ndarray: 在 fit() 过程中看到的特征名称。仅当 X 的特征名称均为字符串时定义。

fit(X, y, *, sample_weight=None, base_margin=None, eval_set=None, verbose=True, xgb_model=None, sample_weight_eval_set=None, base_margin_eval_set=None, feature_weights=None)[源代码]

拟合梯度提升模型。

请注意，多次调用 fit() 将导致模型对象从头开始重新拟合。要从之前的检查点恢复训练，请显式传递 xgb_model 参数。

参数:

X (Any) – 功能矩阵。查看各种 XGBoost 函数支持的数据结构以获取支持的类型列表。当 tree_method 设置为 hist 时，内部将使用 QuantileDMatrix 而不是 DMatrix 以节省内存。然而，当输入数据的设备与算法不匹配时，这会影响性能。例如，如果输入是CPU上的numpy数组，但训练使用 cuda，则数据首先在CPU上处理，然后传输到GPU。
y (Any) – 标签
sample_weight (Any | None) – 实例权重
base_margin (Any | None) – 每个实例的全局偏差。详情请参见拦截。
eval_set (Sequence[Tuple[Any, Any]] | None) – 用于作为验证集的 (X, y) 元组对列表，将计算这些验证集的指标。验证指标将帮助我们跟踪模型的性能。
verbose (bool | int | None) – 如果 verbose 为 True 并且使用了评估集，验证集上的评估指标会在每次提升阶段打印到标准输出。如果 verbose 是一个整数，评估指标会在每 verbose 次提升阶段打印。最后一次提升阶段或通过 early_stopping_rounds 找到的提升阶段也会被打印。
xgb_model (Booster | str | XGBModel | None) – 存储的XGBoost模型文件名或’Booster’实例 XGBoost模型，在训练前加载（允许训练继续）。
sample_weight_eval_set (Sequence[Any] | None) – 形式为 [L_1, L_2, …, L_n] 的列表，其中每个 L_i 是一个类似数组的对象，存储第 i 个验证集的实例权重。
base_margin_eval_set (Sequence[Any] | None) – 形式为 [M_1, M_2, …, M_n] 的列表，其中每个 M_i 是一个存储第 i 个验证集的基边界的类似数组的对象。
feature_weights (Any | None) – 每个特征的权重，定义了在使用colsample时每个特征被选中的概率。所有值必须大于0，否则会抛出 ValueError。

返回类型:

XGBRFRegressor

get_booster()

获取此模型的底层 xgboost Booster。

当未调用 fit 时，这将引发异常

返回:: booster
返回类型:: a xgboost booster of underlying model

get_metadata_routing()

获取此对象的元数据路由。

请查看用户指南以了解路由机制的工作原理。

返回:: routing – 一个封装了路由信息的 MetadataRequest。
返回类型:: MetadataRequest

get_num_boosting_rounds()[源代码]

获取xgboost的增强轮数。

返回类型:: int

get_params(deep=True)

获取参数。

参数:: deep (bool)
返回类型:: Dict[str, Any]

get_xgb_params()[源代码]

获取 xgboost 特定的参数。

返回类型:: Dict[str, Any]

property intercept_: ndarray

截距（偏差）属性

对于基于树的模型，返回值是 base_score。

返回:: 拦截_
返回类型:: 形状为 (1,) 或 [n_classes] 的数组

load_model(fname)

从文件或字节数组加载模型。

模型以XGBoost内部格式保存，该格式在各种XGBoost接口中通用。Python Booster对象的辅助属性（如feature_names）仅在使用JSON或UBJSON（默认）格式时保存。更多信息请参见模型IO。

model.load_model("model.json")
# or
model.load_model("model.ubj")

参数:: fname (str | bytearray | PathLike) – 输入文件名或内存缓冲区（另见 save_raw）
返回类型:: None

property n_features_in_: int: 在 fit() 期间看到的特征数量。

predict(X, output_margin=False, validate_features=True, base_margin=None, iteration_range=None)

使用 X 进行预测。如果模型是使用早期停止训练的，那么会自动使用 best_iteration。估计器默认使用 inplace_predict，如果数据和估计器之间的设备不匹配，则会回退到使用 DMatrix。

备注

此函数仅对 gbtree 和 dart 线程安全。

参数:

X (Any) – 用于预测的数据。
output_margin (bool) – 是否输出未经转换的原始边距值。
validate_features (bool) – 当此项为 True 时，验证 Booster 和数据的 feature_names 是否相同。否则，假设 feature_names 是相同的。
base_margin (Any | None) – 每个实例的全局偏差。详情请参见拦截。
iteration_range (Tuple[int | integer, int | integer] | None) – 指定用于预测的树层。例如，如果一个随机森林经过100轮训练。指定 iteration_range=(10, 20)，那么只有在此期间[10, 20)（半开集）轮次内构建的森林用于此次预测。 .. versionadded:: 1.4.0

返回类型:

prediction

save_model(fname)

将模型保存到文件中。

模型以XGBoost内部格式保存，该格式在各种XGBoost接口中通用。Python Booster对象的辅助属性（如feature_names）仅在使用JSON或UBJSON（默认）格式时保存。更多信息请参见模型IO。

model.save_model("model.json")
# or
model.save_model("model.ubj")

参数:: fname (str | PathLike) – 输出文件名
返回类型:: None

score(X, y, sample_weight=None)

返回预测的决定系数。

决定系数 $R^2$ 定义为 $(1 - \frac{u}{v})$，其中 $u$ 是残差平方和 ((y_true - y_pred)** 2).sum()，而 $v$ 是总平方和 ((y_true - y_true.mean()) ** 2).sum()。最佳可能的分数是 1.0，它也可能是负数（因为模型可能任意地差）。一个总是预测 y 的期望值的常数模型，忽略输入特征，将得到一个 $R^2$ 分数为 0.0。

参数:

X (array-like of shape (n_samples, n_features)) – 测试样本。对于某些估计器，这可能是一个预计算的核矩阵，或者是一个形状为 (n_samples, n_samples_fitted) 的通用对象列表，其中 n_samples_fitted 是用于估计器拟合的样本数量。
y (array-like of shape (n_samples,) or (n_samples, n_outputs)) – X 的真值。
sample_weight (array-like of shape (n_samples,), default=None) – 样本权重。

返回:

score – self.predict(X) 相对于 y 的 $R^2$。

返回类型:

备注

在调用回归器的 score 时使用的 $R^2$ 评分，从版本 0.23 开始使用 multioutput='uniform_average' 以保持与 r2_score() 的默认值一致。这会影响所有多输出回归器的 score 方法（除了 MultiOutputRegressor）。

set_fit_request(*, base_margin='$UNCHANGED$', base_margin_eval_set='$UNCHANGED$', eval_set='$UNCHANGED$', feature_weights='$UNCHANGED$', sample_weight='$UNCHANGED$', sample_weight_eval_set='$UNCHANGED$', verbose='$UNCHANGED$', xgb_model='$UNCHANGED$')

传递给 fit 方法的请求元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config()）。请参阅用户指南了解路由机制的工作原理。

每个参数的选项是：

True: 请求元数据，并在提供时传递给 fit。如果未提供元数据，则忽略该请求。
False: 不请求元数据，元估计器不会将其传递给 fit。
None: 不需要元数据，如果用户提供了元数据，元估计器将引发错误。
str: 元数据应使用此给定别名传递给元估计器，而不是原始名称。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你更改某些参数的请求，而不更改其他参数。

Added in version 1.3.

备注

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用。否则它不会有任何效果。

参数:

base_margin (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 base_margin 参数的元数据路由。
base_margin_eval_set (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 base_margin_eval_set 参数的元数据路由。
eval_set (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 eval_set 参数的元数据路由。
feature_weights (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 feature_weights 参数的元数据路由。
sample_weight (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 sample_weight 参数的元数据路由。
sample_weight_eval_set (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 sample_weight_eval_set 参数的元数据路由。
verbose (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 verbose 参数的元数据路由。
xgb_model (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 xgb_model 参数的元数据路由。
self (XGBRFRegressor)

返回:

self – 更新后的对象。

返回类型:

set_params(**params)

设置此估计器的参数。修改了 sklearn 方法以允许未知的 kwargs。这允许使用在 sklearn 网格搜索中未定义为成员变量的 xgboost 参数的完整范围。

返回类型:: self
参数:: params (Any)

set_predict_request(*, base_margin='$UNCHANGED$', iteration_range='$UNCHANGED$', output_margin='$UNCHANGED$', validate_features='$UNCHANGED$')

传递给 predict 方法的请求元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config()）。请参阅用户指南了解路由机制的工作原理。

每个参数的选项是：

True: 请求元数据，并在提供时传递给 predict。如果未提供元数据，则忽略请求。
False: 不请求元数据，元估计器不会将其传递给 predict。
None: 不需要元数据，如果用户提供了元数据，元估计器将引发错误。
str: 元数据应使用此给定别名传递给元估计器，而不是原始名称。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你更改某些参数的请求，而不更改其他参数。

Added in version 1.3.

备注

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用。否则它不会有任何效果。

参数:

base_margin (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 base_margin 参数的元数据路由。
iteration_range (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 iteration_range 参数的元数据路由。
output_margin (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 output_margin 参数的元数据路由。
validate_features (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 validate_features 参数的元数据路由。
self (XGBRFRegressor)

返回:

self – 更新后的对象。

返回类型:

set_score_request(*, sample_weight='$UNCHANGED$')

传递给 score 方法的请求元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config()）。请参阅用户指南了解路由机制的工作原理。

每个参数的选项是：

True: 请求元数据，并在提供时传递给 score。如果未提供元数据，则忽略请求。
False: 不需要元数据，元估计器不会将其传递给 score。
None: 不需要元数据，如果用户提供了元数据，元估计器将引发错误。
str: 元数据应使用此给定别名传递给元估计器，而不是原始名称。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你更改某些参数的请求，而不更改其他参数。

Added in version 1.3.

备注

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用。否则它不会有任何效果。

参数:

sample_weight (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – score 方法中 sample_weight 参数的元数据路由。
self (XGBRFRegressor)

返回:

self – 更新后的对象。

返回类型:

class xgboost.XGBRFClassifier(*, learning_rate=1.0, subsample=0.8, colsample_bynode=0.8, reg_lambda=1e-05, **kwargs)[源代码]

基类：XGBClassifier

XGBoost 随机森林分类的 scikit-learn API。更多信息请参见使用 Scikit-Learn 估计器接口。

参数:

n_estimators (Optional[int]) – 随机森林中拟合的树的数量。
max_depth (Optional[int]) – 基学习器的最大树深度。
max_leaves (Optional[int]) – 最大叶子数；0 表示无限制。
max_bin (Optional[int]) – 如果使用基于直方图的算法，每个特征的最大箱数
grow_policy (Optional[str]) – 树生长策略。 - depthwise: 倾向于在离节点最近的节点进行分割， - lossguide: 倾向于在损失变化最大的节点进行分割。
learning_rate (Optional[float]) – 提升学习率（xgb 的“eta”）
verbosity (Optional[int]) – 冗长程度。有效值为 0（静默） - 3（调试）。
objective (Union[str, xgboost.sklearn._SklObjWProto, Callable[[Any, Any], Tuple[numpy.ndarray, numpy.ndarray]], NoneType]) – 指定学习任务以及相应的学习目标或自定义目标函数。对于自定义目标，请参阅自定义目标和评估指标和自定义目标和指标以获取更多信息，以及函数签名的结尾注释。
booster (Optional[str]) – 指定使用哪个增强器：gbtree、gblinear 或 dart。
tree_method (Optional[str]) – 指定要使用的树方法。默认为自动。如果此参数设置为默认，XGBoost 将选择最保守的可用选项。建议从参数文档中研究此选项树方法
n_jobs (Optional[int]) – 用于运行 xgboost 的并行线程数。当与其他 Scikit-Learn 算法（如网格搜索）一起使用时，您可以选择并行化哪个算法并平衡线程。创建线程争用将显著减慢两个算法。
gamma (Optional[float]) – (min_split_loss) 在树的叶节点上进行进一步分区所需的最小损失减少量。
min_child_weight (Optional[float]) – 子节点中所需的实例权重（Hessian）的最小和。
max_delta_step (Optional[float]) – 我们允许每棵树的权重估计的最大增量步长。
subsample (Optional[float]) – 训练实例的子样本比例。
sampling_method (Optional[str]) – 采样方法。仅由 hist 树方法的 GPU 版本使用。 - uniform: 均匀选择随机训练实例。 - gradient_based: 当梯度和 Hessian 较大时，以更高概率选择随机训练实例。（参见 CatBoost）
colsample_bytree (Optional[float]) – 构建每棵树时列的子样本比例。
colsample_bylevel (Optional[float]) – 每个级别的列子样本比率。
colsample_bynode (Optional[float]) – 每次分割的列子样本比例。
reg_alpha (Optional[float]) – 权重的L1正则化项（xgb的alpha）。
reg_lambda (Optional[float]) – 权重上的L2正则化项（xgb的lambda）。
scale_pos_weight (Optional[float]) – 正负权重的平衡。
base_score (Optional[float]) – 所有实例的初始预测分数，全局偏置。
random_state (Union[numpy.random.mtrand.RandomState, numpy.random._generator.Generator, int, NoneType]) – 随机数种子。 .. 注意:: 使用 shotgun updater 的 gblinear booster 是非确定性的，因为它使用了 Hogwild 算法。
missing (float) – 数据中需要作为缺失值存在的值。默认为 numpy.nan。
num_parallel_tree (Optional[int]) – 用于增强随机森林。
monotone_constraints (Union[Dict[str, int], str, NoneType]) – 变量单调性的约束。更多信息请参见教程。
interaction_constraints (Union[str, List[Tuple[str]], NoneType]) – 表示允许交互的约束条件。约束条件必须以嵌套列表的形式指定，例如 [[0, 1], [2, 3, 4]]，其中每个内部列表是一组允许相互交互的特征索引。更多信息请参见教程。
importance_type (Optional[str]) – 特征重要性类型用于feature_importances_属性： * 对于树模型，可以是”gain”、”weight”、”cover”、”total_gain”或”total_cover”。 * 对于线性模型，仅定义了”weight”，它是无偏差的归一化系数。
device (Optional[str]) –

Added in version 2.0.0.

设备序号，可用选项为 cpu、cuda 和 gpu。
validate_parameters (Optional[bool]) – 对未知参数发出警告。
enable_categorical (bool) – 详情请参见 DMatrix 的相同参数。
feature_types (Optional[Sequence[str]]) –

Added in version 1.7.0.

用于指定特征类型而不构建数据框。详情请参见 DMatrix。
max_cat_to_onehot (Optional[int]) –

Added in version 1.6.0.

备注

此参数为实验性

决定XGBoost是否应使用独热编码进行分类数据分割的阈值。当类别数量小于阈值时，选择独热编码，否则类别将被分割到子节点中。此外，需要设置 enable_categorical 以支持分类特征。详情请参见分类数据和分类特征的参数。
max_cat_threshold (Optional[int]) –

Added in version 1.7.0.

备注

此参数为实验性

每个分割考虑的最大类别数。仅用于基于分区的分割，以防止过拟合。此外，enable_categorical 需要设置为支持分类特征。详情请参见分类数据和分类特征的参数。
multi_strategy (Optional[str]) –

Added in version 2.0.0.

备注

此参数正在开发中。

用于训练多目标模型的策略，包括多目标回归和多类分类。更多信息请参见多重输出。
- one_output_per_tree: 每个目标一个模型。
- multi_output_tree: 使用多目标树。
eval_metric (Union[str, List[str], Callable, NoneType]) –

Added in version 1.6.0.

用于监控训练结果和提前停止的指标。它可以是一个字符串或字符串列表，作为XGBoost中预定义指标的名称（参见doc/parameter.rst），也可以是 sklearn.metrics 中的一个指标，或者是任何其他类似于 sklearn.metrics 的用户定义指标。

如果提供了自定义目标，那么自定义指标应实现相应的反向链接函数。

与 scikit-learn 中常用的 scoring 参数不同，当提供一个可调用对象时，它被假定为一个成本函数，默认情况下 XGBoost 将在早停期间最小化结果。

For advanced usage on Early stopping like directly choosing to maximize instead of minimize, see xgboost.callback.EarlyStopping.

更多信息请参见自定义目标和评估指标和自定义目标和指标。
```
from sklearn.datasets import load_diabetes
from sklearn.metrics import mean_absolute_error
X, y = load_diabetes(return_X_y=True)
reg = xgb.XGBRegressor(
    tree_method="hist",
    eval_metric=mean_absolute_error,
)
reg.fit(X, y, eval_set=[(X, y)])
```
early_stopping_rounds (Optional[int]) –

Added in version 1.6.0.
- 激活早停机制。验证指标需要在每 early_stopping_rounds 轮中至少改善一次以继续训练。这需要在 fit() 中至少有一个 eval_set 项。
- 如果发生早停，模型将有两个额外的属性：best_score 和 best_iteration。这些属性用于 predict() 和 apply() 方法，以在推理过程中确定最佳的树的数量。如果用户想要访问完整的模型（包括早停后构建的树），他们可以在这些推理方法中指定 iteration_range。此外，其他实用工具如模型绘图也可以使用整个模型。
- 如果你倾向于在 best_iteration 之后丢弃树，可以考虑使用回调函数 xgboost.callback.EarlyStopping。
- 如果 eval_set 中有多个项目，最后一个条目将用于提前停止。如果 eval_metric 中有多个指标，最后一个指标将用于提前停止。
callbacks (Optional[List[xgboost.callback.TrainingCallback]]) – 在每次迭代结束时应用的回调函数列表。可以通过使用回调 API 来使用预定义的回调。 .. 注意:
kwargs (Optional[Any]) – XGBoost Booster对象的关键字参数。参数的完整文档可以在这里找到。尝试通过构造函数参数和 **kwargs 字典同时设置参数将导致 TypeError。

apply(X, iteration_range=None)

返回每个样本在每棵树上的预测叶子。如果模型是使用早期停止训练的，那么会自动使用 best_iteration。

参数:

X (array_like, shape=[n_samples, n_features]) – 输入特征矩阵。
iteration_range (Tuple[int | integer, int | integer] | None) – 参见 predict()。

返回:

X_leaves – 对于 X 中的每个数据点 x 和每棵树，返回 x 最终所在的叶子的索引。叶子在 [0; 2**(self.max_depth+1)) 范围内编号，编号中可能存在间隙。

返回类型:

array_like, shape=[n_samples, n_trees]

property best_iteration: int: 通过早期停止获得的最佳迭代。此属性是基于0的，例如，如果最佳迭代是第一轮，那么 best_iteration 为 0。

property best_score: float: 通过早期停止获得的最佳分数。

property coef_: ndarray

Coefficients 属性

备注

系数仅针对线性学习器定义

系数仅在选择线性模型作为基础学习器时定义（booster=gblinear）。对于其他基础学习器类型，如树学习器（booster=gbtree），则未定义。

返回:: coef_
返回类型:: 形状为 [n_features] 或 [n_classes, n_features] 的数组

evals_result()

返回评估结果。

如果将 eval_set 传递给 fit() 函数，你可以调用 evals_result() 来获取所有传递的 eval_sets 的评估结果。当 eval_metric 也被传递给 fit() 函数时，evals_result 将包含传递给 fit() 函数的 eval_metrics。

返回的评估结果是一个字典：

{'validation_0': {'logloss': ['0.604835', '0.531479']},
 'validation_1': {'logloss': ['0.41965', '0.17686']}}

返回类型:: evals_result

property feature_importances_: ndarray

特征重要性属性，返回结果取决于 importance_type 参数。当模型使用多类/多标签/多目标数据集训练时，特征重要性是“平均”所有目标的。“平均”是基于重要性类型定义的。例如，如果重要性类型是“total_gain”，那么分数是所有树中每个分裂的损失变化的总和。

返回:

feature_importances_ (形状为 [n_features] 的数组，多类情况除外)
线性模型，返回形状为 (n_features, n_classes) 的数组

property feature_names_in_: ndarray: 在 fit() 过程中看到的特征名称。仅当 X 的特征名称均为字符串时定义。

fit(X, y, *, sample_weight=None, base_margin=None, eval_set=None, verbose=True, xgb_model=None, sample_weight_eval_set=None, base_margin_eval_set=None, feature_weights=None)[源代码]

拟合梯度提升分类器。

请注意，多次调用 fit() 将导致模型对象从头开始重新拟合。要从之前的检查点恢复训练，请显式传递 xgb_model 参数。

参数:

X (Any) – 功能矩阵。查看各种 XGBoost 函数支持的数据结构以获取支持的类型列表。当 tree_method 设置为 hist 时，内部将使用 QuantileDMatrix 而不是 DMatrix 以节省内存。然而，当输入数据的设备与算法不匹配时，这会影响性能。例如，如果输入是CPU上的numpy数组，但训练使用 cuda，则数据首先在CPU上处理，然后传输到GPU。
y (Any) – 标签
sample_weight (Any | None) – 实例权重
base_margin (Any | None) – 每个实例的全局偏差。详情请参见拦截。
eval_set (Sequence[Tuple[Any, Any]] | None) – 用于作为验证集的 (X, y) 元组对列表，将计算这些验证集的指标。验证指标将帮助我们跟踪模型的性能。
verbose (bool | int | None) – 如果 verbose 为 True 并且使用了评估集，验证集上的评估指标会在每次提升阶段打印到标准输出。如果 verbose 是一个整数，评估指标会在每 verbose 次提升阶段打印。最后一次提升阶段或通过 early_stopping_rounds 找到的提升阶段也会被打印。
xgb_model (Booster | str | XGBModel | None) – 存储的XGBoost模型文件名或’Booster’实例 XGBoost模型，在训练前加载（允许训练继续）。
sample_weight_eval_set (Sequence[Any] | None) – 形式为 [L_1, L_2, …, L_n] 的列表，其中每个 L_i 是一个类似数组的对象，存储第 i 个验证集的实例权重。
base_margin_eval_set (Sequence[Any] | None) – 形式为 [M_1, M_2, …, M_n] 的列表，其中每个 M_i 是一个存储第 i 个验证集的基边界的类似数组的对象。
feature_weights (Any | None) – 每个特征的权重，定义了在使用colsample时每个特征被选中的概率。所有值必须大于0，否则会抛出 ValueError。

返回类型:

XGBRFClassifier

get_booster()

获取此模型的底层 xgboost Booster。

当未调用 fit 时，这将引发异常

返回:: booster
返回类型:: a xgboost booster of underlying model

get_metadata_routing()

获取此对象的元数据路由。

请查看用户指南以了解路由机制的工作原理。

返回:: routing – 一个封装了路由信息的 MetadataRequest。
返回类型:: MetadataRequest

get_num_boosting_rounds()[源代码]

获取xgboost的增强轮数。

返回类型:: int

get_params(deep=True)

获取参数。

参数:: deep (bool)
返回类型:: Dict[str, Any]

get_xgb_params()[源代码]

获取 xgboost 特定的参数。

返回类型:: Dict[str, Any]

property intercept_: ndarray

截距（偏差）属性

对于基于树的模型，返回值是 base_score。

返回:: 拦截_
返回类型:: 形状为 (1,) 或 [n_classes] 的数组

load_model(fname)

从文件或字节数组加载模型。

模型以XGBoost内部格式保存，该格式在各种XGBoost接口中通用。Python Booster对象的辅助属性（如feature_names）仅在使用JSON或UBJSON（默认）格式时保存。更多信息请参见模型IO。

model.load_model("model.json")
# or
model.load_model("model.ubj")

参数:: fname (str | bytearray | PathLike) – 输入文件名或内存缓冲区（另见 save_raw）
返回类型:: None

property n_features_in_: int: 在 fit() 期间看到的特征数量。

predict(X, output_margin=False, validate_features=True, base_margin=None, iteration_range=None)

使用 X 进行预测。如果模型是使用早期停止训练的，那么会自动使用 best_iteration。估计器默认使用 inplace_predict，如果数据和估计器之间的设备不匹配，则会回退到使用 DMatrix。

备注

此函数仅对 gbtree 和 dart 线程安全。

参数:

X (Any) – 用于预测的数据。
output_margin (bool) – 是否输出未经转换的原始边距值。
validate_features (bool) – 当此项为 True 时，验证 Booster 和数据的 feature_names 是否相同。否则，假设 feature_names 是相同的。
base_margin (Any | None) – 每个实例的全局偏差。详情请参见拦截。
iteration_range (Tuple[int | integer, int | integer] | None) – 指定用于预测的树层。例如，如果一个随机森林经过100轮训练。指定 iteration_range=(10, 20)，那么只有在此期间[10, 20)（半开集）轮次内构建的森林用于此次预测。 .. versionadded:: 1.4.0

返回类型:

prediction

predict_proba(X, validate_features=True, base_margin=None, iteration_range=None)

预测每个 X 样本属于给定类别的概率。如果模型是使用早停法训练的，那么会自动使用 best_iteration。估计器默认使用 inplace_predict，如果数据和估计器之间的设备不匹配，则会回退到使用 DMatrix。

备注

此函数仅对 gbtree 和 dart 线程安全。

参数:

X (Any) – 功能矩阵。查看各种 XGBoost 函数支持的数据结构以获取支持的类型列表。
validate_features (bool) – 当此项为 True 时，验证 Booster 和数据的 feature_names 是否相同。否则，假设 feature_names 是相同的。
base_margin (Any | None) – 每个实例的全局偏差。详情请参见拦截。
iteration_range (Tuple[int | integer, int | integer] | None) – 指定在预测中使用哪一层树。例如，如果一个随机森林被训练了100轮。指定 iteration_range=(10, 20)，那么只有在这 [10, 20)（半开区间）轮中构建的森林被用于此次预测。

返回:

一个形状为 (n_samples, n_classes) 的 numpy 数组，表示每个数据样本属于某一类的概率。

返回类型:

prediction

save_model(fname)

将模型保存到文件中。

模型以XGBoost内部格式保存，该格式在各种XGBoost接口中通用。Python Booster对象的辅助属性（如feature_names）仅在使用JSON或UBJSON（默认）格式时保存。更多信息请参见模型IO。

model.save_model("model.json")
# or
model.save_model("model.ubj")

参数:: fname (str | PathLike) – 输出文件名
返回类型:: None

score(X, y, sample_weight=None)

返回给定测试数据和标签的平均准确率。

在多标签分类中，这是子集准确率，这是一个严格的度量标准，因为你要求每个样本的每个标签集都被正确预测。

参数:

X (array-like of shape (n_samples, n_features)) – 测试样本。
y (array-like of shape (n_samples,) or (n_samples, n_outputs)) – X 的真实标签。
sample_weight (array-like of shape (n_samples,), default=None) – 样本权重。

返回:

score – self.predict(X) 相对于 y 的平均准确率。

返回类型:

set_fit_request(*, base_margin='$UNCHANGED$', base_margin_eval_set='$UNCHANGED$', eval_set='$UNCHANGED$', feature_weights='$UNCHANGED$', sample_weight='$UNCHANGED$', sample_weight_eval_set='$UNCHANGED$', verbose='$UNCHANGED$', xgb_model='$UNCHANGED$')

传递给 fit 方法的请求元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config()）。请参阅用户指南了解路由机制的工作原理。

每个参数的选项是：

True: 请求元数据，并在提供时传递给 fit。如果未提供元数据，则忽略该请求。
False: 不请求元数据，元估计器不会将其传递给 fit。
None: 不需要元数据，如果用户提供了元数据，元估计器将引发错误。
str: 元数据应使用此给定别名传递给元估计器，而不是原始名称。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你更改某些参数的请求，而不更改其他参数。

Added in version 1.3.

备注

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用。否则它不会有任何效果。

参数:

base_margin (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 base_margin 参数的元数据路由。
base_margin_eval_set (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 base_margin_eval_set 参数的元数据路由。
eval_set (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 eval_set 参数的元数据路由。
feature_weights (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 feature_weights 参数的元数据路由。
sample_weight (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 sample_weight 参数的元数据路由。
sample_weight_eval_set (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 sample_weight_eval_set 参数的元数据路由。
verbose (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 verbose 参数的元数据路由。
xgb_model (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 xgb_model 参数的元数据路由。
self (XGBRFClassifier)

返回:

self – 更新后的对象。

返回类型:

set_params(**params)

设置此估计器的参数。修改了 sklearn 方法以允许未知的 kwargs。这允许使用在 sklearn 网格搜索中未定义为成员变量的 xgboost 参数的完整范围。

返回类型:: self
参数:: params (Any)

set_predict_proba_request(*, base_margin='$UNCHANGED$', iteration_range='$UNCHANGED$', validate_features='$UNCHANGED$')

传递给 predict_proba 方法的请求元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config()）。请参阅用户指南了解路由机制的工作原理。

每个参数的选项是：

True: 请求元数据，并在提供时传递给 predict_proba。如果未提供元数据，则忽略该请求。
False: 不请求元数据，元估计器不会将其传递给 predict_proba。
None: 不需要元数据，如果用户提供了元数据，元估计器将引发错误。
str: 元数据应使用此给定别名传递给元估计器，而不是原始名称。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你更改某些参数的请求，而不更改其他参数。

Added in version 1.3.

备注

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用。否则它不会有任何效果。

参数:

base_margin (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict_proba 中 base_margin 参数的元数据路由。
iteration_range (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict_proba 中 iteration_range 参数的元数据路由。
validate_features (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict_proba 中的 validate_features 参数的元数据路由。
self (XGBRFClassifier)

返回:

self – 更新后的对象。

返回类型:

set_predict_request(*, base_margin='$UNCHANGED$', iteration_range='$UNCHANGED$', output_margin='$UNCHANGED$', validate_features='$UNCHANGED$')

传递给 predict 方法的请求元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config()）。请参阅用户指南了解路由机制的工作原理。

每个参数的选项是：

True: 请求元数据，并在提供时传递给 predict。如果未提供元数据，则忽略请求。
False: 不请求元数据，元估计器不会将其传递给 predict。
None: 不需要元数据，如果用户提供了元数据，元估计器将引发错误。
str: 元数据应使用此给定别名传递给元估计器，而不是原始名称。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你更改某些参数的请求，而不更改其他参数。

Added in version 1.3.

备注

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用。否则它不会有任何效果。

参数:

base_margin (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 base_margin 参数的元数据路由。
iteration_range (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 iteration_range 参数的元数据路由。
output_margin (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 output_margin 参数的元数据路由。
validate_features (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 validate_features 参数的元数据路由。
self (XGBRFClassifier)

返回:

self – 更新后的对象。

返回类型:

set_score_request(*, sample_weight='$UNCHANGED$')

传递给 score 方法的请求元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config()）。请参阅用户指南了解路由机制的工作原理。

每个参数的选项是：

True: 请求元数据，并在提供时传递给 score。如果未提供元数据，则忽略请求。
False: 不需要元数据，元估计器不会将其传递给 score。
None: 不需要元数据，如果用户提供了元数据，元估计器将引发错误。
str: 元数据应使用此给定别名传递给元估计器，而不是原始名称。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你更改某些参数的请求，而不更改其他参数。

Added in version 1.3.

备注

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用。否则它不会有任何效果。

参数:

sample_weight (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – score 方法中 sample_weight 参数的元数据路由。
self (XGBRFClassifier)

返回:

self – 更新后的对象。

返回类型:

绘图 API

绘图库。

xgboost.plot_importance(booster, ax=None, height=0.2, xlim=None, ylim=None, title='Feature importance', xlabel='F score', ylabel='Features', fmap='', importance_type='weight', max_num_features=None, grid=True, show_values=True, values_format='{v}', **kwargs)[源代码]

基于拟合的树绘制重要性。

参数:

booster (XGBModel | Booster | dict) – Booster 或 XGBModel 实例，或由 Booster.get_fscore() 获取的字典
ax (matplotlib Axes) – 目标轴实例。如果为 None，将创建新的图形和轴。
grid (bool) – 打开或关闭轴网格。默认是True（打开）。
importance_type (str) – 重要性计算方式：可以是“权重”、“增益”或“覆盖” * “权重”是特征在树中出现的次数 * “增益”是使用该特征的分割的平均增益 * “覆盖”是使用该特征的分割的平均覆盖范围其中，覆盖范围定义为受分割影响的样本数量
max_num_features (int | None) – 绘图上显示的最大顶部特征数量。如果为 None，则将显示所有特征。
height (float) – 条形高度，传递给 ax.barh()
xlim (tuple | None) – 传递给 axes.xlim() 的元组
ylim (tuple | None) – 传递给 axes.ylim() 的元组
title (str) – 坐标轴标题。要禁用，传递 None。
xlabel (str) – X 轴标题标签。要禁用，传递 None。
ylabel (str) – Y 轴标题标签。要禁用，传递 None。
fmap (str | PathLike) – 特征图文件的名称。
show_values (bool) – 在图表上显示值。若要禁用，请传递 False。
values_format (str) – 值的格式化字符串。”v” 将被替换为特征重要性的值。例如，传递 “{v:.2f}” 以便将图表上每个打印值的小数点后的位数限制为两位。
kwargs (Any) – 传递给 ax.barh() 的其他关键字

返回:

ax

返回类型:

matplotlib Axes

xgboost.plot_tree(booster, fmap='', num_trees=0, rankdir=None, ax=None, **kwargs)[源代码]

绘制指定的树。

参数:

booster (Booster, XGBModel) – Booster 或 XGBModel 实例
fmap (str (optional)) – 特征图文件的名称
num_trees (int, default 0) – 指定目标树的序号
rankdir (str, default "TB") – 通过 graph_attr 传递给 graphviz
ax (matplotlib Axes, default None) – 目标轴实例。如果为 None，将创建新的图形和轴。
kwargs (Any) – 传递给 to_graphviz 的其他关键字

返回:

ax

返回类型:

matplotlib Axes

xgboost.to_graphviz(booster, fmap='', num_trees=0, rankdir=None, yes_color=None, no_color=None, condition_node_params=None, leaf_node_params=None, **kwargs)[源代码]

将指定的树转换为 graphviz 实例。IPython 可以自动绘制返回的 graphviz 实例。否则，您应该调用返回的 graphviz 实例的 .render() 方法。

参数:

booster (Booster | XGBModel) – Booster 或 XGBModel 实例
fmap (str | PathLike) – 特征图文件的名称
num_trees (int) – 指定目标树的序号
rankdir (str | None) – 通过 graph_attr 传递给 graphviz
yes_color (str | None) – 当满足节点条件时的边颜色。
no_color (str | None) – 当不满足节点条件时的边颜色。
condition_node_params (dict | None) – graphviz 的条件节点配置。示例： .. code-block:: python
leaf_node_params (dict | None) – graphviz 的叶节点配置。示例： .. code-block:: python
kwargs (Any) – 传递给 graphviz graph_attr 的其他关键字，例如 graph [ {key} = {value} ]

返回:

图

返回类型:

graphviz.Source

回调 API

包含训练例程的回调库。有关快速介绍，请参阅回调函数。

class xgboost.callback.TrainingCallback[源代码]

训练回调的接口。

Added in version 1.3.0.

after_iteration(model, epoch, evals_log)[源代码]

每次迭代后运行。当训练应停止时返回 True。

参数:

model (Any) – 如果使用 xgboost 中的 cv 函数，则可以是 Booster 对象或 CVPack。
epoch (int) – 当前的训练迭代。
evals_log (Dict[str, Dict[str, List[float] | List[Tuple[float, float]]]]) – 包含评估历史的字典： .. code-block:: python {“data_name”: {“metric_name”: [0.5, …]}}

返回类型:

after_training(model)[源代码]

训练完成后运行。

参数:: model (Any)
返回类型:: Any

before_iteration(model, epoch, evals_log)[源代码]

在每次迭代之前运行。当训练应停止时返回 True。详情请参见 after_iteration()。

参数:

model (Any)
epoch (int)
evals_log (Dict[str, Dict[str, List[float] | List[Tuple[float, float]]]])

返回类型:

before_training(model)[源代码]

在训练开始前运行。

参数:: model (Any)
返回类型:: Any

class xgboost.callback.EvaluationMonitor(rank=0, period=1, show_stdv=False)[源代码]

基类：TrainingCallback

在每次迭代时打印评估结果。

Added in version 1.3.0.

参数:

rank (int) – 应该使用哪个工作者来打印结果。
period (int) – 打印之间的轮数。
show_stdv (bool) – 用于在简历中显示标准差。用户不应指定它。

after_iteration(model, epoch, evals_log)[源代码]

每次迭代后运行。当训练应停止时返回 True。

参数:

model (Any) – 如果使用 xgboost 中的 cv 函数，则可以是 Booster 对象或 CVPack。
epoch (int) – 当前的训练迭代。
evals_log (Dict[str, Dict[str, List[float] | List[Tuple[float, float]]]]) – 包含评估历史的字典： .. code-block:: python {“data_name”: {“metric_name”: [0.5, …]}}

返回类型:

after_training(model)[源代码]

训练完成后运行。

参数:: model (Any)
返回类型:: Any

class xgboost.callback.EarlyStopping(rounds, metric_name=None, data_name=None, maximize=None, save_best=False, min_delta=0.0)[源代码]

基类：TrainingCallback

用于提前停止的回调函数

Added in version 1.3.0.

参数:

rounds (int) – 早停轮数。
metric_name (str | None) – 用于提前停止的指标名称。
data_name (str | None) – 用于提前停止的数据集名称。
maximize (bool | None) – 是否最大化评估指标。None 表示自动（不推荐）。
save_best (bool | None) – 训练是否应该返回最佳模型或最后一个模型。
min_delta (float) –

Added in version 1.5.0.

得分中被视为改进的最小绝对变化。

示例

es = xgboost.callback.EarlyStopping(
    rounds=2,
    min_delta=1e-3,
    save_best=True,
    maximize=False,
    data_name="validation_0",
    metric_name="mlogloss",
)
clf = xgboost.XGBClassifier(tree_method="hist", device="cuda", callbacks=[es])

X, y = load_digits(return_X_y=True)
clf.fit(X, y, eval_set=[(X, y)])

after_iteration(model, epoch, evals_log)[源代码]

每次迭代后运行。当训练应停止时返回 True。

参数:

model (Any) – 如果使用 xgboost 中的 cv 函数，则可以是 Booster 对象或 CVPack。
epoch (int) – 当前的训练迭代。
evals_log (Dict[str, Dict[str, List[float] | List[Tuple[float, float]]]]) – 包含评估历史的字典： .. code-block:: python {“data_name”: {“metric_name”: [0.5, …]}}

返回类型:

after_training(model)[源代码]

训练完成后运行。

参数:: model (Any)
返回类型:: Any

before_training(model)[源代码]

在训练开始前运行。

参数:: model (Any)
返回类型:: Any

class xgboost.callback.LearningRateScheduler(learning_rates)[源代码]

基类：TrainingCallback

用于调度学习率的回调函数。

Added in version 1.3.0.

参数:: learning_rates (Callable[[int], float] | Sequence[float]) – 如果它是一个可调用对象，那么它应该接受一个整数参数 epoch 并返回相应的学习率。否则，它应该是一个与提升轮数大小相同的序列，如列表或元组。

after_iteration(model, epoch, evals_log)[源代码]

每次迭代后运行。当训练应停止时返回 True。

参数:

model (Any) – 如果使用 xgboost 中的 cv 函数，则可以是 Booster 对象或 CVPack。
epoch (int) – 当前的训练迭代。
evals_log (Dict[str, Dict[str, List[float] | List[Tuple[float, float]]]]) – 包含评估历史的字典： .. code-block:: python {“data_name”: {“metric_name”: [0.5, …]}}

返回类型:

class xgboost.callback.TrainingCheckPoint(directory, name='model', as_pickle=False, interval=100)[源代码]

基类：TrainingCallback

检查点操作。鼓励用户为检查点创建自己的回调，因为 XGBoost 不处理分布式文件系统。在分布式系统上进行检查点操作时，请确保了解工作节点的等级，以避免多个工作节点将检查点保存到同一位置。

Added in version 1.3.0.

自 XGBoost 2.1.0 起，默认格式已更改为 UBJSON。

参数:

directory (str | PathLike) – 输出模型目录。
name (str) – 输出模型文件的模式。模型将被保存为 name_0.ubj, name_1.ubj, name_2.ubj ….
as_pickle (bool) – 当设置为 True 时，所有训练参数将以 pickle 格式保存，而不仅仅是保存模型。
interval (int) – 检查点的时间间隔。检查点操作较慢，因此设置较大的时间间隔可以减少性能影响。

after_iteration(model, epoch, evals_log)[源代码]

每次迭代后运行。当训练应停止时返回 True。

参数:

model (Any) – 如果使用 xgboost 中的 cv 函数，则可以是 Booster 对象或 CVPack。
epoch (int) – 当前的训练迭代。
evals_log (Dict[str, Dict[str, List[float] | List[Tuple[float, float]]]]) – 包含评估历史的字典： .. code-block:: python {“data_name”: {“metric_name”: [0.5, …]}}

返回类型:

before_training(model)[源代码]

在训练开始前运行。

参数:: model (Any)
返回类型:: Any

Dask API

分布式训练的 Dask 扩展

参见使用 Dask 进行分布式 XGBoost 的简单教程。另外参见 XGBoost Dask 功能演示的一些示例。

本模块中有两组API，一组是包含 train 和 predict 方法的功能性API。另一组是有状态的Scikit-Learner包装器，继承自单节点Scikit-Learn接口。

该实现深受 dask_xgboost 的影响：https://github.com/dask/dask-xgboost

可选的 dask 配置

xgboost.scheduler_address: 指定调度器地址，参见故障排除。

Added in version 1.6.0.

dask.config.set({"xgboost.scheduler_address": "192.0.0.100"})
# We can also specify the port.
dask.config.set({"xgboost.scheduler_address": "192.0.0.100:12345"})

class xgboost.dask.DaskDMatrix(client, data, label=None, *, weight=None, base_margin=None, missing=None, silent=False, feature_names=None, feature_types=None, group=None, qid=None, label_lower_bound=None, label_upper_bound=None, feature_weights=None, enable_categorical=False)[源代码]

基类：object

DMatrix 持有对 Dask DataFrame 或 Dask Array 的引用。构建 DaskDMatrix 会强制所有惰性计算执行。如果你想看到构建 DaskDMatrix 的实际计算，请显式等待输入数据。

See doc for xgboost.DMatrix constructor for other parameters. DaskDMatrix accepts only dask collection.

备注

DaskDMatrix 不会在工作者之间重新分区或移动数据。平衡数据是调用者的责任。

Added in version 1.0.0.

参数:

client (distributed.Client) – 指定用于训练的 dask 客户端。如果没有设置，则使用 dask 返回的默认客户端。
data (da.Array | dd.DataFrame)
label (da.Array | dd.DataFrame | dd.Series | None)
weight (da.Array | dd.DataFrame | dd.Series | None)
base_margin (da.Array | dd.DataFrame | dd.Series | None)
missing (float | None)
silent (bool)
feature_names (Sequence[str] | None)
feature_types (Sequence[str] | None)
group (da.Array | dd.DataFrame | dd.Series | None)
qid (da.Array | dd.DataFrame | dd.Series | None)
label_lower_bound (da.Array | dd.DataFrame | dd.Series | None)
label_upper_bound (da.Array | dd.DataFrame | dd.Series | None)
feature_weights (da.Array | dd.DataFrame | dd.Series | None)
enable_categorical (bool)

num_col()[源代码]

获取DMatrix中的列数（特征数）。

返回类型:: number of columns

class xgboost.dask.DaskQuantileDMatrix(client, data, label=None, *, weight=None, base_margin=None, missing=None, silent=False, feature_names=None, feature_types=None, max_bin=None, ref=None, group=None, qid=None, label_lower_bound=None, label_upper_bound=None, feature_weights=None, enable_categorical=False)[源代码]

基类：DaskDMatrix

一个 QuantileDMatrix 的 dask 版本。

参数:

client (distributed.Client)
data (da.Array | dd.DataFrame)
label (da.Array | dd.DataFrame | dd.Series | None)
weight (da.Array | dd.DataFrame | dd.Series | None)
base_margin (da.Array | dd.DataFrame | dd.Series | None)
missing (float | None)
silent (bool)
feature_names (Sequence[str] | None)
feature_types (Any | List[Any] | None)
max_bin (int | None)
ref (DMatrix | None)
group (da.Array | dd.DataFrame | dd.Series | None)
qid (da.Array | dd.DataFrame | dd.Series | None)
label_lower_bound (da.Array | dd.DataFrame | dd.Series | None)
label_upper_bound (da.Array | dd.DataFrame | dd.Series | None)
feature_weights (da.Array | dd.DataFrame | dd.Series | None)
enable_categorical (bool)

num_col()

获取DMatrix中的列数（特征数）。

返回类型:: number of columns

xgboost.dask.train(client, params, dtrain, num_boost_round=10, *, evals=None, obj=None, feval=None, early_stopping_rounds=None, xgb_model=None, verbose_eval=True, callbacks=None, custom_metric=None)[源代码]

训练 XGBoost 模型。

Added in version 1.0.0.

备注

其他参数与 xgboost.train() 相同，除了 evals_result，它作为函数返回值的一部分返回，而不是作为参数。

参数:

client (distributed.Client) – 指定用于训练的 dask 客户端。如果没有设置，则使用 dask 返回的默认客户端。
params (Dict[str, Any])
dtrain (DaskDMatrix)
num_boost_round (int)
evals (Sequence[Tuple[DaskDMatrix, str]] | None)
obj (Callable[[ndarray, DMatrix], Tuple[ndarray, ndarray]] | None)
feval (Callable[[ndarray, DMatrix], Tuple[str, float]] | None)
early_stopping_rounds (int | None)
xgb_model (Booster | None)
verbose_eval (int | bool)
callbacks (Sequence[TrainingCallback] | None)
custom_metric (Callable[[ndarray, DMatrix], Tuple[str, float]] | None)

返回:

结果 – 包含训练好的增强器和评估历史的字典。history 字段与 xgboost.train 中的 eval_result 相同。 .. code-block:: python {‘booster’: xgboost.Booster, ‘history’: {‘train’: {‘logloss’: [‘0.48253’, ‘0.35953’]}, ‘eval’: {‘logloss’: [‘0.480385’, ‘0.357756’]}}}

返回类型:

dict

xgboost.dask.predict(client, model, data, output_margin=False, missing=nan, pred_leaf=False, pred_contribs=False, approx_contribs=False, pred_interactions=False, validate_features=True, iteration_range=(0, 0), strict_shape=False)[源代码]

使用训练好的提升器进行预测。

备注

使用 inplace_predict 在不需要某些特征时可能会更快。有关各种参数的详细信息，请参阅 xgboost.Booster.predict()。当输出具有超过2个维度（shap值，严格形状的叶子）时，输入应为 da.Array 或 DaskDMatrix。

Added in version 1.0.0.

参数:

client (distributed.Client | None) – 指定用于训练的 dask 客户端。如果没有设置，则使用 dask 返回的默认客户端。
model (TrainReturnT | Booster | distributed.Future) – 训练好的模型。它可以是一个分布式.Future，因此用户可以预先将它分散到所有工作节点上。
data (DaskDMatrix | da.Array | dd.DataFrame) – 用于预测的输入数据。当输入是数据框对象时，预测输出是一个序列。
missing (float) – 当输入数据不是 DaskDMatrix 时使用。指定被视为缺失的值。
output_margin (bool)
pred_leaf (bool)
pred_contribs (bool)
approx_contribs (bool)
pred_interactions (bool)
validate_features (bool)
iteration_range (Tuple[int | integer, int | integer])
strict_shape (bool)

返回:

预测 – 当输入数据是 dask.array.Array 或 DaskDMatrix 时，返回值是一个数组；当输入数据是 dask.dataframe.DataFrame 时，返回值可以是 dask.dataframe.Series 或 dask.dataframe.DataFrame，具体取决于输出形状。

返回类型:

dask.array.Array/dask.dataframe.Series

xgboost.dask.inplace_predict(client, model, data, iteration_range=(0, 0), predict_type='value', missing=nan, validate_features=True, base_margin=None, strict_shape=False)[源代码]

原地预测。详情请参阅 xgboost.Booster.inplace_predict() 中的文档。

Added in version 1.1.0.

参数:

client (distributed.Client | None) – 指定用于训练的 dask 客户端。如果没有设置，则使用 dask 返回的默认客户端。
model (TrainReturnT | Booster | distributed.Future) – 详情请参见 xgboost.dask.predict()。
data (da.Array | dd.DataFrame) – dask 集合。
iteration_range (Tuple[int | integer, int | integer]) – 详情请参见 xgboost.Booster.predict()。
predict_type (str) – 详情请参见 xgboost.Booster.inplace_predict()。
missing (float) – 输入数据中需要作为缺失值存在的值。如果为 None，则默认为 np.nan。
base_margin (da.Array | dd.DataFrame | dd.Series | None) –
See xgboost.DMatrix for details.

Added in version 1.4.0.
strict_shape (bool) – 详情请参阅 xgboost.Booster.predict()。 .. versionadded:: 1.4.0
validate_features (bool)

返回:

当输入数据是 dask.array.Array 时，返回值是一个数组；当输入数据是 dask.dataframe.DataFrame 时，返回值可以是 dask.dataframe.Series 或 dask.dataframe.DataFrame，具体取决于输出形状。

返回类型:

prediction

class xgboost.dask.DaskXGBClassifier(max_depth=None, max_leaves=None, max_bin=None, grow_policy=None, learning_rate=None, n_estimators=None, verbosity=None, objective=None, booster=None, tree_method=None, n_jobs=None, gamma=None, min_child_weight=None, max_delta_step=None, subsample=None, sampling_method=None, colsample_bytree=None, colsample_bylevel=None, colsample_bynode=None, reg_alpha=None, reg_lambda=None, scale_pos_weight=None, base_score=None, random_state=None, missing=nan, num_parallel_tree=None, monotone_constraints=None, interaction_constraints=None, importance_type=None, device=None, validate_parameters=None, enable_categorical=False, feature_types=None, max_cat_to_onehot=None, max_cat_threshold=None, multi_strategy=None, eval_metric=None, early_stopping_rounds=None, callbacks=None, **kwargs)[源代码]

基类：DaskScikitLearnBase, ClassifierMixin

XGBoost 分类的 scikit-learn API 实现。更多信息请参见使用 Scikit-Learn 估计器接口。

参数:

n_estimators (Optional[int]) – 梯度提升树的数量。等同于提升轮数。
max_depth (Optional[int]) – 基学习器的最大树深度。
max_leaves (Optional[int]) – 最大叶子数；0 表示无限制。
max_bin (Optional[int]) – 如果使用基于直方图的算法，每个特征的最大箱数
grow_policy (Optional[str]) – 树生长策略。 - depthwise: 倾向于在离节点最近的节点进行分割， - lossguide: 倾向于在损失变化最大的节点进行分割。
learning_rate (Optional[float]) – 提升学习率（xgb 的“eta”）
verbosity (Optional[int]) – 冗长程度。有效值为 0（静默） - 3（调试）。
objective (Union[str, xgboost.sklearn._SklObjWProto, Callable[[Any, Any], Tuple[numpy.ndarray, numpy.ndarray]], NoneType]) – 指定学习任务以及相应的学习目标或自定义目标函数。对于自定义目标，请参阅自定义目标和评估指标和自定义目标和指标以获取更多信息，以及函数签名的结尾注释。
booster (Optional[str]) – 指定使用哪个增强器：gbtree、gblinear 或 dart。
tree_method (Optional[str]) – 指定要使用的树方法。默认为自动。如果此参数设置为默认，XGBoost 将选择最保守的可用选项。建议从参数文档中研究此选项树方法
n_jobs (Optional[int]) – 用于运行 xgboost 的并行线程数。当与其他 Scikit-Learn 算法（如网格搜索）一起使用时，您可以选择并行化哪个算法并平衡线程。创建线程争用将显著减慢两个算法。
gamma (Optional[float]) – (min_split_loss) 在树的叶节点上进行进一步分区所需的最小损失减少量。
min_child_weight (Optional[float]) – 子节点中所需的实例权重（Hessian）的最小和。
max_delta_step (Optional[float]) – 我们允许每棵树的权重估计的最大增量步长。
subsample (Optional[float]) – 训练实例的子样本比例。
sampling_method (Optional[str]) – 采样方法。仅由 hist 树方法的 GPU 版本使用。 - uniform: 均匀选择随机训练实例。 - gradient_based: 当梯度和 Hessian 较大时，以更高概率选择随机训练实例。（参见 CatBoost）
colsample_bytree (Optional[float]) – 构建每棵树时列的子样本比例。
colsample_bylevel (Optional[float]) – 每个级别的列子样本比率。
colsample_bynode (Optional[float]) – 每次分割的列子样本比例。
reg_alpha (Optional[float]) – 权重的L1正则化项（xgb的alpha）。
reg_lambda (Optional[float]) – 权重上的L2正则化项（xgb的lambda）。
scale_pos_weight (Optional[float]) – 正负权重的平衡。
base_score (Optional[float]) – 所有实例的初始预测分数，全局偏置。
random_state (Union[numpy.random.mtrand.RandomState, numpy.random._generator.Generator, int, NoneType]) – 随机数种子。 .. 注意:: 使用 shotgun updater 的 gblinear booster 是非确定性的，因为它使用了 Hogwild 算法。
missing (float) – 数据中需要作为缺失值存在的值。默认为 numpy.nan。
num_parallel_tree (Optional[int]) – 用于增强随机森林。
monotone_constraints (Union[Dict[str, int], str, NoneType]) – 变量单调性的约束。更多信息请参见教程。
interaction_constraints (Union[str, List[Tuple[str]], NoneType]) – 表示允许交互的约束条件。约束条件必须以嵌套列表的形式指定，例如 [[0, 1], [2, 3, 4]]，其中每个内部列表是一组允许相互交互的特征索引。更多信息请参见教程。
importance_type (Optional[str]) – 特征重要性类型用于feature_importances_属性： * 对于树模型，可以是”gain”、”weight”、”cover”、”total_gain”或”total_cover”。 * 对于线性模型，仅定义了”weight”，它是无偏差的归一化系数。
device (Optional[str]) –

Added in version 2.0.0.

设备序号，可用选项为 cpu、cuda 和 gpu。
validate_parameters (Optional[bool]) – 对未知参数发出警告。
enable_categorical (bool) – 详情请参见 DMatrix 的相同参数。
feature_types (Optional[Sequence[str]]) –

Added in version 1.7.0.

用于指定特征类型而不构建数据框。详情请参见 DMatrix。
max_cat_to_onehot (Optional[int]) –

Added in version 1.6.0.

备注

此参数为实验性

决定XGBoost是否应使用独热编码进行分类数据分割的阈值。当类别数量小于阈值时，选择独热编码，否则类别将被分割到子节点中。此外，需要设置 enable_categorical 以支持分类特征。详情请参见分类数据和分类特征的参数。
max_cat_threshold (Optional[int]) –

Added in version 1.7.0.

备注

此参数为实验性

每个分割考虑的最大类别数。仅用于基于分区的分割，以防止过拟合。此外，enable_categorical 需要设置为支持分类特征。详情请参见分类数据和分类特征的参数。
multi_strategy (Optional[str]) –

Added in version 2.0.0.

备注

此参数正在开发中。

用于训练多目标模型的策略，包括多目标回归和多类分类。更多信息请参见多重输出。
- one_output_per_tree: 每个目标一个模型。
- multi_output_tree: 使用多目标树。
eval_metric (Union[str, List[str], Callable, NoneType]) –

Added in version 1.6.0.

用于监控训练结果和提前停止的指标。它可以是一个字符串或字符串列表，作为XGBoost中预定义指标的名称（参见doc/parameter.rst），也可以是 sklearn.metrics 中的一个指标，或者是任何其他类似于 sklearn.metrics 的用户定义指标。

如果提供了自定义目标，那么自定义指标应实现相应的反向链接函数。

与 scikit-learn 中常用的 scoring 参数不同，当提供一个可调用对象时，它被假定为一个成本函数，默认情况下 XGBoost 将在早停期间最小化结果。

For advanced usage on Early stopping like directly choosing to maximize instead of minimize, see xgboost.callback.EarlyStopping.

更多信息请参见自定义目标和评估指标和自定义目标和指标。
```
from sklearn.datasets import load_diabetes
from sklearn.metrics import mean_absolute_error
X, y = load_diabetes(return_X_y=True)
reg = xgb.XGBRegressor(
    tree_method="hist",
    eval_metric=mean_absolute_error,
)
reg.fit(X, y, eval_set=[(X, y)])
```
early_stopping_rounds (Optional[int]) –

Added in version 1.6.0.
- 激活早停机制。验证指标需要在每 early_stopping_rounds 轮中至少改善一次以继续训练。这需要在 fit() 中至少有一个 eval_set 项。
- 如果发生早停，模型将有两个额外的属性：best_score 和 best_iteration。这些属性用于 predict() 和 apply() 方法，以在推理过程中确定最佳的树的数量。如果用户想要访问完整的模型（包括早停后构建的树），他们可以在这些推理方法中指定 iteration_range。此外，其他实用工具如模型绘图也可以使用整个模型。
- 如果你倾向于在 best_iteration 之后丢弃树，可以考虑使用回调函数 xgboost.callback.EarlyStopping。
- 如果 eval_set 中有多个项目，最后一个条目将用于提前停止。如果 eval_metric 中有多个指标，最后一个指标将用于提前停止。
callbacks (Optional[List[xgboost.callback.TrainingCallback]]) – 在每次迭代结束时应用的回调函数列表。可以通过使用回调 API 来使用预定义的回调。 .. 注意:
kwargs (Optional[Any]) – XGBoost Booster对象的关键字参数。参数的完整文档可以在这里找到。尝试通过构造函数参数和 **kwargs 字典同时设置参数将导致 TypeError。 .. 注意:: **kwargs 不支持 scikit-learn **kwargs 不被 scikit-learn 支持。我们不保证通过此参数传递的参数会与 scikit-learn 正确交互。

apply(X, iteration_range=None)

返回每个样本在每棵树上的预测叶子。如果模型是使用早期停止训练的，那么会自动使用 best_iteration。

参数:

X (array_like, shape=[n_samples, n_features]) – 输入特征矩阵。
iteration_range (Tuple[int | integer, int | integer] | None) – 参见 predict()。

返回:

X_leaves – 对于 X 中的每个数据点 x 和每棵树，返回 x 最终所在的叶子的索引。叶子在 [0; 2**(self.max_depth+1)) 范围内编号，编号中可能存在间隙。

返回类型:

array_like, shape=[n_samples, n_trees]

property best_iteration: int: 通过早期停止获得的最佳迭代。此属性是基于0的，例如，如果最佳迭代是第一轮，那么 best_iteration 为 0。

property best_score: float: 通过早期停止获得的最佳分数。

property client: distributed.Client: 在此模型中使用的 dask 客户端。Client 对象不能被序列化以进行传输，因此如果任务是从工作进程而不是直接从客户端进程启动的，则需要在该工作进程中设置此属性。

property coef_: ndarray

Coefficients 属性

备注

系数仅针对线性学习器定义

系数仅在选择线性模型作为基础学习器时定义（booster=gblinear）。对于其他基础学习器类型，如树学习器（booster=gbtree），则未定义。

返回:: coef_
返回类型:: 形状为 [n_features] 或 [n_classes, n_features] 的数组

evals_result()

返回评估结果。

如果将 eval_set 传递给 fit() 函数，你可以调用 evals_result() 来获取所有传递的 eval_sets 的评估结果。当 eval_metric 也被传递给 fit() 函数时，evals_result 将包含传递给 fit() 函数的 eval_metrics。

返回的评估结果是一个字典：

{'validation_0': {'logloss': ['0.604835', '0.531479']},
 'validation_1': {'logloss': ['0.41965', '0.17686']}}

返回类型:: evals_result

property feature_importances_: ndarray

特征重要性属性，返回结果取决于 importance_type 参数。当模型使用多类/多标签/多目标数据集训练时，特征重要性是“平均”所有目标的。“平均”是基于重要性类型定义的。例如，如果重要性类型是“total_gain”，那么分数是所有树中每个分裂的损失变化的总和。

返回:

feature_importances_ (形状为 [n_features] 的数组，多类情况除外)
线性模型，返回形状为 (n_features, n_classes) 的数组

property feature_names_in_: ndarray: 在 fit() 过程中看到的特征名称。仅当 X 的特征名称均为字符串时定义。

fit(X, y, *, sample_weight=None, base_margin=None, eval_set=None, verbose=True, xgb_model=None, sample_weight_eval_set=None, base_margin_eval_set=None, feature_weights=None)[源代码]

拟合梯度提升模型。

请注意，多次调用 fit() 将导致模型对象从头开始重新拟合。要从之前的检查点恢复训练，请显式传递 xgb_model 参数。

参数:

X (da.Array | dd.DataFrame) – 功能矩阵。查看各种 XGBoost 函数支持的数据结构以获取支持的类型列表。当 tree_method 设置为 hist 时，内部将使用 QuantileDMatrix 而不是 DMatrix 以节省内存。然而，当输入数据的设备与算法不匹配时，这会影响性能。例如，如果输入是CPU上的numpy数组，但训练使用 cuda，则数据首先在CPU上处理，然后传输到GPU。
y (da.Array | dd.DataFrame | dd.Series) – 标签
sample_weight (da.Array | dd.DataFrame | dd.Series | None) – 实例权重
base_margin (da.Array | dd.DataFrame | dd.Series | None) – 每个实例的全局偏差。详情请参见拦截。
eval_set (Sequence[Tuple[da.Array | dd.DataFrame | dd.Series, da.Array | dd.DataFrame | dd.Series]] | None) – 用于作为验证集的 (X, y) 元组对列表，将计算这些验证集的指标。验证指标将帮助我们跟踪模型的性能。
verbose (int | bool) – 如果 verbose 为 True 并且使用了评估集，验证集上的评估指标会在每次提升阶段打印到标准输出。如果 verbose 是一个整数，评估指标会在每 verbose 次提升阶段打印。最后一次提升阶段或通过 early_stopping_rounds 找到的提升阶段也会被打印。
xgb_model (Booster | XGBModel | None) – 存储的XGBoost模型文件名或’Booster’实例 XGBoost模型，在训练前加载（允许训练继续）。
sample_weight_eval_set (Sequence[da.Array | dd.DataFrame | dd.Series] | None) – 形式为 [L_1, L_2, …, L_n] 的列表，其中每个 L_i 是一个类似数组的对象，存储第 i 个验证集的实例权重。
base_margin_eval_set (Sequence[da.Array | dd.DataFrame | dd.Series] | None) – 形式为 [M_1, M_2, …, M_n] 的列表，其中每个 M_i 是一个存储第 i 个验证集的基边界的类似数组的对象。
feature_weights (da.Array | dd.DataFrame | dd.Series | None) – 每个特征的权重，定义了在使用colsample时每个特征被选中的概率。所有值必须大于0，否则会抛出 ValueError。

返回类型:

DaskXGBClassifier

get_booster()

获取此模型的底层 xgboost Booster。

当未调用 fit 时，这将引发异常

返回:: booster
返回类型:: a xgboost booster of underlying model

get_metadata_routing()

获取此对象的元数据路由。

请查看用户指南以了解路由机制的工作原理。

返回:: routing – 一个封装了路由信息的 MetadataRequest。
返回类型:: MetadataRequest

get_num_boosting_rounds()

获取xgboost的增强轮数。

返回类型:: int

get_params(deep=True)

获取参数。

参数:: deep (bool)
返回类型:: Dict[str, Any]

get_xgb_params()

获取 xgboost 特定的参数。

返回类型:: Dict[str, Any]

property intercept_: ndarray

截距（偏差）属性

对于基于树的模型，返回值是 base_score。

返回:: 拦截_
返回类型:: 形状为 (1,) 或 [n_classes] 的数组

load_model(fname)

从文件或字节数组加载模型。

模型以XGBoost内部格式保存，该格式在各种XGBoost接口中通用。Python Booster对象的辅助属性（如feature_names）仅在使用JSON或UBJSON（默认）格式时保存。更多信息请参见模型IO。

model.load_model("model.json")
# or
model.load_model("model.ubj")

参数:: fname (str | bytearray | PathLike) – 输入文件名或内存缓冲区（另见 save_raw）
返回类型:: None

property n_features_in_: int: 在 fit() 期间看到的特征数量。

predict(X, output_margin=False, validate_features=True, base_margin=None, iteration_range=None)

使用 X 进行预测。如果模型是使用早期停止训练的，那么会自动使用 best_iteration。估计器默认使用 inplace_predict，如果数据和估计器之间的设备不匹配，则会回退到使用 DMatrix。

备注

此函数仅对 gbtree 和 dart 线程安全。

参数:

X (da.Array | dd.DataFrame) – 用于预测的数据。
output_margin (bool) – 是否输出未经转换的原始边距值。
validate_features (bool) – 当此项为 True 时，验证 Booster 和数据的 feature_names 是否相同。否则，假设 feature_names 是相同的。
base_margin (da.Array | dd.DataFrame | dd.Series | None) – 每个实例的全局偏差。详情请参见拦截。
iteration_range (Tuple[int | integer, int | integer] | None) – 指定用于预测的树层。例如，如果一个随机森林经过100轮训练。指定 iteration_range=(10, 20)，那么只有在此期间[10, 20)（半开集）轮次内构建的森林用于此次预测。 .. versionadded:: 1.4.0

返回类型:

prediction

predict_proba(X, validate_features=True, base_margin=None, iteration_range=None)[源代码]

预测每个 X 样本属于给定类别的概率。如果模型是使用早停法训练的，那么会自动使用 best_iteration。估计器默认使用 inplace_predict，如果数据和估计器之间的设备不匹配，则会回退到使用 DMatrix。

备注

此函数仅对 gbtree 和 dart 线程安全。

参数:

X (da.Array | dd.DataFrame | dd.Series) – 功能矩阵。查看各种 XGBoost 函数支持的数据结构以获取支持的类型列表。
validate_features (bool) – 当此项为 True 时，验证 Booster 和数据的 feature_names 是否相同。否则，假设 feature_names 是相同的。
base_margin (da.Array | dd.DataFrame | dd.Series | None) – 每个实例的全局偏差。详情请参见拦截。
iteration_range (Tuple[int | integer, int | integer] | None) – 指定在预测中使用哪一层树。例如，如果一个随机森林被训练了100轮。指定 iteration_range=(10, 20)，那么只有在这 [10, 20)（半开区间）轮中构建的森林被用于此次预测。

返回:

一个形状为 (n_samples, n_classes) 的 numpy 数组，表示每个数据样本属于某一类的概率。

返回类型:

prediction

save_model(fname)

将模型保存到文件中。

模型以XGBoost内部格式保存，该格式在各种XGBoost接口中通用。Python Booster对象的辅助属性（如feature_names）仅在使用JSON或UBJSON（默认）格式时保存。更多信息请参见模型IO。

model.save_model("model.json")
# or
model.save_model("model.ubj")

参数:: fname (str | PathLike) – 输出文件名
返回类型:: None

score(X, y, sample_weight=None)

返回给定测试数据和标签的平均准确率。

在多标签分类中，这是子集准确率，这是一个严格的度量标准，因为你要求每个样本的每个标签集都被正确预测。

参数:

X (array-like of shape (n_samples, n_features)) – 测试样本。
y (array-like of shape (n_samples,) or (n_samples, n_outputs)) – X 的真实标签。
sample_weight (array-like of shape (n_samples,), default=None) – 样本权重。

返回:

score – self.predict(X) 相对于 y 的平均准确率。

返回类型:

set_fit_request(*, base_margin='$UNCHANGED$', base_margin_eval_set='$UNCHANGED$', eval_set='$UNCHANGED$', feature_weights='$UNCHANGED$', sample_weight='$UNCHANGED$', sample_weight_eval_set='$UNCHANGED$', verbose='$UNCHANGED$', xgb_model='$UNCHANGED$')

传递给 fit 方法的请求元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config()）。请参阅用户指南了解路由机制的工作原理。

每个参数的选项是：

True: 请求元数据，并在提供时传递给 fit。如果未提供元数据，则忽略该请求。
False: 不请求元数据，元估计器不会将其传递给 fit。
None: 不需要元数据，如果用户提供了元数据，元估计器将引发错误。
str: 元数据应使用此给定别名传递给元估计器，而不是原始名称。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你更改某些参数的请求，而不更改其他参数。

Added in version 1.3.

备注

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用。否则它不会有任何效果。

参数:

base_margin (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 base_margin 参数的元数据路由。
base_margin_eval_set (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 base_margin_eval_set 参数的元数据路由。
eval_set (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 eval_set 参数的元数据路由。
feature_weights (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 feature_weights 参数的元数据路由。
sample_weight (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 sample_weight 参数的元数据路由。
sample_weight_eval_set (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 sample_weight_eval_set 参数的元数据路由。
verbose (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 verbose 参数的元数据路由。
xgb_model (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 xgb_model 参数的元数据路由。
self (DaskXGBClassifier)

返回:

self – 更新后的对象。

返回类型:

set_params(**params)

设置此估计器的参数。修改了 sklearn 方法以允许未知的 kwargs。这允许使用在 sklearn 网格搜索中未定义为成员变量的 xgboost 参数的完整范围。

返回类型:: self
参数:: params (Any)

set_predict_proba_request(*, base_margin='$UNCHANGED$', iteration_range='$UNCHANGED$', validate_features='$UNCHANGED$')

传递给 predict_proba 方法的请求元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config()）。请参阅用户指南了解路由机制的工作原理。

每个参数的选项是：

True: 请求元数据，并在提供时传递给 predict_proba。如果未提供元数据，则忽略该请求。
False: 不请求元数据，元估计器不会将其传递给 predict_proba。
None: 不需要元数据，如果用户提供了元数据，元估计器将引发错误。
str: 元数据应使用此给定别名传递给元估计器，而不是原始名称。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你更改某些参数的请求，而不更改其他参数。

Added in version 1.3.

备注

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用。否则它不会有任何效果。

参数:

base_margin (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict_proba 中 base_margin 参数的元数据路由。
iteration_range (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict_proba 中 iteration_range 参数的元数据路由。
validate_features (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict_proba 中的 validate_features 参数的元数据路由。
self (DaskXGBClassifier)

返回:

self – 更新后的对象。

返回类型:

set_predict_request(*, base_margin='$UNCHANGED$', iteration_range='$UNCHANGED$', output_margin='$UNCHANGED$', validate_features='$UNCHANGED$')

传递给 predict 方法的请求元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config()）。请参阅用户指南了解路由机制的工作原理。

每个参数的选项是：

True: 请求元数据，并在提供时传递给 predict。如果未提供元数据，则忽略请求。
False: 不请求元数据，元估计器不会将其传递给 predict。
None: 不需要元数据，如果用户提供了元数据，元估计器将引发错误。
str: 元数据应使用此给定别名传递给元估计器，而不是原始名称。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你更改某些参数的请求，而不更改其他参数。

Added in version 1.3.

备注

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用。否则它不会有任何效果。

参数:

base_margin (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 base_margin 参数的元数据路由。
iteration_range (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 iteration_range 参数的元数据路由。
output_margin (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 output_margin 参数的元数据路由。
validate_features (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 validate_features 参数的元数据路由。
self (DaskXGBClassifier)

返回:

self – 更新后的对象。

返回类型:

set_score_request(*, sample_weight='$UNCHANGED$')

传递给 score 方法的请求元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config()）。请参阅用户指南了解路由机制的工作原理。

每个参数的选项是：

True: 请求元数据，并在提供时传递给 score。如果未提供元数据，则忽略请求。
False: 不需要元数据，元估计器不会将其传递给 score。
None: 不需要元数据，如果用户提供了元数据，元估计器将引发错误。
str: 元数据应使用此给定别名传递给元估计器，而不是原始名称。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你更改某些参数的请求，而不更改其他参数。

Added in version 1.3.

备注

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用。否则它不会有任何效果。

参数:

sample_weight (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – score 方法中 sample_weight 参数的元数据路由。
self (DaskXGBClassifier)

返回:

self – 更新后的对象。

返回类型:

class xgboost.dask.DaskXGBRegressor(max_depth=None, max_leaves=None, max_bin=None, grow_policy=None, learning_rate=None, n_estimators=None, verbosity=None, objective=None, booster=None, tree_method=None, n_jobs=None, gamma=None, min_child_weight=None, max_delta_step=None, subsample=None, sampling_method=None, colsample_bytree=None, colsample_bylevel=None, colsample_bynode=None, reg_alpha=None, reg_lambda=None, scale_pos_weight=None, base_score=None, random_state=None, missing=nan, num_parallel_tree=None, monotone_constraints=None, interaction_constraints=None, importance_type=None, device=None, validate_parameters=None, enable_categorical=False, feature_types=None, max_cat_to_onehot=None, max_cat_threshold=None, multi_strategy=None, eval_metric=None, early_stopping_rounds=None, callbacks=None, **kwargs)[源代码]

基类：DaskScikitLearnBase, RegressorMixin

XGBoost 的 Scikit-Learn API 实现。更多信息请参见使用 Scikit-Learn 估计器接口。

参数:

n_estimators (Optional[int]) – 梯度提升树的数量。等同于提升轮数。
max_depth (Optional[int]) – 基学习器的最大树深度。
max_leaves (Optional[int]) – 最大叶子数；0 表示无限制。
max_bin (Optional[int]) – 如果使用基于直方图的算法，每个特征的最大箱数
grow_policy (Optional[str]) – 树生长策略。 - depthwise: 倾向于在离节点最近的节点进行分割， - lossguide: 倾向于在损失变化最大的节点进行分割。
learning_rate (Optional[float]) – 提升学习率（xgb 的“eta”）
verbosity (Optional[int]) – 冗长程度。有效值为 0（静默） - 3（调试）。
objective (Union[str, xgboost.sklearn._SklObjWProto, Callable[[Any, Any], Tuple[numpy.ndarray, numpy.ndarray]], NoneType]) – 指定学习任务以及相应的学习目标或自定义目标函数。对于自定义目标，请参阅自定义目标和评估指标和自定义目标和指标以获取更多信息，以及函数签名的结尾注释。
booster (Optional[str]) – 指定使用哪个增强器：gbtree、gblinear 或 dart。
tree_method (Optional[str]) – 指定要使用的树方法。默认为自动。如果此参数设置为默认，XGBoost 将选择最保守的可用选项。建议从参数文档中研究此选项树方法
n_jobs (Optional[int]) – 用于运行 xgboost 的并行线程数。当与其他 Scikit-Learn 算法（如网格搜索）一起使用时，您可以选择并行化哪个算法并平衡线程。创建线程争用将显著减慢两个算法。
gamma (Optional[float]) – (min_split_loss) 在树的叶节点上进行进一步分区所需的最小损失减少量。
min_child_weight (Optional[float]) – 子节点中所需的实例权重（Hessian）的最小和。
max_delta_step (Optional[float]) – 我们允许每棵树的权重估计的最大增量步长。
subsample (Optional[float]) – 训练实例的子样本比例。
sampling_method (Optional[str]) – 采样方法。仅由 hist 树方法的 GPU 版本使用。 - uniform: 均匀选择随机训练实例。 - gradient_based: 当梯度和 Hessian 较大时，以更高概率选择随机训练实例。（参见 CatBoost）
colsample_bytree (Optional[float]) – 构建每棵树时列的子样本比例。
colsample_bylevel (Optional[float]) – 每个级别的列子样本比率。
colsample_bynode (Optional[float]) – 每次分割的列子样本比例。
reg_alpha (Optional[float]) – 权重的L1正则化项（xgb的alpha）。
reg_lambda (Optional[float]) – 权重上的L2正则化项（xgb的lambda）。
scale_pos_weight (Optional[float]) – 正负权重的平衡。
base_score (Optional[float]) – 所有实例的初始预测分数，全局偏置。
random_state (Union[numpy.random.mtrand.RandomState, numpy.random._generator.Generator, int, NoneType]) – 随机数种子。 .. 注意:: 使用 shotgun updater 的 gblinear booster 是非确定性的，因为它使用了 Hogwild 算法。
missing (float) – 数据中需要作为缺失值存在的值。默认为 numpy.nan。
num_parallel_tree (Optional[int]) – 用于增强随机森林。
monotone_constraints (Union[Dict[str, int], str, NoneType]) – 变量单调性的约束。更多信息请参见教程。
interaction_constraints (Union[str, List[Tuple[str]], NoneType]) – 表示允许交互的约束条件。约束条件必须以嵌套列表的形式指定，例如 [[0, 1], [2, 3, 4]]，其中每个内部列表是一组允许相互交互的特征索引。更多信息请参见教程。
importance_type (Optional[str]) – 特征重要性类型用于feature_importances_属性： * 对于树模型，可以是”gain”、”weight”、”cover”、”total_gain”或”total_cover”。 * 对于线性模型，仅定义了”weight”，它是无偏差的归一化系数。
device (Optional[str]) –

Added in version 2.0.0.

设备序号，可用选项为 cpu、cuda 和 gpu。
validate_parameters (Optional[bool]) – 对未知参数发出警告。
enable_categorical (bool) – 详情请参见 DMatrix 的相同参数。
feature_types (Optional[Sequence[str]]) –

Added in version 1.7.0.

用于指定特征类型而不构建数据框。详情请参见 DMatrix。
max_cat_to_onehot (Optional[int]) –

Added in version 1.6.0.

备注

此参数为实验性

决定XGBoost是否应使用独热编码进行分类数据分割的阈值。当类别数量小于阈值时，选择独热编码，否则类别将被分割到子节点中。此外，需要设置 enable_categorical 以支持分类特征。详情请参见分类数据和分类特征的参数。
max_cat_threshold (Optional[int]) –

Added in version 1.7.0.

备注

此参数为实验性

每个分割考虑的最大类别数。仅用于基于分区的分割，以防止过拟合。此外，enable_categorical 需要设置为支持分类特征。详情请参见分类数据和分类特征的参数。
multi_strategy (Optional[str]) –

Added in version 2.0.0.

备注

此参数正在开发中。

用于训练多目标模型的策略，包括多目标回归和多类分类。更多信息请参见多重输出。
- one_output_per_tree: 每个目标一个模型。
- multi_output_tree: 使用多目标树。
eval_metric (Union[str, List[str], Callable, NoneType]) –

Added in version 1.6.0.

用于监控训练结果和提前停止的指标。它可以是一个字符串或字符串列表，作为XGBoost中预定义指标的名称（参见doc/parameter.rst），也可以是 sklearn.metrics 中的一个指标，或者是任何其他类似于 sklearn.metrics 的用户定义指标。

如果提供了自定义目标，那么自定义指标应实现相应的反向链接函数。

与 scikit-learn 中常用的 scoring 参数不同，当提供一个可调用对象时，它被假定为一个成本函数，默认情况下 XGBoost 将在早停期间最小化结果。

For advanced usage on Early stopping like directly choosing to maximize instead of minimize, see xgboost.callback.EarlyStopping.

更多信息请参见自定义目标和评估指标和自定义目标和指标。
```
from sklearn.datasets import load_diabetes
from sklearn.metrics import mean_absolute_error
X, y = load_diabetes(return_X_y=True)
reg = xgb.XGBRegressor(
    tree_method="hist",
    eval_metric=mean_absolute_error,
)
reg.fit(X, y, eval_set=[(X, y)])
```
early_stopping_rounds (Optional[int]) –

Added in version 1.6.0.
- 激活早停机制。验证指标需要在每 early_stopping_rounds 轮中至少改善一次以继续训练。这需要在 fit() 中至少有一个 eval_set 项。
- 如果发生早停，模型将有两个额外的属性：best_score 和 best_iteration。这些属性用于 predict() 和 apply() 方法，以在推理过程中确定最佳的树的数量。如果用户想要访问完整的模型（包括早停后构建的树），他们可以在这些推理方法中指定 iteration_range。此外，其他实用工具如模型绘图也可以使用整个模型。
- 如果你倾向于在 best_iteration 之后丢弃树，可以考虑使用回调函数 xgboost.callback.EarlyStopping。
- 如果 eval_set 中有多个项目，最后一个条目将用于提前停止。如果 eval_metric 中有多个指标，最后一个指标将用于提前停止。
callbacks (Optional[List[xgboost.callback.TrainingCallback]]) – 在每次迭代结束时应用的回调函数列表。可以通过使用回调 API 来使用预定义的回调。 .. 注意:
kwargs (Optional[Any]) – XGBoost Booster对象的关键字参数。参数的完整文档可以在这里找到。尝试通过构造函数参数和 **kwargs 字典同时设置参数将导致 TypeError。 .. 注意:: **kwargs 不支持 scikit-learn **kwargs 不被 scikit-learn 支持。我们不保证通过此参数传递的参数会与 scikit-learn 正确交互。

apply(X, iteration_range=None)

返回每个样本在每棵树上的预测叶子。如果模型是使用早期停止训练的，那么会自动使用 best_iteration。

参数:

X (array_like, shape=[n_samples, n_features]) – 输入特征矩阵。
iteration_range (Tuple[int | integer, int | integer] | None) – 参见 predict()。

返回:

X_leaves – 对于 X 中的每个数据点 x 和每棵树，返回 x 最终所在的叶子的索引。叶子在 [0; 2**(self.max_depth+1)) 范围内编号，编号中可能存在间隙。

返回类型:

array_like, shape=[n_samples, n_trees]

property best_iteration: int: 通过早期停止获得的最佳迭代。此属性是基于0的，例如，如果最佳迭代是第一轮，那么 best_iteration 为 0。

property best_score: float: 通过早期停止获得的最佳分数。

property client: distributed.Client: 在此模型中使用的 dask 客户端。Client 对象不能被序列化以进行传输，因此如果任务是从工作进程而不是直接从客户端进程启动的，则需要在该工作进程中设置此属性。

property coef_: ndarray

Coefficients 属性

备注

系数仅针对线性学习器定义

系数仅在选择线性模型作为基础学习器时定义（booster=gblinear）。对于其他基础学习器类型，如树学习器（booster=gbtree），则未定义。

返回:: coef_
返回类型:: 形状为 [n_features] 或 [n_classes, n_features] 的数组

evals_result()

返回评估结果。

如果将 eval_set 传递给 fit() 函数，你可以调用 evals_result() 来获取所有传递的 eval_sets 的评估结果。当 eval_metric 也被传递给 fit() 函数时，evals_result 将包含传递给 fit() 函数的 eval_metrics。

返回的评估结果是一个字典：

{'validation_0': {'logloss': ['0.604835', '0.531479']},
 'validation_1': {'logloss': ['0.41965', '0.17686']}}

返回类型:: evals_result

property feature_importances_: ndarray

特征重要性属性，返回结果取决于 importance_type 参数。当模型使用多类/多标签/多目标数据集训练时，特征重要性是“平均”所有目标的。“平均”是基于重要性类型定义的。例如，如果重要性类型是“total_gain”，那么分数是所有树中每个分裂的损失变化的总和。

返回:

feature_importances_ (形状为 [n_features] 的数组，多类情况除外)
线性模型，返回形状为 (n_features, n_classes) 的数组

property feature_names_in_: ndarray: 在 fit() 过程中看到的特征名称。仅当 X 的特征名称均为字符串时定义。

fit(X, y, *, sample_weight=None, base_margin=None, eval_set=None, verbose=True, xgb_model=None, sample_weight_eval_set=None, base_margin_eval_set=None, feature_weights=None)[源代码]

拟合梯度提升模型。

请注意，多次调用 fit() 将导致模型对象从头开始重新拟合。要从之前的检查点恢复训练，请显式传递 xgb_model 参数。

参数:

X (da.Array | dd.DataFrame) – 功能矩阵。查看各种 XGBoost 函数支持的数据结构以获取支持的类型列表。当 tree_method 设置为 hist 时，内部将使用 QuantileDMatrix 而不是 DMatrix 以节省内存。然而，当输入数据的设备与算法不匹配时，这会影响性能。例如，如果输入是CPU上的numpy数组，但训练使用 cuda，则数据首先在CPU上处理，然后传输到GPU。
y (da.Array | dd.DataFrame | dd.Series) – 标签
sample_weight (da.Array | dd.DataFrame | dd.Series | None) – 实例权重
base_margin (da.Array | dd.DataFrame | dd.Series | None) – 每个实例的全局偏差。详情请参见拦截。
eval_set (Sequence[Tuple[da.Array | dd.DataFrame | dd.Series, da.Array | dd.DataFrame | dd.Series]] | None) – 用于作为验证集的 (X, y) 元组对列表，将计算这些验证集的指标。验证指标将帮助我们跟踪模型的性能。
verbose (int | bool) – 如果 verbose 为 True 并且使用了评估集，验证集上的评估指标会在每次提升阶段打印到标准输出。如果 verbose 是一个整数，评估指标会在每 verbose 次提升阶段打印。最后一次提升阶段或通过 early_stopping_rounds 找到的提升阶段也会被打印。
xgb_model (Booster | XGBModel | None) – 存储的XGBoost模型文件名或’Booster’实例 XGBoost模型，在训练前加载（允许训练继续）。
sample_weight_eval_set (Sequence[da.Array | dd.DataFrame | dd.Series] | None) – 形式为 [L_1, L_2, …, L_n] 的列表，其中每个 L_i 是一个类似数组的对象，存储第 i 个验证集的实例权重。
base_margin_eval_set (Sequence[da.Array | dd.DataFrame | dd.Series] | None) – 形式为 [M_1, M_2, …, M_n] 的列表，其中每个 M_i 是一个存储第 i 个验证集的基边界的类似数组的对象。
feature_weights (da.Array | dd.DataFrame | dd.Series | None) – 每个特征的权重，定义了在使用colsample时每个特征被选中的概率。所有值必须大于0，否则会抛出 ValueError。

返回类型:

DaskXGBRegressor

get_booster()

获取此模型的底层 xgboost Booster。

当未调用 fit 时，这将引发异常

返回:: booster
返回类型:: a xgboost booster of underlying model

get_metadata_routing()

获取此对象的元数据路由。

请查看用户指南以了解路由机制的工作原理。

返回:: routing – 一个封装了路由信息的 MetadataRequest。
返回类型:: MetadataRequest

get_num_boosting_rounds()

获取xgboost的增强轮数。

返回类型:: int

get_params(deep=True)

获取参数。

参数:: deep (bool)
返回类型:: Dict[str, Any]

get_xgb_params()

获取 xgboost 特定的参数。

返回类型:: Dict[str, Any]

property intercept_: ndarray

截距（偏差）属性

对于基于树的模型，返回值是 base_score。

返回:: 拦截_
返回类型:: 形状为 (1,) 或 [n_classes] 的数组

load_model(fname)

从文件或字节数组加载模型。

模型以XGBoost内部格式保存，该格式在各种XGBoost接口中通用。Python Booster对象的辅助属性（如feature_names）仅在使用JSON或UBJSON（默认）格式时保存。更多信息请参见模型IO。

model.load_model("model.json")
# or
model.load_model("model.ubj")

参数:: fname (str | bytearray | PathLike) – 输入文件名或内存缓冲区（另见 save_raw）
返回类型:: None

property n_features_in_: int: 在 fit() 期间看到的特征数量。

predict(X, output_margin=False, validate_features=True, base_margin=None, iteration_range=None)

使用 X 进行预测。如果模型是使用早期停止训练的，那么会自动使用 best_iteration。估计器默认使用 inplace_predict，如果数据和估计器之间的设备不匹配，则会回退到使用 DMatrix。

备注

此函数仅对 gbtree 和 dart 线程安全。

参数:

X (da.Array | dd.DataFrame) – 用于预测的数据。
output_margin (bool) – 是否输出未经转换的原始边距值。
validate_features (bool) – 当此项为 True 时，验证 Booster 和数据的 feature_names 是否相同。否则，假设 feature_names 是相同的。
base_margin (da.Array | dd.DataFrame | dd.Series | None) – 每个实例的全局偏差。详情请参见拦截。
iteration_range (Tuple[int | integer, int | integer] | None) – 指定用于预测的树层。例如，如果一个随机森林经过100轮训练。指定 iteration_range=(10, 20)，那么只有在此期间[10, 20)（半开集）轮次内构建的森林用于此次预测。 .. versionadded:: 1.4.0

返回类型:

prediction

save_model(fname)

将模型保存到文件中。

模型以XGBoost内部格式保存，该格式在各种XGBoost接口中通用。Python Booster对象的辅助属性（如feature_names）仅在使用JSON或UBJSON（默认）格式时保存。更多信息请参见模型IO。

model.save_model("model.json")
# or
model.save_model("model.ubj")

参数:: fname (str | PathLike) – 输出文件名
返回类型:: None

score(X, y, sample_weight=None)

返回预测的决定系数。

决定系数 $R^2$ 定义为 $(1 - \frac{u}{v})$，其中 $u$ 是残差平方和 ((y_true - y_pred)** 2).sum()，而 $v$ 是总平方和 ((y_true - y_true.mean()) ** 2).sum()。最佳可能的分数是 1.0，它也可能是负数（因为模型可能任意地差）。一个总是预测 y 的期望值的常数模型，忽略输入特征，将得到一个 $R^2$ 分数为 0.0。

参数:

X (array-like of shape (n_samples, n_features)) – 测试样本。对于某些估计器，这可能是一个预计算的核矩阵，或者是一个形状为 (n_samples, n_samples_fitted) 的通用对象列表，其中 n_samples_fitted 是用于估计器拟合的样本数量。
y (array-like of shape (n_samples,) or (n_samples, n_outputs)) – X 的真值。
sample_weight (array-like of shape (n_samples,), default=None) – 样本权重。

返回:

score – self.predict(X) 相对于 y 的 $R^2$。

返回类型:

备注

在调用回归器的 score 时使用的 $R^2$ 评分，从版本 0.23 开始使用 multioutput='uniform_average' 以保持与 r2_score() 的默认值一致。这会影响所有多输出回归器的 score 方法（除了 MultiOutputRegressor）。

set_fit_request(*, base_margin='$UNCHANGED$', base_margin_eval_set='$UNCHANGED$', eval_set='$UNCHANGED$', feature_weights='$UNCHANGED$', sample_weight='$UNCHANGED$', sample_weight_eval_set='$UNCHANGED$', verbose='$UNCHANGED$', xgb_model='$UNCHANGED$')

传递给 fit 方法的请求元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config()）。请参阅用户指南了解路由机制的工作原理。

每个参数的选项是：

True: 请求元数据，并在提供时传递给 fit。如果未提供元数据，则忽略该请求。
False: 不请求元数据，元估计器不会将其传递给 fit。
None: 不需要元数据，如果用户提供了元数据，元估计器将引发错误。
str: 元数据应使用此给定别名传递给元估计器，而不是原始名称。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你更改某些参数的请求，而不更改其他参数。

Added in version 1.3.

备注

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用。否则它不会有任何效果。

参数:

base_margin (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 base_margin 参数的元数据路由。
base_margin_eval_set (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 base_margin_eval_set 参数的元数据路由。
eval_set (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 eval_set 参数的元数据路由。
feature_weights (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 feature_weights 参数的元数据路由。
sample_weight (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 sample_weight 参数的元数据路由。
sample_weight_eval_set (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 sample_weight_eval_set 参数的元数据路由。
verbose (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 verbose 参数的元数据路由。
xgb_model (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 xgb_model 参数的元数据路由。
self (DaskXGBRegressor)

返回:

self – 更新后的对象。

返回类型:

set_params(**params)

设置此估计器的参数。修改了 sklearn 方法以允许未知的 kwargs。这允许使用在 sklearn 网格搜索中未定义为成员变量的 xgboost 参数的完整范围。

返回类型:: self
参数:: params (Any)

set_predict_request(*, base_margin='$UNCHANGED$', iteration_range='$UNCHANGED$', output_margin='$UNCHANGED$', validate_features='$UNCHANGED$')

传递给 predict 方法的请求元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config()）。请参阅用户指南了解路由机制的工作原理。

每个参数的选项是：

True: 请求元数据，并在提供时传递给 predict。如果未提供元数据，则忽略请求。
False: 不请求元数据，元估计器不会将其传递给 predict。
None: 不需要元数据，如果用户提供了元数据，元估计器将引发错误。
str: 元数据应使用此给定别名传递给元估计器，而不是原始名称。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你更改某些参数的请求，而不更改其他参数。

Added in version 1.3.

备注

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用。否则它不会有任何效果。

参数:

base_margin (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 base_margin 参数的元数据路由。
iteration_range (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 iteration_range 参数的元数据路由。
output_margin (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 output_margin 参数的元数据路由。
validate_features (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 validate_features 参数的元数据路由。
self (DaskXGBRegressor)

返回:

self – 更新后的对象。

返回类型:

set_score_request(*, sample_weight='$UNCHANGED$')

传递给 score 方法的请求元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config()）。请参阅用户指南了解路由机制的工作原理。

每个参数的选项是：

True: 请求元数据，并在提供时传递给 score。如果未提供元数据，则忽略请求。
False: 不需要元数据，元估计器不会将其传递给 score。
None: 不需要元数据，如果用户提供了元数据，元估计器将引发错误。
str: 元数据应使用此给定别名传递给元估计器，而不是原始名称。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你更改某些参数的请求，而不更改其他参数。

Added in version 1.3.

备注

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用。否则它不会有任何效果。

参数:

sample_weight (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – score 方法中 sample_weight 参数的元数据路由。
self (DaskXGBRegressor)

返回:

self – 更新后的对象。

返回类型:

class xgboost.dask.DaskXGBRanker(*, objective='rank:pairwise', **kwargs)[源代码]

基类：DaskScikitLearnBase, XGBRankerMixIn

XGBoost 排名的 Scikit-Learn API 实现。

Added in version 1.4.0.

更多信息请参见使用 Scikit-Learn 估计器接口。

参数:

n_estimators (Optional[int]) – 梯度提升树的数量。等同于提升轮数。
max_depth (Optional[int]) – 基学习器的最大树深度。
max_leaves (Optional[int]) – 最大叶子数；0 表示无限制。
max_bin (Optional[int]) – 如果使用基于直方图的算法，每个特征的最大箱数
grow_policy (Optional[str]) – 树生长策略。 - depthwise: 倾向于在离节点最近的节点进行分割， - lossguide: 倾向于在损失变化最大的节点进行分割。
learning_rate (Optional[float]) – 提升学习率（xgb 的“eta”）
verbosity (Optional[int]) – 冗长程度。有效值为 0（静默） - 3（调试）。
objective (Union[str, xgboost.sklearn._SklObjWProto, Callable[[Any, Any], Tuple[numpy.ndarray, numpy.ndarray]], NoneType]) – 指定学习任务以及相应的学习目标或自定义目标函数。对于自定义目标，请参阅自定义目标和评估指标和自定义目标和指标以获取更多信息，以及函数签名的结尾注释。
booster (Optional[str]) – 指定使用哪个增强器：gbtree、gblinear 或 dart。
tree_method (Optional[str]) – 指定要使用的树方法。默认为自动。如果此参数设置为默认，XGBoost 将选择最保守的可用选项。建议从参数文档中研究此选项树方法
n_jobs (Optional[int]) – 用于运行 xgboost 的并行线程数。当与其他 Scikit-Learn 算法（如网格搜索）一起使用时，您可以选择并行化哪个算法并平衡线程。创建线程争用将显著减慢两个算法。
gamma (Optional[float]) – (min_split_loss) 在树的叶节点上进行进一步分区所需的最小损失减少量。
min_child_weight (Optional[float]) – 子节点中所需的实例权重（Hessian）的最小和。
max_delta_step (Optional[float]) – 我们允许每棵树的权重估计的最大增量步长。
subsample (Optional[float]) – 训练实例的子样本比例。
sampling_method (Optional[str]) – 采样方法。仅由 hist 树方法的 GPU 版本使用。 - uniform: 均匀选择随机训练实例。 - gradient_based: 当梯度和 Hessian 较大时，以更高概率选择随机训练实例。（参见 CatBoost）
colsample_bytree (Optional[float]) – 构建每棵树时列的子样本比例。
colsample_bylevel (Optional[float]) – 每个级别的列子样本比率。
colsample_bynode (Optional[float]) – 每次分割的列子样本比例。
reg_alpha (Optional[float]) – 权重的L1正则化项（xgb的alpha）。
reg_lambda (Optional[float]) – 权重上的L2正则化项（xgb的lambda）。
scale_pos_weight (Optional[float]) – 正负权重的平衡。
base_score (Optional[float]) – 所有实例的初始预测分数，全局偏置。
random_state (Union[numpy.random.mtrand.RandomState, numpy.random._generator.Generator, int, NoneType]) – 随机数种子。 .. 注意:: 使用 shotgun updater 的 gblinear booster 是非确定性的，因为它使用了 Hogwild 算法。
missing (float) – 数据中需要作为缺失值存在的值。默认为 numpy.nan。
num_parallel_tree (Optional[int]) – 用于增强随机森林。
monotone_constraints (Union[Dict[str, int], str, NoneType]) – 变量单调性的约束。更多信息请参见教程。
interaction_constraints (Union[str, List[Tuple[str]], NoneType]) – 表示允许交互的约束条件。约束条件必须以嵌套列表的形式指定，例如 [[0, 1], [2, 3, 4]]，其中每个内部列表是一组允许相互交互的特征索引。更多信息请参见教程。
importance_type (Optional[str]) – 特征重要性类型用于feature_importances_属性： * 对于树模型，可以是”gain”、”weight”、”cover”、”total_gain”或”total_cover”。 * 对于线性模型，仅定义了”weight”，它是无偏差的归一化系数。
device (Optional[str]) –

Added in version 2.0.0.

设备序号，可用选项为 cpu、cuda 和 gpu。
validate_parameters (Optional[bool]) – 对未知参数发出警告。
enable_categorical (bool) – 详情请参见 DMatrix 的相同参数。
feature_types (Optional[Sequence[str]]) –

Added in version 1.7.0.

用于指定特征类型而不构建数据框。详情请参见 DMatrix。
max_cat_to_onehot (Optional[int]) –

Added in version 1.6.0.

备注

此参数为实验性

决定XGBoost是否应使用独热编码进行分类数据分割的阈值。当类别数量小于阈值时，选择独热编码，否则类别将被分割到子节点中。此外，需要设置 enable_categorical 以支持分类特征。详情请参见分类数据和分类特征的参数。
max_cat_threshold (Optional[int]) –

Added in version 1.7.0.

备注

此参数为实验性

每个分割考虑的最大类别数。仅用于基于分区的分割，以防止过拟合。此外，enable_categorical 需要设置为支持分类特征。详情请参见分类数据和分类特征的参数。
multi_strategy (Optional[str]) –

Added in version 2.0.0.

备注

此参数正在开发中。

用于训练多目标模型的策略，包括多目标回归和多类分类。更多信息请参见多重输出。
- one_output_per_tree: 每个目标一个模型。
- multi_output_tree: 使用多目标树。
eval_metric (Union[str, List[str], Callable, NoneType]) –

Added in version 1.6.0.

用于监控训练结果和提前停止的指标。它可以是一个字符串或字符串列表，作为XGBoost中预定义指标的名称（参见doc/parameter.rst），也可以是 sklearn.metrics 中的一个指标，或者是任何其他类似于 sklearn.metrics 的用户定义指标。

如果提供了自定义目标，那么自定义指标应实现相应的反向链接函数。

与 scikit-learn 中常用的 scoring 参数不同，当提供一个可调用对象时，它被假定为一个成本函数，默认情况下 XGBoost 将在早停期间最小化结果。

For advanced usage on Early stopping like directly choosing to maximize instead of minimize, see xgboost.callback.EarlyStopping.

更多信息请参见自定义目标和评估指标和自定义目标和指标。
```
from sklearn.datasets import load_diabetes
from sklearn.metrics import mean_absolute_error
X, y = load_diabetes(return_X_y=True)
reg = xgb.XGBRegressor(
    tree_method="hist",
    eval_metric=mean_absolute_error,
)
reg.fit(X, y, eval_set=[(X, y)])
```
early_stopping_rounds (Optional[int]) –

Added in version 1.6.0.
- 激活早停机制。验证指标需要在每 early_stopping_rounds 轮中至少改善一次以继续训练。这需要在 fit() 中至少有一个 eval_set 项。
- 如果发生早停，模型将有两个额外的属性：best_score 和 best_iteration。这些属性用于 predict() 和 apply() 方法，以在推理过程中确定最佳的树的数量。如果用户想要访问完整的模型（包括早停后构建的树），他们可以在这些推理方法中指定 iteration_range。此外，其他实用工具如模型绘图也可以使用整个模型。
- 如果你倾向于在 best_iteration 之后丢弃树，可以考虑使用回调函数 xgboost.callback.EarlyStopping。
- 如果 eval_set 中有多个项目，最后一个条目将用于提前停止。如果 eval_metric 中有多个指标，最后一个指标将用于提前停止。
callbacks (Optional[List[xgboost.callback.TrainingCallback]]) – 在每次迭代结束时应用的回调函数列表。可以通过使用回调 API 来使用预定义的回调。 .. 注意:
kwargs (Optional[Any]) – XGBoost Booster对象的关键字参数。参数的完整文档可以在:doc:`这里 </parameter>`找到。尝试通过构造函数参数和**kwargs字典同时设置参数将导致TypeError。 .. 注意:: **kwargs 不支持 scikit-learn **kwargs 不被 scikit-learn 支持。我们不保证通过此参数传递的参数能与 scikit-learn 正确交互。 .. 注意:: 对于 dask 实现，group 不被支持，请使用 qid 代替。

apply(X, iteration_range=None)

返回每个样本在每棵树上的预测叶子。如果模型是使用早期停止训练的，那么会自动使用 best_iteration。

参数:

X (array_like, shape=[n_samples, n_features]) – 输入特征矩阵。
iteration_range (Tuple[int | integer, int | integer] | None) – 参见 predict()。

返回:

X_leaves – 对于 X 中的每个数据点 x 和每棵树，返回 x 最终所在的叶子的索引。叶子在 [0; 2**(self.max_depth+1)) 范围内编号，编号中可能存在间隙。

返回类型:

array_like, shape=[n_samples, n_trees]

property best_iteration: int: 通过早期停止获得的最佳迭代。此属性是基于0的，例如，如果最佳迭代是第一轮，那么 best_iteration 为 0。

property best_score: float: 通过早期停止获得的最佳分数。

property client: distributed.Client: 在此模型中使用的 dask 客户端。Client 对象不能被序列化以进行传输，因此如果任务是从工作进程而不是直接从客户端进程启动的，则需要在该工作进程中设置此属性。

property coef_: ndarray

Coefficients 属性

备注

系数仅针对线性学习器定义

系数仅在选择线性模型作为基础学习器时定义（booster=gblinear）。对于其他基础学习器类型，如树学习器（booster=gbtree），则未定义。

返回:: coef_
返回类型:: 形状为 [n_features] 或 [n_classes, n_features] 的数组

evals_result()

返回评估结果。

如果将 eval_set 传递给 fit() 函数，你可以调用 evals_result() 来获取所有传递的 eval_sets 的评估结果。当 eval_metric 也被传递给 fit() 函数时，evals_result 将包含传递给 fit() 函数的 eval_metrics。

返回的评估结果是一个字典：

{'validation_0': {'logloss': ['0.604835', '0.531479']},
 'validation_1': {'logloss': ['0.41965', '0.17686']}}

返回类型:: evals_result

property feature_importances_: ndarray

特征重要性属性，返回结果取决于 importance_type 参数。当模型使用多类/多标签/多目标数据集训练时，特征重要性是“平均”所有目标的。“平均”是基于重要性类型定义的。例如，如果重要性类型是“total_gain”，那么分数是所有树中每个分裂的损失变化的总和。

返回:

feature_importances_ (形状为 [n_features] 的数组，多类情况除外)
线性模型，返回形状为 (n_features, n_classes) 的数组

property feature_names_in_: ndarray: 在 fit() 过程中看到的特征名称。仅当 X 的特征名称均为字符串时定义。

fit(X, y, *, group=None, qid=None, sample_weight=None, base_margin=None, eval_set=None, eval_group=None, eval_qid=None, verbose=False, xgb_model=None, sample_weight_eval_set=None, base_margin_eval_set=None, feature_weights=None)[源代码]

拟合梯度提升排序器

请注意，多次调用 fit() 将导致模型对象从头开始重新拟合。要从之前的检查点恢复训练，请显式传递 xgb_model 参数。

参数:

X (da.Array | dd.DataFrame) – 功能矩阵。有关支持的类型列表，请参阅各种 XGBoost 函数支持的数据结构。当这是一个 pandas.DataFrame 或 cudf.DataFrame 时，它可能包含一个名为 qid 的特殊列，用于指定查询索引。使用特殊列与使用 qid 参数相同，只是它与 sklearn 实用函数（如 sklearn.model_selection.cross_validation()）兼容。同样的约定适用于 XGBRanker.score() 和 XGBRanker.predict() 。 +—–+—————-+—————-+ | qid | feat_0 | feat_1 | +—–+—————-+—————-+ | 0 | $x_{00}$ | $x_{01}$ | +—–+—————-+—————-+ | 1 | $x_{10}$ | $x_{11}$ | +—–+—————-+—————-+ | 1 | $x_{20}$ | $x_{21}$ | +—–+—————-+—————-+ 当 tree_method 设置为 hist 时，内部将使用 QuantileDMatrix 而不是 DMatrix 以节省内存。然而，当输入数据的设备与算法不匹配时，这会影响性能。例如，如果输入是 CPU 上的 numpy 数组，但训练使用 cuda ，则数据首先在 CPU 上处理，然后传输到 GPU。
y (da.Array | dd.DataFrame | dd.Series) – 标签
group (da.Array | dd.DataFrame | dd.Series | None) – 训练数据中每个查询组的大小。应该有与训练数据中查询组数量相同的元素。如果设置为 None，则用户必须提供 qid。
qid (da.Array | dd.DataFrame | dd.Series | None) – 每个训练样本的查询ID。应具有n_samples的大小。如果设置为None，则用户必须提供组或X中的特殊列。
sample_weight (da.Array | dd.DataFrame | dd.Series | None) –
查询组权重

备注

权重是针对排名任务的每个组别

在排序任务中，每个查询组/ID分配一个权重（而不是每个数据点）。这是因为我们只关心每个组内数据点的相对顺序，因此为单个数据点分配权重是没有意义的。
base_margin (da.Array | dd.DataFrame | dd.Series | None) – 每个实例的全局偏差。详情请参见拦截。
eval_set (Sequence[Tuple[da.Array | dd.DataFrame | dd.Series, da.Array | dd.DataFrame | dd.Series]] | None) – 用于作为验证集的 (X, y) 元组对列表，将计算这些验证集的指标。验证指标将帮助我们跟踪模型的性能。
eval_group (Sequence[da.Array | dd.DataFrame | dd.Series] | None) – 一个列表，其中 eval_group[i] 是包含 eval_set 中第 i 对所有查询组大小的列表。
eval_qid (Sequence[da.Array | dd.DataFrame | dd.Series] | None) – 一个列表，其中 eval_qid[i] 是包含 eval_set 中第 i 对的查询 ID 的数组。X 中的特殊列约定同样适用于验证数据集。
verbose (int | bool) – 如果 verbose 为 True 并且使用了评估集，验证集上的评估指标会在每次提升阶段打印到标准输出。如果 verbose 是一个整数，评估指标会在每 verbose 次提升阶段打印。最后一次提升阶段或通过 early_stopping_rounds 找到的提升阶段也会被打印。
xgb_model (Booster | XGBModel | None) – 存储的XGBoost模型文件名或’Booster’实例 XGBoost模型，在训练前加载（允许训练继续）。
sample_weight_eval_set (Sequence[da.Array | dd.DataFrame | dd.Series] | None) – 形式为 [L_1, L_2, …, L_n] 的列表，其中每个 L_i 是第 i 个验证集上的组权重列表。 .. 注意:: 权重是按组分配的，用于排名任务在排名任务中，每个查询组分配一个权重（而不是每个数据点）。这是因为我们只关心每个组内数据点的相对顺序，因此为单个数据点分配权重是没有意义的。
base_margin_eval_set (Sequence[da.Array | dd.DataFrame | dd.Series] | None) – 形式为 [M_1, M_2, …, M_n] 的列表，其中每个 M_i 是一个存储第 i 个验证集的基边界的类似数组的对象。
feature_weights (da.Array | dd.DataFrame | dd.Series | None) – 每个特征的权重，定义了在使用colsample时每个特征被选中的概率。所有值必须大于0，否则会抛出 ValueError。

返回类型:

DaskXGBRanker

get_booster()

获取此模型的底层 xgboost Booster。

当未调用 fit 时，这将引发异常

返回:: booster
返回类型:: a xgboost booster of underlying model

get_metadata_routing()

获取此对象的元数据路由。

请查看用户指南以了解路由机制的工作原理。

返回:: routing – 一个封装了路由信息的 MetadataRequest。
返回类型:: MetadataRequest

get_num_boosting_rounds()

获取xgboost的增强轮数。

返回类型:: int

get_params(deep=True)

获取参数。

参数:: deep (bool)
返回类型:: Dict[str, Any]

get_xgb_params()

获取 xgboost 特定的参数。

返回类型:: Dict[str, Any]

property intercept_: ndarray

截距（偏差）属性

对于基于树的模型，返回值是 base_score。

返回:: 拦截_
返回类型:: 形状为 (1,) 或 [n_classes] 的数组

load_model(fname)

从文件或字节数组加载模型。

模型以XGBoost内部格式保存，该格式在各种XGBoost接口中通用。Python Booster对象的辅助属性（如feature_names）仅在使用JSON或UBJSON（默认）格式时保存。更多信息请参见模型IO。

model.load_model("model.json")
# or
model.load_model("model.ubj")

参数:: fname (str | bytearray | PathLike) – 输入文件名或内存缓冲区（另见 save_raw）
返回类型:: None

property n_features_in_: int: 在 fit() 期间看到的特征数量。

predict(X, output_margin=False, validate_features=True, base_margin=None, iteration_range=None)

使用 X 进行预测。如果模型是使用早期停止训练的，那么会自动使用 best_iteration。估计器默认使用 inplace_predict，如果数据和估计器之间的设备不匹配，则会回退到使用 DMatrix。

备注

此函数仅对 gbtree 和 dart 线程安全。

参数:

X (da.Array | dd.DataFrame) – 用于预测的数据。
output_margin (bool) – 是否输出未经转换的原始边距值。
validate_features (bool) – 当此项为 True 时，验证 Booster 和数据的 feature_names 是否相同。否则，假设 feature_names 是相同的。
base_margin (da.Array | dd.DataFrame | dd.Series | None) – 每个实例的全局偏差。详情请参见拦截。
iteration_range (Tuple[int | integer, int | integer] | None) – 指定用于预测的树层。例如，如果一个随机森林经过100轮训练。指定 iteration_range=(10, 20)，那么只有在此期间[10, 20)（半开集）轮次内构建的森林用于此次预测。 .. versionadded:: 1.4.0

返回类型:

prediction

save_model(fname)

将模型保存到文件中。

模型以XGBoost内部格式保存，该格式在各种XGBoost接口中通用。Python Booster对象的辅助属性（如feature_names）仅在使用JSON或UBJSON（默认）格式时保存。更多信息请参见模型IO。

model.save_model("model.json")
# or
model.save_model("model.ubj")

参数:: fname (str | PathLike) – 输出文件名
返回类型:: None

set_fit_request(*, base_margin='$UNCHANGED$', base_margin_eval_set='$UNCHANGED$', eval_group='$UNCHANGED$', eval_qid='$UNCHANGED$', eval_set='$UNCHANGED$', feature_weights='$UNCHANGED$', group='$UNCHANGED$', qid='$UNCHANGED$', sample_weight='$UNCHANGED$', sample_weight_eval_set='$UNCHANGED$', verbose='$UNCHANGED$', xgb_model='$UNCHANGED$')

传递给 fit 方法的请求元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config()）。请参阅用户指南了解路由机制的工作原理。

每个参数的选项是：

True: 请求元数据，并在提供时传递给 fit。如果未提供元数据，则忽略该请求。
False: 不请求元数据，元估计器不会将其传递给 fit。
None: 不需要元数据，如果用户提供了元数据，元估计器将引发错误。
str: 元数据应使用此给定别名传递给元估计器，而不是原始名称。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你更改某些参数的请求，而不更改其他参数。

Added in version 1.3.

备注

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用。否则它不会有任何效果。

参数:

base_margin (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 base_margin 参数的元数据路由。
base_margin_eval_set (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 base_margin_eval_set 参数的元数据路由。
eval_group (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 中 eval_group 参数的元数据路由。
eval_qid (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 eval_qid 参数的元数据路由。
eval_set (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 eval_set 参数的元数据路由。
feature_weights (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 feature_weights 参数的元数据路由。
group (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 中 group 参数的元数据路由。
qid (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 中 qid 参数的元数据路由。
sample_weight (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 sample_weight 参数的元数据路由。
sample_weight_eval_set (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 sample_weight_eval_set 参数的元数据路由。
verbose (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 verbose 参数的元数据路由。
xgb_model (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 xgb_model 参数的元数据路由。
self (DaskXGBRanker)

返回:

self – 更新后的对象。

返回类型:

set_params(**params)

设置此估计器的参数。修改了 sklearn 方法以允许未知的 kwargs。这允许使用在 sklearn 网格搜索中未定义为成员变量的 xgboost 参数的完整范围。

返回类型:: self
参数:: params (Any)

set_predict_request(*, base_margin='$UNCHANGED$', iteration_range='$UNCHANGED$', output_margin='$UNCHANGED$', validate_features='$UNCHANGED$')

传递给 predict 方法的请求元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config()）。请参阅用户指南了解路由机制的工作原理。

每个参数的选项是：

True: 请求元数据，并在提供时传递给 predict。如果未提供元数据，则忽略请求。
False: 不请求元数据，元估计器不会将其传递给 predict。
None: 不需要元数据，如果用户提供了元数据，元估计器将引发错误。
str: 元数据应使用此给定别名传递给元估计器，而不是原始名称。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你更改某些参数的请求，而不更改其他参数。

Added in version 1.3.

备注

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用。否则它不会有任何效果。

参数:

base_margin (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 base_margin 参数的元数据路由。
iteration_range (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 iteration_range 参数的元数据路由。
output_margin (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 output_margin 参数的元数据路由。
validate_features (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 validate_features 参数的元数据路由。
self (DaskXGBRanker)

返回:

self – 更新后的对象。

返回类型:

class xgboost.dask.DaskXGBRFRegressor(*, learning_rate=1, subsample=0.8, colsample_bynode=0.8, reg_lambda=1e-05, **kwargs)[源代码]

基类：DaskXGBRegressor

为 XGBoost 随机森林回归器实现 Scikit-Learn API。

Added in version 1.4.0.

更多信息请参见使用 Scikit-Learn 估计器接口。

参数:

n_estimators (int) – 随机森林中拟合的树的数量。
max_depth (Optional[int]) – 基学习器的最大树深度。
max_leaves (Optional[int]) – 最大叶子数；0 表示无限制。
max_bin (Optional[int]) – 如果使用基于直方图的算法，每个特征的最大箱数
grow_policy (Optional[str]) – 树生长策略。 - depthwise: 倾向于在离节点最近的节点进行分割， - lossguide: 倾向于在损失变化最大的节点进行分割。
learning_rate (Optional[float]) – 提升学习率（xgb 的“eta”）
verbosity (Optional[int]) – 冗长程度。有效值为 0（静默） - 3（调试）。
objective (Union[str, xgboost.sklearn._SklObjWProto, Callable[[Any, Any], Tuple[numpy.ndarray, numpy.ndarray]], NoneType]) – 指定学习任务以及相应的学习目标或自定义目标函数。对于自定义目标，请参阅自定义目标和评估指标和自定义目标和指标以获取更多信息，以及函数签名的结尾注释。
booster (Optional[str]) – 指定使用哪个增强器：gbtree、gblinear 或 dart。
tree_method (Optional[str]) – 指定要使用的树方法。默认为自动。如果此参数设置为默认，XGBoost 将选择最保守的可用选项。建议从参数文档中研究此选项树方法
n_jobs (Optional[int]) – 用于运行 xgboost 的并行线程数。当与其他 Scikit-Learn 算法（如网格搜索）一起使用时，您可以选择并行化哪个算法并平衡线程。创建线程争用将显著减慢两个算法。
gamma (Optional[float]) – (min_split_loss) 在树的叶节点上进行进一步分区所需的最小损失减少量。
min_child_weight (Optional[float]) – 子节点中所需的实例权重（Hessian）的最小和。
max_delta_step (Optional[float]) – 我们允许每棵树的权重估计的最大增量步长。
subsample (Optional[float]) – 训练实例的子样本比例。
sampling_method (Optional[str]) – 采样方法。仅由 hist 树方法的 GPU 版本使用。 - uniform: 均匀选择随机训练实例。 - gradient_based: 当梯度和 Hessian 较大时，以更高概率选择随机训练实例。（参见 CatBoost）
colsample_bytree (Optional[float]) – 构建每棵树时列的子样本比例。
colsample_bylevel (Optional[float]) – 每个级别的列子样本比率。
colsample_bynode (Optional[float]) – 每次分割的列子样本比例。
reg_alpha (Optional[float]) – 权重的L1正则化项（xgb的alpha）。
reg_lambda (Optional[float]) – 权重上的L2正则化项（xgb的lambda）。
scale_pos_weight (Optional[float]) – 正负权重的平衡。
base_score (Optional[float]) – 所有实例的初始预测分数，全局偏置。
random_state (Union[numpy.random.mtrand.RandomState, numpy.random._generator.Generator, int, NoneType]) – 随机数种子。 .. 注意:: 使用 shotgun updater 的 gblinear booster 是非确定性的，因为它使用了 Hogwild 算法。
missing (float) – 数据中需要作为缺失值存在的值。默认为 numpy.nan。
num_parallel_tree (Optional[int]) – 用于增强随机森林。
monotone_constraints (Union[Dict[str, int], str, NoneType]) – 变量单调性的约束。更多信息请参见教程。
interaction_constraints (Union[str, List[Tuple[str]], NoneType]) – 表示允许交互的约束条件。约束条件必须以嵌套列表的形式指定，例如 [[0, 1], [2, 3, 4]]，其中每个内部列表是一组允许相互交互的特征索引。更多信息请参见教程。
importance_type (Optional[str]) – 特征重要性类型用于feature_importances_属性： * 对于树模型，可以是”gain”、”weight”、”cover”、”total_gain”或”total_cover”。 * 对于线性模型，仅定义了”weight”，它是无偏差的归一化系数。
device (Optional[str]) –

Added in version 2.0.0.

设备序号，可用选项为 cpu、cuda 和 gpu。
validate_parameters (Optional[bool]) – 对未知参数发出警告。
enable_categorical (bool) – 详情请参见 DMatrix 的相同参数。
feature_types (Optional[Sequence[str]]) –

Added in version 1.7.0.

用于指定特征类型而不构建数据框。详情请参见 DMatrix。
max_cat_to_onehot (Optional[int]) –

Added in version 1.6.0.

备注

此参数为实验性

决定XGBoost是否应使用独热编码进行分类数据分割的阈值。当类别数量小于阈值时，选择独热编码，否则类别将被分割到子节点中。此外，需要设置 enable_categorical 以支持分类特征。详情请参见分类数据和分类特征的参数。
max_cat_threshold (Optional[int]) –

Added in version 1.7.0.

备注

此参数为实验性

每个分割考虑的最大类别数。仅用于基于分区的分割，以防止过拟合。此外，enable_categorical 需要设置为支持分类特征。详情请参见分类数据和分类特征的参数。
multi_strategy (Optional[str]) –

Added in version 2.0.0.

备注

此参数正在开发中。

用于训练多目标模型的策略，包括多目标回归和多类分类。更多信息请参见多重输出。
- one_output_per_tree: 每个目标一个模型。
- multi_output_tree: 使用多目标树。
eval_metric (Union[str, List[str], Callable, NoneType]) –

Added in version 1.6.0.

用于监控训练结果和提前停止的指标。它可以是一个字符串或字符串列表，作为XGBoost中预定义指标的名称（参见doc/parameter.rst），也可以是 sklearn.metrics 中的一个指标，或者是任何其他类似于 sklearn.metrics 的用户定义指标。

如果提供了自定义目标，那么自定义指标应实现相应的反向链接函数。

与 scikit-learn 中常用的 scoring 参数不同，当提供一个可调用对象时，它被假定为一个成本函数，默认情况下 XGBoost 将在早停期间最小化结果。

For advanced usage on Early stopping like directly choosing to maximize instead of minimize, see xgboost.callback.EarlyStopping.

更多信息请参见自定义目标和评估指标和自定义目标和指标。
```
from sklearn.datasets import load_diabetes
from sklearn.metrics import mean_absolute_error
X, y = load_diabetes(return_X_y=True)
reg = xgb.XGBRegressor(
    tree_method="hist",
    eval_metric=mean_absolute_error,
)
reg.fit(X, y, eval_set=[(X, y)])
```
early_stopping_rounds (Optional[int]) –

Added in version 1.6.0.
- 激活早停机制。验证指标需要在每 early_stopping_rounds 轮中至少改善一次以继续训练。这需要在 fit() 中至少有一个 eval_set 项。
- 如果发生早停，模型将有两个额外的属性：best_score 和 best_iteration。这些属性用于 predict() 和 apply() 方法，以在推理过程中确定最佳的树的数量。如果用户想要访问完整的模型（包括早停后构建的树），他们可以在这些推理方法中指定 iteration_range。此外，其他实用工具如模型绘图也可以使用整个模型。
- 如果你倾向于在 best_iteration 之后丢弃树，可以考虑使用回调函数 xgboost.callback.EarlyStopping。
- 如果 eval_set 中有多个项目，最后一个条目将用于提前停止。如果 eval_metric 中有多个指标，最后一个指标将用于提前停止。
callbacks (Optional[List[xgboost.callback.TrainingCallback]]) – 在每次迭代结束时应用的回调函数列表。可以通过使用回调 API 来使用预定义的回调。 .. 注意:
kwargs (Optional[Any]) – XGBoost Booster对象的关键字参数。参数的完整文档可以在这里找到。尝试通过构造函数参数和 **kwargs 字典同时设置参数将导致 TypeError。

apply(X, iteration_range=None)

返回每个样本在每棵树上的预测叶子。如果模型是使用早期停止训练的，那么会自动使用 best_iteration。

参数:

X (array_like, shape=[n_samples, n_features]) – 输入特征矩阵。
iteration_range (Tuple[int | integer, int | integer] | None) – 参见 predict()。

返回:

X_leaves – 对于 X 中的每个数据点 x 和每棵树，返回 x 最终所在的叶子的索引。叶子在 [0; 2**(self.max_depth+1)) 范围内编号，编号中可能存在间隙。

返回类型:

array_like, shape=[n_samples, n_trees]

property best_iteration: int: 通过早期停止获得的最佳迭代。此属性是基于0的，例如，如果最佳迭代是第一轮，那么 best_iteration 为 0。

property best_score: float: 通过早期停止获得的最佳分数。

property client: distributed.Client: 在此模型中使用的 dask 客户端。Client 对象不能被序列化以进行传输，因此如果任务是从工作进程而不是直接从客户端进程启动的，则需要在该工作进程中设置此属性。

property coef_: ndarray

Coefficients 属性

备注

系数仅针对线性学习器定义

系数仅在选择线性模型作为基础学习器时定义（booster=gblinear）。对于其他基础学习器类型，如树学习器（booster=gbtree），则未定义。

返回:: coef_
返回类型:: 形状为 [n_features] 或 [n_classes, n_features] 的数组

evals_result()

返回评估结果。

如果将 eval_set 传递给 fit() 函数，你可以调用 evals_result() 来获取所有传递的 eval_sets 的评估结果。当 eval_metric 也被传递给 fit() 函数时，evals_result 将包含传递给 fit() 函数的 eval_metrics。

返回的评估结果是一个字典：

{'validation_0': {'logloss': ['0.604835', '0.531479']},
 'validation_1': {'logloss': ['0.41965', '0.17686']}}

返回类型:: evals_result

property feature_importances_: ndarray

特征重要性属性，返回结果取决于 importance_type 参数。当模型使用多类/多标签/多目标数据集训练时，特征重要性是“平均”所有目标的。“平均”是基于重要性类型定义的。例如，如果重要性类型是“total_gain”，那么分数是所有树中每个分裂的损失变化的总和。

返回:

feature_importances_ (形状为 [n_features] 的数组，多类情况除外)
线性模型，返回形状为 (n_features, n_classes) 的数组

property feature_names_in_: ndarray: 在 fit() 过程中看到的特征名称。仅当 X 的特征名称均为字符串时定义。

fit(X, y, *, sample_weight=None, base_margin=None, eval_set=None, verbose=True, xgb_model=None, sample_weight_eval_set=None, base_margin_eval_set=None, feature_weights=None)[源代码]

拟合梯度提升模型。

请注意，多次调用 fit() 将导致模型对象从头开始重新拟合。要从之前的检查点恢复训练，请显式传递 xgb_model 参数。

参数:

X (da.Array | dd.DataFrame) – 功能矩阵。查看各种 XGBoost 函数支持的数据结构以获取支持的类型列表。当 tree_method 设置为 hist 时，内部将使用 QuantileDMatrix 而不是 DMatrix 以节省内存。然而，当输入数据的设备与算法不匹配时，这会影响性能。例如，如果输入是CPU上的numpy数组，但训练使用 cuda，则数据首先在CPU上处理，然后传输到GPU。
y (da.Array | dd.DataFrame | dd.Series) – 标签
sample_weight (da.Array | dd.DataFrame | dd.Series | None) – 实例权重
base_margin (da.Array | dd.DataFrame | dd.Series | None) – 每个实例的全局偏差。详情请参见拦截。
eval_set (Sequence[Tuple[da.Array | dd.DataFrame | dd.Series, da.Array | dd.DataFrame | dd.Series]] | None) – 用于作为验证集的 (X, y) 元组对列表，将计算这些验证集的指标。验证指标将帮助我们跟踪模型的性能。
verbose (int | bool) – 如果 verbose 为 True 并且使用了评估集，验证集上的评估指标会在每次提升阶段打印到标准输出。如果 verbose 是一个整数，评估指标会在每 verbose 次提升阶段打印。最后一次提升阶段或通过 early_stopping_rounds 找到的提升阶段也会被打印。
xgb_model (Booster | XGBModel | None) – 存储的XGBoost模型文件名或’Booster’实例 XGBoost模型，在训练前加载（允许训练继续）。
sample_weight_eval_set (Sequence[da.Array | dd.DataFrame | dd.Series] | None) – 形式为 [L_1, L_2, …, L_n] 的列表，其中每个 L_i 是一个类似数组的对象，存储第 i 个验证集的实例权重。
base_margin_eval_set (Sequence[da.Array | dd.DataFrame | dd.Series] | None) – 形式为 [M_1, M_2, …, M_n] 的列表，其中每个 M_i 是一个存储第 i 个验证集的基边界的类似数组的对象。
feature_weights (da.Array | dd.DataFrame | dd.Series | None) – 每个特征的权重，定义了在使用colsample时每个特征被选中的概率。所有值必须大于0，否则会抛出 ValueError。

返回类型:

DaskXGBRFRegressor

get_booster()

获取此模型的底层 xgboost Booster。

当未调用 fit 时，这将引发异常

返回:: booster
返回类型:: a xgboost booster of underlying model

get_metadata_routing()

获取此对象的元数据路由。

请查看用户指南以了解路由机制的工作原理。

返回:: routing – 一个封装了路由信息的 MetadataRequest。
返回类型:: MetadataRequest

get_num_boosting_rounds()[源代码]

获取xgboost的增强轮数。

返回类型:: int

get_params(deep=True)

获取参数。

参数:: deep (bool)
返回类型:: Dict[str, Any]

get_xgb_params()[源代码]

获取 xgboost 特定的参数。

返回类型:: Dict[str, Any]

property intercept_: ndarray

截距（偏差）属性

对于基于树的模型，返回值是 base_score。

返回:: 拦截_
返回类型:: 形状为 (1,) 或 [n_classes] 的数组

load_model(fname)

从文件或字节数组加载模型。

模型以XGBoost内部格式保存，该格式在各种XGBoost接口中通用。Python Booster对象的辅助属性（如feature_names）仅在使用JSON或UBJSON（默认）格式时保存。更多信息请参见模型IO。

model.load_model("model.json")
# or
model.load_model("model.ubj")

参数:: fname (str | bytearray | PathLike) – 输入文件名或内存缓冲区（另见 save_raw）
返回类型:: None

property n_features_in_: int: 在 fit() 期间看到的特征数量。

predict(X, output_margin=False, validate_features=True, base_margin=None, iteration_range=None)

使用 X 进行预测。如果模型是使用早期停止训练的，那么会自动使用 best_iteration。估计器默认使用 inplace_predict，如果数据和估计器之间的设备不匹配，则会回退到使用 DMatrix。

备注

此函数仅对 gbtree 和 dart 线程安全。

参数:

X (da.Array | dd.DataFrame) – 用于预测的数据。
output_margin (bool) – 是否输出未经转换的原始边距值。
validate_features (bool) – 当此项为 True 时，验证 Booster 和数据的 feature_names 是否相同。否则，假设 feature_names 是相同的。
base_margin (da.Array | dd.DataFrame | dd.Series | None) – 每个实例的全局偏差。详情请参见拦截。
iteration_range (Tuple[int | integer, int | integer] | None) – 指定用于预测的树层。例如，如果一个随机森林经过100轮训练。指定 iteration_range=(10, 20)，那么只有在此期间[10, 20)（半开集）轮次内构建的森林用于此次预测。 .. versionadded:: 1.4.0

返回类型:

prediction

save_model(fname)

将模型保存到文件中。

模型以XGBoost内部格式保存，该格式在各种XGBoost接口中通用。Python Booster对象的辅助属性（如feature_names）仅在使用JSON或UBJSON（默认）格式时保存。更多信息请参见模型IO。

model.save_model("model.json")
# or
model.save_model("model.ubj")

参数:: fname (str | PathLike) – 输出文件名
返回类型:: None

score(X, y, sample_weight=None)

返回预测的决定系数。

决定系数 $R^2$ 定义为 $(1 - \frac{u}{v})$，其中 $u$ 是残差平方和 ((y_true - y_pred)** 2).sum()，而 $v$ 是总平方和 ((y_true - y_true.mean()) ** 2).sum()。最佳可能的分数是 1.0，它也可能是负数（因为模型可能任意地差）。一个总是预测 y 的期望值的常数模型，忽略输入特征，将得到一个 $R^2$ 分数为 0.0。

参数:

X (array-like of shape (n_samples, n_features)) – 测试样本。对于某些估计器，这可能是一个预计算的核矩阵，或者是一个形状为 (n_samples, n_samples_fitted) 的通用对象列表，其中 n_samples_fitted 是用于估计器拟合的样本数量。
y (array-like of shape (n_samples,) or (n_samples, n_outputs)) – X 的真值。
sample_weight (array-like of shape (n_samples,), default=None) – 样本权重。

返回:

score – self.predict(X) 相对于 y 的 $R^2$。

返回类型:

备注

在调用回归器的 score 时使用的 $R^2$ 评分，从版本 0.23 开始使用 multioutput='uniform_average' 以保持与 r2_score() 的默认值一致。这会影响所有多输出回归器的 score 方法（除了 MultiOutputRegressor）。

set_fit_request(*, base_margin='$UNCHANGED$', base_margin_eval_set='$UNCHANGED$', eval_set='$UNCHANGED$', feature_weights='$UNCHANGED$', sample_weight='$UNCHANGED$', sample_weight_eval_set='$UNCHANGED$', verbose='$UNCHANGED$', xgb_model='$UNCHANGED$')

传递给 fit 方法的请求元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config()）。请参阅用户指南了解路由机制的工作原理。

每个参数的选项是：

True: 请求元数据，并在提供时传递给 fit。如果未提供元数据，则忽略该请求。
False: 不请求元数据，元估计器不会将其传递给 fit。
None: 不需要元数据，如果用户提供了元数据，元估计器将引发错误。
str: 元数据应使用此给定别名传递给元估计器，而不是原始名称。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你更改某些参数的请求，而不更改其他参数。

Added in version 1.3.

备注

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用。否则它不会有任何效果。

参数:

base_margin (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 base_margin 参数的元数据路由。
base_margin_eval_set (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 base_margin_eval_set 参数的元数据路由。
eval_set (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 eval_set 参数的元数据路由。
feature_weights (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 feature_weights 参数的元数据路由。
sample_weight (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 sample_weight 参数的元数据路由。
sample_weight_eval_set (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 sample_weight_eval_set 参数的元数据路由。
verbose (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 verbose 参数的元数据路由。
xgb_model (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 xgb_model 参数的元数据路由。
self (DaskXGBRFRegressor)

返回:

self – 更新后的对象。

返回类型:

set_params(**params)

设置此估计器的参数。修改了 sklearn 方法以允许未知的 kwargs。这允许使用在 sklearn 网格搜索中未定义为成员变量的 xgboost 参数的完整范围。

返回类型:: self
参数:: params (Any)

set_predict_request(*, base_margin='$UNCHANGED$', iteration_range='$UNCHANGED$', output_margin='$UNCHANGED$', validate_features='$UNCHANGED$')

传递给 predict 方法的请求元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config()）。请参阅用户指南了解路由机制的工作原理。

每个参数的选项是：

True: 请求元数据，并在提供时传递给 predict。如果未提供元数据，则忽略请求。
False: 不请求元数据，元估计器不会将其传递给 predict。
None: 不需要元数据，如果用户提供了元数据，元估计器将引发错误。
str: 元数据应使用此给定别名传递给元估计器，而不是原始名称。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你更改某些参数的请求，而不更改其他参数。

Added in version 1.3.

备注

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用。否则它不会有任何效果。

参数:

base_margin (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 base_margin 参数的元数据路由。
iteration_range (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 iteration_range 参数的元数据路由。
output_margin (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 output_margin 参数的元数据路由。
validate_features (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 validate_features 参数的元数据路由。
self (DaskXGBRFRegressor)

返回:

self – 更新后的对象。

返回类型:

set_score_request(*, sample_weight='$UNCHANGED$')

传递给 score 方法的请求元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config()）。请参阅用户指南了解路由机制的工作原理。

每个参数的选项是：

True: 请求元数据，并在提供时传递给 score。如果未提供元数据，则忽略请求。
False: 不需要元数据，元估计器不会将其传递给 score。
None: 不需要元数据，如果用户提供了元数据，元估计器将引发错误。
str: 元数据应使用此给定别名传递给元估计器，而不是原始名称。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你更改某些参数的请求，而不更改其他参数。

Added in version 1.3.

备注

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用。否则它不会有任何效果。

参数:

sample_weight (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – score 方法中 sample_weight 参数的元数据路由。
self (DaskXGBRFRegressor)

返回:

self – 更新后的对象。

返回类型:

class xgboost.dask.DaskXGBRFClassifier(*, learning_rate=1, subsample=0.8, colsample_bynode=0.8, reg_lambda=1e-05, **kwargs)[源代码]

基类：DaskXGBClassifier

XGBoost 随机森林分类器的 Scikit-Learn API 实现。

Added in version 1.4.0.

更多信息请参见使用 Scikit-Learn 估计器接口。

参数:

n_estimators (int) – 随机森林中拟合的树的数量。
max_depth (Optional[int]) – 基学习器的最大树深度。
max_leaves (Optional[int]) – 最大叶子数；0 表示无限制。
max_bin (Optional[int]) – 如果使用基于直方图的算法，每个特征的最大箱数
grow_policy (Optional[str]) – 树生长策略。 - depthwise: 倾向于在离节点最近的节点进行分割， - lossguide: 倾向于在损失变化最大的节点进行分割。
learning_rate (Optional[float]) – 提升学习率（xgb 的“eta”）
verbosity (Optional[int]) – 冗长程度。有效值为 0（静默） - 3（调试）。
objective (Union[str, xgboost.sklearn._SklObjWProto, Callable[[Any, Any], Tuple[numpy.ndarray, numpy.ndarray]], NoneType]) – 指定学习任务以及相应的学习目标或自定义目标函数。对于自定义目标，请参阅自定义目标和评估指标和自定义目标和指标以获取更多信息，以及函数签名的结尾注释。
booster (Optional[str]) – 指定使用哪个增强器：gbtree、gblinear 或 dart。
tree_method (Optional[str]) – 指定要使用的树方法。默认为自动。如果此参数设置为默认，XGBoost 将选择最保守的可用选项。建议从参数文档中研究此选项树方法
n_jobs (Optional[int]) – 用于运行 xgboost 的并行线程数。当与其他 Scikit-Learn 算法（如网格搜索）一起使用时，您可以选择并行化哪个算法并平衡线程。创建线程争用将显著减慢两个算法。
gamma (Optional[float]) – (min_split_loss) 在树的叶节点上进行进一步分区所需的最小损失减少量。
min_child_weight (Optional[float]) – 子节点中所需的实例权重（Hessian）的最小和。
max_delta_step (Optional[float]) – 我们允许每棵树的权重估计的最大增量步长。
subsample (Optional[float]) – 训练实例的子样本比例。
sampling_method (Optional[str]) – 采样方法。仅由 hist 树方法的 GPU 版本使用。 - uniform: 均匀选择随机训练实例。 - gradient_based: 当梯度和 Hessian 较大时，以更高概率选择随机训练实例。（参见 CatBoost）
colsample_bytree (Optional[float]) – 构建每棵树时列的子样本比例。
colsample_bylevel (Optional[float]) – 每个级别的列子样本比率。
colsample_bynode (Optional[float]) – 每次分割的列子样本比例。
reg_alpha (Optional[float]) – 权重的L1正则化项（xgb的alpha）。
reg_lambda (Optional[float]) – 权重上的L2正则化项（xgb的lambda）。
scale_pos_weight (Optional[float]) – 正负权重的平衡。
base_score (Optional[float]) – 所有实例的初始预测分数，全局偏置。
random_state (Union[numpy.random.mtrand.RandomState, numpy.random._generator.Generator, int, NoneType]) – 随机数种子。 .. 注意:: 使用 shotgun updater 的 gblinear booster 是非确定性的，因为它使用了 Hogwild 算法。
missing (float) – 数据中需要作为缺失值存在的值。默认为 numpy.nan。
num_parallel_tree (Optional[int]) – 用于增强随机森林。
monotone_constraints (Union[Dict[str, int], str, NoneType]) – 变量单调性的约束。更多信息请参见教程。
interaction_constraints (Union[str, List[Tuple[str]], NoneType]) – 表示允许交互的约束条件。约束条件必须以嵌套列表的形式指定，例如 [[0, 1], [2, 3, 4]]，其中每个内部列表是一组允许相互交互的特征索引。更多信息请参见教程。
importance_type (Optional[str]) – 特征重要性类型用于feature_importances_属性： * 对于树模型，可以是”gain”、”weight”、”cover”、”total_gain”或”total_cover”。 * 对于线性模型，仅定义了”weight”，它是无偏差的归一化系数。
device (Optional[str]) –

Added in version 2.0.0.

设备序号，可用选项为 cpu、cuda 和 gpu。
validate_parameters (Optional[bool]) – 对未知参数发出警告。
enable_categorical (bool) – 详情请参见 DMatrix 的相同参数。
feature_types (Optional[Sequence[str]]) –

Added in version 1.7.0.

用于指定特征类型而不构建数据框。详情请参见 DMatrix。
max_cat_to_onehot (Optional[int]) –

Added in version 1.6.0.

备注

此参数为实验性

决定XGBoost是否应使用独热编码进行分类数据分割的阈值。当类别数量小于阈值时，选择独热编码，否则类别将被分割到子节点中。此外，需要设置 enable_categorical 以支持分类特征。详情请参见分类数据和分类特征的参数。
max_cat_threshold (Optional[int]) –

Added in version 1.7.0.

备注

此参数为实验性

每个分割考虑的最大类别数。仅用于基于分区的分割，以防止过拟合。此外，enable_categorical 需要设置为支持分类特征。详情请参见分类数据和分类特征的参数。
multi_strategy (Optional[str]) –

Added in version 2.0.0.

备注

此参数正在开发中。

用于训练多目标模型的策略，包括多目标回归和多类分类。更多信息请参见多重输出。
- one_output_per_tree: 每个目标一个模型。
- multi_output_tree: 使用多目标树。
eval_metric (Union[str, List[str], Callable, NoneType]) –

Added in version 1.6.0.

用于监控训练结果和提前停止的指标。它可以是一个字符串或字符串列表，作为XGBoost中预定义指标的名称（参见doc/parameter.rst），也可以是 sklearn.metrics 中的一个指标，或者是任何其他类似于 sklearn.metrics 的用户定义指标。

如果提供了自定义目标，那么自定义指标应实现相应的反向链接函数。

与 scikit-learn 中常用的 scoring 参数不同，当提供一个可调用对象时，它被假定为一个成本函数，默认情况下 XGBoost 将在早停期间最小化结果。

For advanced usage on Early stopping like directly choosing to maximize instead of minimize, see xgboost.callback.EarlyStopping.

更多信息请参见自定义目标和评估指标和自定义目标和指标。
```
from sklearn.datasets import load_diabetes
from sklearn.metrics import mean_absolute_error
X, y = load_diabetes(return_X_y=True)
reg = xgb.XGBRegressor(
    tree_method="hist",
    eval_metric=mean_absolute_error,
)
reg.fit(X, y, eval_set=[(X, y)])
```
early_stopping_rounds (Optional[int]) –

Added in version 1.6.0.
- 激活早停机制。验证指标需要在每 early_stopping_rounds 轮中至少改善一次以继续训练。这需要在 fit() 中至少有一个 eval_set 项。
- 如果发生早停，模型将有两个额外的属性：best_score 和 best_iteration。这些属性用于 predict() 和 apply() 方法，以在推理过程中确定最佳的树的数量。如果用户想要访问完整的模型（包括早停后构建的树），他们可以在这些推理方法中指定 iteration_range。此外，其他实用工具如模型绘图也可以使用整个模型。
- 如果你倾向于在 best_iteration 之后丢弃树，可以考虑使用回调函数 xgboost.callback.EarlyStopping。
- 如果 eval_set 中有多个项目，最后一个条目将用于提前停止。如果 eval_metric 中有多个指标，最后一个指标将用于提前停止。
callbacks (Optional[List[xgboost.callback.TrainingCallback]]) – 在每次迭代结束时应用的回调函数列表。可以通过使用回调 API 来使用预定义的回调。 .. 注意:
kwargs (Optional[Any]) – XGBoost Booster对象的关键字参数。参数的完整文档可以在这里找到。尝试通过构造函数参数和 **kwargs 字典同时设置参数将导致 TypeError。

apply(X, iteration_range=None)

返回每个样本在每棵树上的预测叶子。如果模型是使用早期停止训练的，那么会自动使用 best_iteration。

参数:

X (array_like, shape=[n_samples, n_features]) – 输入特征矩阵。
iteration_range (Tuple[int | integer, int | integer] | None) – 参见 predict()。

返回:

X_leaves – 对于 X 中的每个数据点 x 和每棵树，返回 x 最终所在的叶子的索引。叶子在 [0; 2**(self.max_depth+1)) 范围内编号，编号中可能存在间隙。

返回类型:

array_like, shape=[n_samples, n_trees]

property best_iteration: int: 通过早期停止获得的最佳迭代。此属性是基于0的，例如，如果最佳迭代是第一轮，那么 best_iteration 为 0。

property best_score: float: 通过早期停止获得的最佳分数。

property client: distributed.Client: 在此模型中使用的 dask 客户端。Client 对象不能被序列化以进行传输，因此如果任务是从工作进程而不是直接从客户端进程启动的，则需要在该工作进程中设置此属性。

property coef_: ndarray

Coefficients 属性

备注

系数仅针对线性学习器定义

系数仅在选择线性模型作为基础学习器时定义（booster=gblinear）。对于其他基础学习器类型，如树学习器（booster=gbtree），则未定义。

返回:: coef_
返回类型:: 形状为 [n_features] 或 [n_classes, n_features] 的数组

evals_result()

返回评估结果。

如果将 eval_set 传递给 fit() 函数，你可以调用 evals_result() 来获取所有传递的 eval_sets 的评估结果。当 eval_metric 也被传递给 fit() 函数时，evals_result 将包含传递给 fit() 函数的 eval_metrics。

返回的评估结果是一个字典：

{'validation_0': {'logloss': ['0.604835', '0.531479']},
 'validation_1': {'logloss': ['0.41965', '0.17686']}}

返回类型:: evals_result

property feature_importances_: ndarray

特征重要性属性，返回结果取决于 importance_type 参数。当模型使用多类/多标签/多目标数据集训练时，特征重要性是“平均”所有目标的。“平均”是基于重要性类型定义的。例如，如果重要性类型是“total_gain”，那么分数是所有树中每个分裂的损失变化的总和。

返回:

feature_importances_ (形状为 [n_features] 的数组，多类情况除外)
线性模型，返回形状为 (n_features, n_classes) 的数组

property feature_names_in_: ndarray: 在 fit() 过程中看到的特征名称。仅当 X 的特征名称均为字符串时定义。

fit(X, y, *, sample_weight=None, base_margin=None, eval_set=None, verbose=True, xgb_model=None, sample_weight_eval_set=None, base_margin_eval_set=None, feature_weights=None)[源代码]

拟合梯度提升模型。

请注意，多次调用 fit() 将导致模型对象从头开始重新拟合。要从之前的检查点恢复训练，请显式传递 xgb_model 参数。

参数:

X (da.Array | dd.DataFrame) – 功能矩阵。查看各种 XGBoost 函数支持的数据结构以获取支持的类型列表。当 tree_method 设置为 hist 时，内部将使用 QuantileDMatrix 而不是 DMatrix 以节省内存。然而，当输入数据的设备与算法不匹配时，这会影响性能。例如，如果输入是CPU上的numpy数组，但训练使用 cuda，则数据首先在CPU上处理，然后传输到GPU。
y (da.Array | dd.DataFrame | dd.Series) – 标签
sample_weight (da.Array | dd.DataFrame | dd.Series | None) – 实例权重
base_margin (da.Array | dd.DataFrame | dd.Series | None) – 每个实例的全局偏差。详情请参见拦截。
eval_set (Sequence[Tuple[da.Array | dd.DataFrame | dd.Series, da.Array | dd.DataFrame | dd.Series]] | None) – 用于作为验证集的 (X, y) 元组对列表，将计算这些验证集的指标。验证指标将帮助我们跟踪模型的性能。
verbose (int | bool) – 如果 verbose 为 True 并且使用了评估集，验证集上的评估指标会在每次提升阶段打印到标准输出。如果 verbose 是一个整数，评估指标会在每 verbose 次提升阶段打印。最后一次提升阶段或通过 early_stopping_rounds 找到的提升阶段也会被打印。
xgb_model (Booster | XGBModel | None) – 存储的XGBoost模型文件名或’Booster’实例 XGBoost模型，在训练前加载（允许训练继续）。
sample_weight_eval_set (Sequence[da.Array | dd.DataFrame | dd.Series] | None) – 形式为 [L_1, L_2, …, L_n] 的列表，其中每个 L_i 是一个类似数组的对象，存储第 i 个验证集的实例权重。
base_margin_eval_set (Sequence[da.Array | dd.DataFrame | dd.Series] | None) – 形式为 [M_1, M_2, …, M_n] 的列表，其中每个 M_i 是一个存储第 i 个验证集的基边界的类似数组的对象。
feature_weights (da.Array | dd.DataFrame | dd.Series | None) – 每个特征的权重，定义了在使用colsample时每个特征被选中的概率。所有值必须大于0，否则会抛出 ValueError。

返回类型:

DaskXGBRFClassifier

get_booster()

获取此模型的底层 xgboost Booster。

当未调用 fit 时，这将引发异常

返回:: booster
返回类型:: a xgboost booster of underlying model

get_metadata_routing()

获取此对象的元数据路由。

请查看用户指南以了解路由机制的工作原理。

返回:: routing – 一个封装了路由信息的 MetadataRequest。
返回类型:: MetadataRequest

get_num_boosting_rounds()[源代码]

获取xgboost的增强轮数。

返回类型:: int

get_params(deep=True)

获取参数。

参数:: deep (bool)
返回类型:: Dict[str, Any]

get_xgb_params()[源代码]

获取 xgboost 特定的参数。

返回类型:: Dict[str, Any]

property intercept_: ndarray

截距（偏差）属性

对于基于树的模型，返回值是 base_score。

返回:: 拦截_
返回类型:: 形状为 (1,) 或 [n_classes] 的数组

load_model(fname)

从文件或字节数组加载模型。

模型以XGBoost内部格式保存，该格式在各种XGBoost接口中通用。Python Booster对象的辅助属性（如feature_names）仅在使用JSON或UBJSON（默认）格式时保存。更多信息请参见模型IO。

model.load_model("model.json")
# or
model.load_model("model.ubj")

参数:: fname (str | bytearray | PathLike) – 输入文件名或内存缓冲区（另见 save_raw）
返回类型:: None

property n_features_in_: int: 在 fit() 期间看到的特征数量。

predict(X, output_margin=False, validate_features=True, base_margin=None, iteration_range=None)

使用 X 进行预测。如果模型是使用早期停止训练的，那么会自动使用 best_iteration。估计器默认使用 inplace_predict，如果数据和估计器之间的设备不匹配，则会回退到使用 DMatrix。

备注

此函数仅对 gbtree 和 dart 线程安全。

参数:

X (da.Array | dd.DataFrame) – 用于预测的数据。
output_margin (bool) – 是否输出未经转换的原始边距值。
validate_features (bool) – 当此项为 True 时，验证 Booster 和数据的 feature_names 是否相同。否则，假设 feature_names 是相同的。
base_margin (da.Array | dd.DataFrame | dd.Series | None) – 每个实例的全局偏差。详情请参见拦截。
iteration_range (Tuple[int | integer, int | integer] | None) – 指定用于预测的树层。例如，如果一个随机森林经过100轮训练。指定 iteration_range=(10, 20)，那么只有在此期间[10, 20)（半开集）轮次内构建的森林用于此次预测。 .. versionadded:: 1.4.0

返回类型:

prediction

predict_proba(X, validate_features=True, base_margin=None, iteration_range=None)

预测每个 X 样本属于给定类别的概率。如果模型是使用早停法训练的，那么会自动使用 best_iteration。估计器默认使用 inplace_predict，如果数据和估计器之间的设备不匹配，则会回退到使用 DMatrix。

备注

此函数仅对 gbtree 和 dart 线程安全。

参数:

X (da.Array | dd.DataFrame | dd.Series) – 功能矩阵。查看各种 XGBoost 函数支持的数据结构以获取支持的类型列表。
validate_features (bool) – 当此项为 True 时，验证 Booster 和数据的 feature_names 是否相同。否则，假设 feature_names 是相同的。
base_margin (da.Array | dd.DataFrame | dd.Series | None) – 每个实例的全局偏差。详情请参见拦截。
iteration_range (Tuple[int | integer, int | integer] | None) – 指定在预测中使用哪一层树。例如，如果一个随机森林被训练了100轮。指定 iteration_range=(10, 20)，那么只有在这 [10, 20)（半开区间）轮中构建的森林被用于此次预测。

返回:

一个形状为 (n_samples, n_classes) 的 numpy 数组，表示每个数据样本属于某一类的概率。

返回类型:

prediction

save_model(fname)

将模型保存到文件中。

模型以XGBoost内部格式保存，该格式在各种XGBoost接口中通用。Python Booster对象的辅助属性（如feature_names）仅在使用JSON或UBJSON（默认）格式时保存。更多信息请参见模型IO。

model.save_model("model.json")
# or
model.save_model("model.ubj")

参数:: fname (str | PathLike) – 输出文件名
返回类型:: None

score(X, y, sample_weight=None)

返回给定测试数据和标签的平均准确率。

在多标签分类中，这是子集准确率，这是一个严格的度量标准，因为你要求每个样本的每个标签集都被正确预测。

参数:

X (array-like of shape (n_samples, n_features)) – 测试样本。
y (array-like of shape (n_samples,) or (n_samples, n_outputs)) – X 的真实标签。
sample_weight (array-like of shape (n_samples,), default=None) – 样本权重。

返回:

score – self.predict(X) 相对于 y 的平均准确率。

返回类型:

set_fit_request(*, base_margin='$UNCHANGED$', base_margin_eval_set='$UNCHANGED$', eval_set='$UNCHANGED$', feature_weights='$UNCHANGED$', sample_weight='$UNCHANGED$', sample_weight_eval_set='$UNCHANGED$', verbose='$UNCHANGED$', xgb_model='$UNCHANGED$')

传递给 fit 方法的请求元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config()）。请参阅用户指南了解路由机制的工作原理。

每个参数的选项是：

True: 请求元数据，并在提供时传递给 fit。如果未提供元数据，则忽略该请求。
False: 不请求元数据，元估计器不会将其传递给 fit。
None: 不需要元数据，如果用户提供了元数据，元估计器将引发错误。
str: 元数据应使用此给定别名传递给元估计器，而不是原始名称。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你更改某些参数的请求，而不更改其他参数。

Added in version 1.3.

备注

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用。否则它不会有任何效果。

参数:

base_margin (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 base_margin 参数的元数据路由。
base_margin_eval_set (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 base_margin_eval_set 参数的元数据路由。
eval_set (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 eval_set 参数的元数据路由。
feature_weights (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 feature_weights 参数的元数据路由。
sample_weight (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 sample_weight 参数的元数据路由。
sample_weight_eval_set (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 sample_weight_eval_set 参数的元数据路由。
verbose (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 verbose 参数的元数据路由。
xgb_model (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – fit 方法中 xgb_model 参数的元数据路由。
self (DaskXGBRFClassifier)

返回:

self – 更新后的对象。

返回类型:

set_params(**params)

设置此估计器的参数。修改了 sklearn 方法以允许未知的 kwargs。这允许使用在 sklearn 网格搜索中未定义为成员变量的 xgboost 参数的完整范围。

返回类型:: self
参数:: params (Any)

set_predict_proba_request(*, base_margin='$UNCHANGED$', iteration_range='$UNCHANGED$', validate_features='$UNCHANGED$')

传递给 predict_proba 方法的请求元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config()）。请参阅用户指南了解路由机制的工作原理。

每个参数的选项是：

True: 请求元数据，并在提供时传递给 predict_proba。如果未提供元数据，则忽略该请求。
False: 不请求元数据，元估计器不会将其传递给 predict_proba。
None: 不需要元数据，如果用户提供了元数据，元估计器将引发错误。
str: 元数据应使用此给定别名传递给元估计器，而不是原始名称。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你更改某些参数的请求，而不更改其他参数。

Added in version 1.3.

备注

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用。否则它不会有任何效果。

参数:

base_margin (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict_proba 中 base_margin 参数的元数据路由。
iteration_range (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict_proba 中 iteration_range 参数的元数据路由。
validate_features (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict_proba 中的 validate_features 参数的元数据路由。
self (DaskXGBRFClassifier)

返回:

self – 更新后的对象。

返回类型:

set_predict_request(*, base_margin='$UNCHANGED$', iteration_range='$UNCHANGED$', output_margin='$UNCHANGED$', validate_features='$UNCHANGED$')

传递给 predict 方法的请求元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config()）。请参阅用户指南了解路由机制的工作原理。

每个参数的选项是：

True: 请求元数据，并在提供时传递给 predict。如果未提供元数据，则忽略请求。
False: 不请求元数据，元估计器不会将其传递给 predict。
None: 不需要元数据，如果用户提供了元数据，元估计器将引发错误。
str: 元数据应使用此给定别名传递给元估计器，而不是原始名称。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你更改某些参数的请求，而不更改其他参数。

Added in version 1.3.

备注

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用。否则它不会有任何效果。

参数:

base_margin (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 base_margin 参数的元数据路由。
iteration_range (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 iteration_range 参数的元数据路由。
output_margin (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 output_margin 参数的元数据路由。
validate_features (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – predict 方法中 validate_features 参数的元数据路由。
self (DaskXGBRFClassifier)

返回:

self – 更新后的对象。

返回类型:

set_score_request(*, sample_weight='$UNCHANGED$')

传递给 score 方法的请求元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（参见 sklearn.set_config()）。请参阅用户指南了解路由机制的工作原理。

每个参数的选项是：

True: 请求元数据，并在提供时传递给 score。如果未提供元数据，则忽略请求。
False: 不需要元数据，元估计器不会将其传递给 score。
None: 不需要元数据，如果用户提供了元数据，元估计器将引发错误。
str: 元数据应使用此给定别名传递给元估计器，而不是原始名称。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有的请求。这允许你更改某些参数的请求，而不更改其他参数。

Added in version 1.3.

备注

此方法仅在将此估计器用作元估计器的子估计器时相关，例如在 Pipeline 内部使用。否则它不会有任何效果。

参数:

sample_weight (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – score 方法中 sample_weight 参数的元数据路由。
self (DaskXGBRFClassifier)

返回:

self – 更新后的对象。

返回类型: