RetroSearch Browse

Notes

The $R^2$ score used when calling score on a regressor uses multioutput='uniform_average' from version 0.23 to keep consistent with default value of r2_score(). This influences the score method of all the multioutput regressors (except for 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$')

Configure whether metadata should be requested to be passed to the fit method.

Parameters:

self (XGBRegressor)
base_margin (bool | None | str)
base_margin_eval_set (bool | None | str)
eval_set (bool | None | str)
feature_weights (bool | None | str)
sample_weight (bool | None | str)
sample_weight_eval_set (bool | None | str)
verbose (bool | None | str)
xgb_model (bool | None | str)

Return type:

XGBRegressor

set_params(**params)

Set the parameters of this estimator. Modification of the sklearn method to allow unknown kwargs. This allows using the full range of xgboost parameters that are not defined as member variables in sklearn grid search.

Return type:: self
Parameters:: params (Any)

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

Configure whether metadata should be requested to be passed to the predict method.

Parameters:

self (XGBRegressor)
base_margin (bool | None | str)
iteration_range (bool | None | str)
output_margin (bool | None | str)
validate_features (bool | None | str)

Return type:

XGBRegressor

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

Configure whether metadata should be requested to be passed to the score method.

Parameters:

self (XGBRegressor)
sample_weight (bool | None | str)

Return type:

XGBRegressor

class xgboost.XGBClassifier(*, objective='binary:logistic', **kwargs)

Bases: ClassifierMixin, XGBModel

Implementation of the scikit-learn API for XGBoost classification. See Using the Scikit-Learn Estimator Interface for more information.

Parameters:

n_estimators (Optional[int]) – Number of boosting rounds.
max_depth (Optional[int]) – Maximum tree depth for base learners.
max_leaves (Optional[int]) – Maximum number of leaves; 0 indicates no limit.
max_bin (Optional[int]) – If using histogram-based algorithm, maximum number of bins per feature
grow_policy (Optional[str]) –

Tree growing policy.
- depthwise: Favors splitting at nodes closest to the node,
- lossguide: Favors splitting at nodes with highest loss change.
learning_rate (Optional[float]) – Boosting learning rate (xgb’s “eta”)
verbosity (Optional[int]) – The degree of verbosity. Valid values are 0 (silent) - 3 (debug).
objective (Union[str, xgboost.sklearn._SklObjWProto, Callable[[Any, Any], Tuple[numpy.ndarray, numpy.ndarray]], NoneType]) –

Specify the learning task and the corresponding learning objective or a custom objective function to be used.

For custom objective, see Custom Objective and Evaluation Metric and Custom objective and metric for more information, along with the end note for function signatures.
booster (Optional[str]) – Specify which booster to use: gbtree, gblinear or dart.
tree_method (Optional[str]) – Specify which tree method to use. Default to auto. If this parameter is set to default, XGBoost will choose the most conservative option available. It’s recommended to study this option from the parameters document tree method
n_jobs (Optional[int]) – Number of parallel threads used to run xgboost. When used with other Scikit-Learn algorithms like grid search, you may choose which algorithm to parallelize and balance the threads. Creating thread contention will significantly slow down both algorithms.
gamma (Optional[float]) – (min_split_loss) Minimum loss reduction required to make a further partition on a leaf node of the tree.
min_child_weight (Optional[float]) – Minimum sum of instance weight(hessian) needed in a child.
max_delta_step (Optional[float]) – Maximum delta step we allow each tree’s weight estimation to be.
subsample (Optional[float]) – Subsample ratio of the training instance.
sampling_method (Optional[str]) –

Sampling method. Used only by the GPU version of hist tree method.
- uniform: Select random training instances uniformly.
- gradient_based: Select random training instances with higher probability
  
  when the gradient and hessian are larger. (cf. CatBoost)
colsample_bytree (Optional[float]) – Subsample ratio of columns when constructing each tree.
colsample_bylevel (Optional[float]) – Subsample ratio of columns for each level.
colsample_bynode (Optional[float]) – Subsample ratio of columns for each split.
reg_alpha (Optional[float]) – L1 regularization term on weights (xgb’s alpha).
reg_lambda (Optional[float]) – L2 regularization term on weights (xgb’s lambda).
scale_pos_weight (Optional[float]) – Balancing of positive and negative weights.
base_score (Optional[float]) – The initial prediction score of all instances, global bias.
random_state (Union[numpy.random.mtrand.RandomState, numpy.random._generator.Generator, int, NoneType]) –

Random number seed.

Note

Using gblinear booster with shotgun updater is nondeterministic as it uses Hogwild algorithm.
missing (float) – Value in the data which needs to be present as a missing value. Default to numpy.nan.
num_parallel_tree (Optional[int]) – Used for boosting random forest.
monotone_constraints (Union[Dict[str, int], str, NoneType]) – Constraint of variable monotonicity. See tutorial for more information.
interaction_constraints (Union[str, List[Tuple[str]], NoneType]) – Constraints for interaction representing permitted interactions. The constraints must be specified in the form of a nested list, e.g. [[0, 1], [2, 3, 4]], where each inner list is a group of indices of features that are allowed to interact with each other. See tutorial for more information
importance_type (Optional[str]) –

The feature importance type for the feature_importances_ property:
- For tree model, it’s either “gain”, “weight”, “cover”, “total_gain” or “total_cover”.
- For linear model, only “weight” is defined and it’s the normalized coefficients without bias.
device (Optional[str]) –

Added in version 2.0.0.

Device ordinal, available options are cpu, cuda, and gpu.
validate_parameters (Optional[bool]) – Give warnings for unknown parameter.
enable_categorical (bool) – See the same parameter of DMatrix for details.
feature_types (Optional[Sequence[str]]) –

Added in version 1.7.0.

Used for specifying feature types without constructing a dataframe. See the DMatrix for details.
feature_weights (Optional[ArrayLike]) – Weight for each feature, defines the probability of each feature being selected when colsample is being used. All values must be greater than 0, otherwise a ValueError is thrown.
max_cat_to_onehot (Optional[int]) –

Added in version 1.6.0.

Note

This parameter is experimental

A threshold for deciding whether XGBoost should use one-hot encoding based split for categorical data. When number of categories is lesser than the threshold then one-hot encoding is chosen, otherwise the categories will be partitioned into children nodes. Also, enable_categorical needs to be set to have categorical feature support. See Categorical Data and Parameters for Categorical Feature for details.
max_cat_threshold (Optional[int]) –

Added in version 1.7.0.

Note

This parameter is experimental

Maximum number of categories considered for each split. Used only by partition-based splits for preventing over-fitting. Also, enable_categorical needs to be set to have categorical feature support. See Categorical Data and Parameters for Categorical Feature for details.
multi_strategy (Optional[str]) –

Added in version 2.0.0.

Note

This parameter is working-in-progress.

The strategy used for training multi-target models, including multi-target regression and multi-class classification. See Multiple Outputs for more information.
- one_output_per_tree: One model for each target.
- multi_output_tree: Use multi-target trees.
eval_metric (Union[str, List[Union[str, Callable]], Callable, NoneType]) –

Added in version 1.6.0.

Metric used for monitoring the training result and early stopping. It can be a string or list of strings as names of predefined metric in XGBoost (See XGBoost Parameters), one of the metrics in sklearn.metrics, or any other user defined metric that looks like sklearn.metrics.

If custom objective is also provided, then custom metric should implement the corresponding reverse link function.

Unlike the scoring parameter commonly used in scikit-learn, when a callable object is provided, it’s assumed to be a cost function and by default XGBoost will minimize the result during early stopping.

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

See Custom Objective and Evaluation Metric and Custom objective and metric for more information.
```
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.
- Activates early stopping. Validation metric needs to improve at least once in every early_stopping_rounds round(s) to continue training. Requires at least one item in eval_set in fit().
- If early stopping occurs, the model will have two additional attributes: best_score and best_iteration. These are used by the predict() and apply() methods to determine the optimal number of trees during inference. If users want to access the full model (including trees built after early stopping), they can specify the iteration_range in these inference methods. In addition, other utilities like model plotting can also use the entire model.
- If you prefer to discard the trees after best_iteration, consider using the callback function xgboost.callback.EarlyStopping.
- If there’s more than one item in eval_set, the last entry will be used for early stopping. If there’s more than one metric in eval_metric, the last metric will be used for early stopping.
callbacks (Optional[List[xgboost.callback.TrainingCallback]]) –

List of callback functions that are applied at end of each iteration. It is possible to use predefined callbacks by using Callback API.

Note

States in callback are not preserved during training, which means callback objects can not be reused for multiple training sessions without reinitialization or deepcopy.
```
for params in parameters_grid:
    # be sure to (re)initialize the callbacks before each run
    callbacks = [xgb.callback.LearningRateScheduler(custom_rates)]
    reg = xgboost.XGBRegressor(**params, callbacks=callbacks)
    reg.fit(X, y)
```
kwargs (Optional[Any]) –

Keyword arguments for XGBoost Booster object. Full documentation of parameters can be found here. Attempting to set a parameter via the constructor args and **kwargs dict simultaneously will result in a TypeError.

Note

**kwargs unsupported by scikit-learn

**kwargs is unsupported by scikit-learn. We do not guarantee that parameters passed via this argument will interact properly with scikit-learn.

Note

Custom objective function

A custom objective function can be provided for the objective parameter. In this case, it should have the signature objective(y_true, y_pred) -> [grad, hess] or objective(y_true, y_pred, *, sample_weight) -> [grad, hess]:

y_true: array_like of shape [n_samples]

The target values

y_pred: array_like of shape [n_samples]

The predicted values

sample_weight :

Optional sample weights.

grad: array_like of shape [n_samples]

The value of the gradient for each sample point.

hess: array_like of shape [n_samples]

The value of the second derivative for each sample point

Note that, if the custom objective produces negative values for the Hessian, these will be clipped. If the objective is non-convex, one might also consider using the expected Hessian (Fisher information) instead.

apply(X, iteration_range=None)

Return the predicted leaf every tree for each sample. If the model is trained with early stopping, then best_iteration is used automatically.

Parameters:

X (Any) – Input features matrix. See Markers for a list of supported types.
iteration_range (Tuple[int | integer, int | integer] | None) – See predict().

Returns:

X_leaves – For each datapoint x in X and for each tree, return the index of the leaf x ends up in. Leaves are numbered within [0; 2**(self.max_depth+1)), possibly with gaps in the numbering.

Return type:

array_like, shape=[n_samples, n_trees]

property best_iteration: int: The best iteration obtained by early stopping. This attribute is 0-based, for instance if the best iteration is the first round, then best_iteration is 0.

property best_score: float: The best score obtained by early stopping.

property coef_: ndarray

Coefficients property

Note

Coefficients are defined only for linear learners

Coefficients are only defined when the linear model is chosen as base learner (booster=gblinear). It is not defined for other base learner types, such as tree learners (booster=gbtree).

Returns:: coef_
Return type:: array of shape [n_features] or [n_classes, n_features]

evals_result()

Return the evaluation results.

The returned evaluation result is a dictionary:

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

Return type:: evals_result

property feature_importances_: ndarray

Returns:

feature_importances_ (array of shape [n_features] except for multi-class)
linear model, which returns an array with shape (n_features, n_classes)

property feature_names_in_: ndarray: Names of features seen during fit(). Defined only when X has feature names that are all strings.

Fit gradient boosting classifier.

Note that calling fit() multiple times will cause the model object to be re-fit from scratch. To resume training from a previous checkpoint, explicitly pass xgb_model argument.

Parameters:

X (Any) –

Input feature matrix. See Markers for a list of supported types.

When the tree_method is set to hist, internally, the QuantileDMatrix will be used instead of the DMatrix for conserving memory. However, this has performance implications when the device of input data is not matched with algorithm. For instance, if the input is a numpy array on CPU but cuda is used for training, then the data is first processed on CPU then transferred to GPU.
y (Any) – Labels
sample_weight (Any | None) – instance weights
base_margin (Any | None) – Global bias for each instance. See Intercept for details.
eval_set (Sequence[Tuple[Any, Any]] | None) – A list of (X, y) tuple pairs to use as validation sets, for which metrics will be computed. Validation metrics will help us track the performance of the model.
verbose (bool | int | None) – If verbose is True and an evaluation set is used, the evaluation metric measured on the validation set is printed to stdout at each boosting stage. If verbose is an integer, the evaluation metric is printed at each verbose boosting stage. The last boosting stage / the boosting stage found by using early_stopping_rounds is also printed.
xgb_model (Booster | str | XGBModel | None) – file name of stored XGBoost model or ‘Booster’ instance XGBoost model to be loaded before training (allows training continuation).
sample_weight_eval_set (Sequence[Any] | None) – A list of the form [L_1, L_2, …, L_n], where each L_i is an array like object storing instance weights for the i-th validation set.
base_margin_eval_set (Sequence[Any] | None) – A list of the form [M_1, M_2, …, M_n], where each M_i is an array like object storing base margin for the i-th validation set.
feature_weights (Any | None) –

Deprecated since version 3.0.0.

Use feature_weights in __init__() or set_params() instead.

Return type:

get_booster()

Get the underlying xgboost Booster of this model.

This will raise an exception when fit was not called

Returns:: booster
Return type:: a xgboost booster of underlying model

get_metadata_routing()

Get metadata routing of this object.

Please check User Guide on how the routing mechanism works.

Returns:: routing – A MetadataRequest encapsulating routing information.
Return type:: MetadataRequest

get_num_boosting_rounds()

Gets the number of xgboost boosting rounds.

Return type:: int

get_params(deep=True)

Get parameters.

Parameters:: deep (bool)
Return type:: Dict[str, Any]

get_xgb_params()

Get xgboost specific parameters.

Return type:: Dict[str, Any]

property intercept_: ndarray

Intercept (bias) property

For tree-based model, the returned value is the base_score.

Returns:: intercept_
Return type:: array of shape (1,) or [n_classes]

load_model(fname)

Load the model from a file or a bytearray.

model.save_model("model.json")
model.load_model("model.json")

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

# or
buf = model.save_raw()
model.load_model(buf)

Parameters:: fname (PathLike | bytearray | str) – Input file name or memory buffer(see also save_raw)
Return type:: None

property n_features_in_: int: Number of features seen during fit().

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

Note

This function is only thread safe for gbtree and dart.

Parameters:

X (Any) – Data to predict with. See Markers for a list of supported types.
output_margin (bool) – Whether to output the raw untransformed margin value.
validate_features (bool) – When this is True, validate that the Booster’s and data’s feature_names are identical. Otherwise, it is assumed that the feature_names are the same.
base_margin (Any | None) – Global bias for each instance. See Intercept for details.
iteration_range (Tuple[int | integer, int | integer] | None) –

Specifies which layer of trees are used in prediction. For example, if a random forest is trained with 100 rounds. Specifying iteration_range=(10, 20), then only the forests built during [10, 20) (half open set) rounds are used in this prediction.

Added in version 1.4.0.

Return type:

prediction

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

Predict the probability of each X example being of a given class. If the model is trained with early stopping, then best_iteration is used automatically. The estimator uses inplace_predict by default and falls back to using DMatrix if devices between the data and the estimator don’t match.

Note

This function is only thread safe for gbtree and dart.

Parameters:

X (Any) – Feature matrix. See Markers for a list of supported types.
validate_features (bool) – When this is True, validate that the Booster’s and data’s feature_names are identical. Otherwise, it is assumed that the feature_names are the same.
base_margin (Any | None) – Global bias for each instance. See Intercept for details.
iteration_range (Tuple[int | integer, int | integer] | None) – Specifies which layer of trees are used in prediction. For example, if a random forest is trained with 100 rounds. Specifying iteration_range=(10, 20), then only the forests built during [10, 20) (half open set) rounds are used in this prediction.

Returns:

a numpy array of shape array-like of shape (n_samples, n_classes) with the probability of each data example being of a given class.

Return type:

prediction

save_model(fname)

Save the model to a file.

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

Parameters:: fname (str | PathLike) – Output file name
Return type:: None

score(X, y, sample_weight=None)

Return accuracy on provided data and labels.

In multi-label classification, this is the subset accuracy which is a harsh metric since you require for each sample that each label set be correctly predicted.

Parameters:

X (array-like of shape (n_samples, n_features)) – Test samples.
y (array-like of shape (n_samples,) or (n_samples, n_outputs)) – True labels for X.
sample_weight (array-like of shape (n_samples,), default=None) – Sample weights.

Returns:

score – Mean accuracy of self.predict(X) w.r.t. y.

Return type:

Configure whether metadata should be requested to be passed to the fit method.

Parameters:

self (XGBClassifier)
base_margin (bool | None | str)
base_margin_eval_set (bool | None | str)
eval_set (bool | None | str)
feature_weights (bool | None | str)
sample_weight (bool | None | str)
sample_weight_eval_set (bool | None | str)
verbose (bool | None | str)
xgb_model (bool | None | str)

Return type:

set_params(**params)

Return type:: self
Parameters:: params (Any)

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

Configure whether metadata should be requested to be passed to the predict_proba method.

Parameters:

self (XGBClassifier)
base_margin (bool | None | str)
iteration_range (bool | None | str)
validate_features (bool | None | str)

Return type:

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

Configure whether metadata should be requested to be passed to the predict method.

Parameters:

self (XGBClassifier)
base_margin (bool | None | str)
iteration_range (bool | None | str)
output_margin (bool | None | str)
validate_features (bool | None | str)

Return type:

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

Configure whether metadata should be requested to be passed to the score method.

Parameters:

self (XGBClassifier)
sample_weight (bool | None | str)

Return type:

class xgboost.XGBRanker(*, objective='rank:ndcg', **kwargs)

Bases: XGBRankerMixIn, XGBModel

Implementation of the Scikit-Learn API for XGBoost Ranking.

See Learning to Rank for an introducion.

See Using the Scikit-Learn Estimator Interface for more information.

Parameters:

n_estimators (Optional[int]) – Number of gradient boosted trees. Equivalent to number of boosting rounds.
max_depth (Optional[int]) – Maximum tree depth for base learners.
max_leaves (Optional[int]) – Maximum number of leaves; 0 indicates no limit.
max_bin (Optional[int]) – If using histogram-based algorithm, maximum number of bins per feature
grow_policy (Optional[str]) –

Tree growing policy.
- depthwise: Favors splitting at nodes closest to the node,
- lossguide: Favors splitting at nodes with highest loss change.
learning_rate (Optional[float]) – Boosting learning rate (xgb’s “eta”)
verbosity (Optional[int]) – The degree of verbosity. Valid values are 0 (silent) - 3 (debug).
objective (Union[str, xgboost.sklearn._SklObjWProto, Callable[[Any, Any], Tuple[numpy.ndarray, numpy.ndarray]], NoneType]) –

Specify the learning task and the corresponding learning objective or a custom objective function to be used.

For custom objective, see Custom Objective and Evaluation Metric and Custom objective and metric for more information, along with the end note for function signatures.
booster (Optional[str]) – Specify which booster to use: gbtree, gblinear or dart.
tree_method (Optional[str]) – Specify which tree method to use. Default to auto. If this parameter is set to default, XGBoost will choose the most conservative option available. It’s recommended to study this option from the parameters document tree method
n_jobs (Optional[int]) – Number of parallel threads used to run xgboost. When used with other Scikit-Learn algorithms like grid search, you may choose which algorithm to parallelize and balance the threads. Creating thread contention will significantly slow down both algorithms.
gamma (Optional[float]) – (min_split_loss) Minimum loss reduction required to make a further partition on a leaf node of the tree.
min_child_weight (Optional[float]) – Minimum sum of instance weight(hessian) needed in a child.
max_delta_step (Optional[float]) – Maximum delta step we allow each tree’s weight estimation to be.
subsample (Optional[float]) – Subsample ratio of the training instance.
sampling_method (Optional[str]) –

Sampling method. Used only by the GPU version of hist tree method.
- uniform: Select random training instances uniformly.
- gradient_based: Select random training instances with higher probability
  
  when the gradient and hessian are larger. (cf. CatBoost)
colsample_bytree (Optional[float]) – Subsample ratio of columns when constructing each tree.
colsample_bylevel (Optional[float]) – Subsample ratio of columns for each level.
colsample_bynode (Optional[float]) – Subsample ratio of columns for each split.
reg_alpha (Optional[float]) – L1 regularization term on weights (xgb’s alpha).
reg_lambda (Optional[float]) – L2 regularization term on weights (xgb’s lambda).
scale_pos_weight (Optional[float]) – Balancing of positive and negative weights.
base_score (Optional[float]) – The initial prediction score of all instances, global bias.
random_state (Union[numpy.random.mtrand.RandomState, numpy.random._generator.Generator, int, NoneType]) –

Random number seed.

Note

Using gblinear booster with shotgun updater is nondeterministic as it uses Hogwild algorithm.
missing (float) – Value in the data which needs to be present as a missing value. Default to numpy.nan.
num_parallel_tree (Optional[int]) – Used for boosting random forest.
monotone_constraints (Union[Dict[str, int], str, NoneType]) – Constraint of variable monotonicity. See tutorial for more information.
interaction_constraints (Union[str, List[Tuple[str]], NoneType]) – Constraints for interaction representing permitted interactions. The constraints must be specified in the form of a nested list, e.g. [[0, 1], [2, 3, 4]], where each inner list is a group of indices of features that are allowed to interact with each other. See tutorial for more information
importance_type (Optional[str]) –

The feature importance type for the feature_importances_ property:
- For tree model, it’s either “gain”, “weight”, “cover”, “total_gain” or “total_cover”.
- For linear model, only “weight” is defined and it’s the normalized coefficients without bias.
device (Optional[str]) –

Added in version 2.0.0.

Device ordinal, available options are cpu, cuda, and gpu.
validate_parameters (Optional[bool]) – Give warnings for unknown parameter.
enable_categorical (bool) – See the same parameter of DMatrix for details.
feature_types (Optional[Sequence[str]]) –

Added in version 1.7.0.

Used for specifying feature types without constructing a dataframe. See the DMatrix for details.
feature_weights (Optional[ArrayLike]) – Weight for each feature, defines the probability of each feature being selected when colsample is being used. All values must be greater than 0, otherwise a ValueError is thrown.
max_cat_to_onehot (Optional[int]) –

Added in version 1.6.0.

Note

This parameter is experimental

A threshold for deciding whether XGBoost should use one-hot encoding based split for categorical data. When number of categories is lesser than the threshold then one-hot encoding is chosen, otherwise the categories will be partitioned into children nodes. Also, enable_categorical needs to be set to have categorical feature support. See Categorical Data and Parameters for Categorical Feature for details.
max_cat_threshold (Optional[int]) –

Added in version 1.7.0.

Note

This parameter is experimental

Maximum number of categories considered for each split. Used only by partition-based splits for preventing over-fitting. Also, enable_categorical needs to be set to have categorical feature support. See Categorical Data and Parameters for Categorical Feature for details.
multi_strategy (Optional[str]) –

Added in version 2.0.0.

Note

This parameter is working-in-progress.

The strategy used for training multi-target models, including multi-target regression and multi-class classification. See Multiple Outputs for more information.
- one_output_per_tree: One model for each target.
- multi_output_tree: Use multi-target trees.
eval_metric (Union[str, List[Union[str, Callable]], Callable, NoneType]) –

Added in version 1.6.0.

Metric used for monitoring the training result and early stopping. It can be a string or list of strings as names of predefined metric in XGBoost (See XGBoost Parameters), one of the metrics in sklearn.metrics, or any other user defined metric that looks like sklearn.metrics.

If custom objective is also provided, then custom metric should implement the corresponding reverse link function.

Unlike the scoring parameter commonly used in scikit-learn, when a callable object is provided, it’s assumed to be a cost function and by default XGBoost will minimize the result during early stopping.

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

See Custom Objective and Evaluation Metric and Custom objective and metric for more information.
```
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.
- Activates early stopping. Validation metric needs to improve at least once in every early_stopping_rounds round(s) to continue training. Requires at least one item in eval_set in fit().
- If early stopping occurs, the model will have two additional attributes: best_score and best_iteration. These are used by the predict() and apply() methods to determine the optimal number of trees during inference. If users want to access the full model (including trees built after early stopping), they can specify the iteration_range in these inference methods. In addition, other utilities like model plotting can also use the entire model.
- If you prefer to discard the trees after best_iteration, consider using the callback function xgboost.callback.EarlyStopping.
- If there’s more than one item in eval_set, the last entry will be used for early stopping. If there’s more than one metric in eval_metric, the last metric will be used for early stopping.
callbacks (Optional[List[xgboost.callback.TrainingCallback]]) –

List of callback functions that are applied at end of each iteration. It is possible to use predefined callbacks by using Callback API.

Note

States in callback are not preserved during training, which means callback objects can not be reused for multiple training sessions without reinitialization or deepcopy.
```
for params in parameters_grid:
    # be sure to (re)initialize the callbacks before each run
    callbacks = [xgb.callback.LearningRateScheduler(custom_rates)]
    reg = xgboost.XGBRegressor(**params, callbacks=callbacks)
    reg.fit(X, y)
```
kwargs (Optional[Any]) –

Keyword arguments for XGBoost Booster object. Full documentation of parameters can be found here. Attempting to set a parameter via the constructor args and **kwargs dict simultaneously will result in a TypeError.

Note

**kwargs unsupported by scikit-learn

**kwargs is unsupported by scikit-learn. We do not guarantee that parameters passed via this argument will interact properly with scikit-learn.

Note

A custom objective function is currently not supported by XGBRanker.

Note

Query group information is only required for ranking training but not prediction. Multiple groups can be predicted on a single call to predict().

When fitting the model with the group parameter, your data need to be sorted by the query group first. group is an array that contains the size of each query group.

Similarly, when fitting the model with the qid parameter, the data should be sorted according to query index and qid is an array that contains the query index for each training sample.

For example, if your original data look like:

qid

label

features

1

0

x_1

1

1

x_2

1

0

x_3

2

0

x_4

2

1

x_5

2

1

x_6

2

1

x_7

then fit() method can be called with either group array as [3, 4] or with qid as [1, 1, 1, 2, 2, 2, 2], that is the qid column. Also, the qid can be a special column of input X instead of a separated parameter, see fit() for more info.

apply(X, iteration_range=None)

Return the predicted leaf every tree for each sample. If the model is trained with early stopping, then best_iteration is used automatically.

Parameters:

X (Any) – Input features matrix. See Markers for a list of supported types.
iteration_range (Tuple[int | integer, int | integer] | None) – See predict().

Returns:

X_leaves – For each datapoint x in X and for each tree, return the index of the leaf x ends up in. Leaves are numbered within [0; 2**(self.max_depth+1)), possibly with gaps in the numbering.

Return type:

array_like, shape=[n_samples, n_trees]

property best_iteration: int: The best iteration obtained by early stopping. This attribute is 0-based, for instance if the best iteration is the first round, then best_iteration is 0.

property best_score: float: The best score obtained by early stopping.

property coef_: ndarray

Coefficients property

Note

Coefficients are defined only for linear learners

Coefficients are only defined when the linear model is chosen as base learner (booster=gblinear). It is not defined for other base learner types, such as tree learners (booster=gbtree).

Returns:: coef_
Return type:: array of shape [n_features] or [n_classes, n_features]

evals_result()

Return the evaluation results.

The returned evaluation result is a dictionary:

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

Return type:: evals_result

property feature_importances_: ndarray

Returns:

feature_importances_ (array of shape [n_features] except for multi-class)
linear model, which returns an array with shape (n_features, n_classes)

property feature_names_in_: ndarray: Names of features seen during fit(). Defined only when X has feature names that are all strings.

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 gradient boosting ranker

Note that calling fit() multiple times will cause the model object to be re-fit from scratch. To resume training from a previous checkpoint, explicitly pass xgb_model argument.

Parameters:

X (Any) –

Feature matrix. See Markers for a list of supported types.

When this is a pandas.DataFrame or a cudf.DataFrame, it may contain a special column called qid for specifying the query index. Using a special column is the same as using the qid parameter, except for being compatible with sklearn utility functions like sklearn.model_selection.cross_validation(). The same convention applies to the XGBRanker.score() and XGBRanker.predict().

qid

feat_0

feat_1

0

$x_{00}$

$x_{01}$

1

$x_{10}$

$x_{11}$

1

$x_{20}$

$x_{21}$

When the tree_method is set to hist, internally, the QuantileDMatrix will be used instead of the DMatrix for conserving memory. However, this has performance implications when the device of input data is not matched with algorithm. For instance, if the input is a numpy array on CPU but cuda is used for training, then the data is first processed on CPU then transferred to GPU.
y (Any) – Labels
group (Any | None) – Size of each query group of training data. Should have as many elements as the query groups in the training data. If this is set to None, then user must provide qid.
qid (Any | None) – Query ID for each training sample. Should have the size of n_samples. If this is set to None, then user must provide group or a special column in X.
sample_weight (Any | None) –

Query group weights

Note

Weights are per-group for ranking tasks

In ranking task, one weight is assigned to each query group/id (not each data point). This is because we only care about the relative ordering of data points within each group, so it doesn’t make sense to assign weights to individual data points.
base_margin (Any | None) – Global bias for each instance. See Intercept for details.
eval_set (Sequence[Tuple[Any, Any]] | None) – A list of (X, y) tuple pairs to use as validation sets, for which metrics will be computed. Validation metrics will help us track the performance of the model.
eval_group (Sequence[Any] | None) – A list in which eval_group[i] is the list containing the sizes of all query groups in the i-th pair in eval_set.
eval_qid (Sequence[Any] | None) – A list in which eval_qid[i] is the array containing query ID of i-th pair in eval_set. The special column convention in X applies to validation datasets as well.
verbose (bool | int | None) – If verbose is True and an evaluation set is used, the evaluation metric measured on the validation set is printed to stdout at each boosting stage. If verbose is an integer, the evaluation metric is printed at each verbose boosting stage. The last boosting stage / the boosting stage found by using early_stopping_rounds is also printed.
xgb_model (Booster | str | XGBModel | None) – file name of stored XGBoost model or ‘Booster’ instance XGBoost model to be loaded before training (allows training continuation).
sample_weight_eval_set (Sequence[Any] | None) –

A list of the form [L_1, L_2, …, L_n], where each L_i is a list of group weights on the i-th validation set.

Note

Weights are per-group for ranking tasks

In ranking task, one weight is assigned to each query group (not each data point). This is because we only care about the relative ordering of data points within each group, so it doesn’t make sense to assign weights to individual data points.
base_margin_eval_set (Sequence[Any] | None) – A list of the form [M_1, M_2, …, M_n], where each M_i is an array like object storing base margin for the i-th validation set.
feature_weights (Any | None) – Weight for each feature, defines the probability of each feature being selected when colsample is being used. All values must be greater than 0, otherwise a ValueError is thrown.

Return type:

XGBRanker

get_booster()

Get the underlying xgboost Booster of this model.

This will raise an exception when fit was not called

Returns:: booster
Return type:: a xgboost booster of underlying model

get_metadata_routing()

Get metadata routing of this object.

Please check User Guide on how the routing mechanism works.

Returns:: routing – A MetadataRequest encapsulating routing information.
Return type:: MetadataRequest

get_num_boosting_rounds()

Gets the number of xgboost boosting rounds.

Return type:: int

get_params(deep=True)

Get parameters.

Parameters:: deep (bool)
Return type:: Dict[str, Any]

get_xgb_params()

Get xgboost specific parameters.

Return type:: Dict[str, Any]

property intercept_: ndarray

Intercept (bias) property

For tree-based model, the returned value is the base_score.

Returns:: intercept_
Return type:: array of shape (1,) or [n_classes]

load_model(fname)

Load the model from a file or a bytearray.

model.save_model("model.json")
model.load_model("model.json")

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

# or
buf = model.save_raw()
model.load_model(buf)

Parameters:: fname (PathLike | bytearray | str) – Input file name or memory buffer(see also save_raw)
Return type:: None

property n_features_in_: int: Number of features seen during fit().

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

Note

This function is only thread safe for gbtree and dart.

Parameters:

X (Any) – Data to predict with. See Markers for a list of supported types.
output_margin (bool) – Whether to output the raw untransformed margin value.
validate_features (bool) – When this is True, validate that the Booster’s and data’s feature_names are identical. Otherwise, it is assumed that the feature_names are the same.
base_margin (Any | None) – Global bias for each instance. See Intercept for details.
iteration_range (Tuple[int | integer, int | integer] | None) –

Specifies which layer of trees are used in prediction. For example, if a random forest is trained with 100 rounds. Specifying iteration_range=(10, 20), then only the forests built during [10, 20) (half open set) rounds are used in this prediction.

Added in version 1.4.0.

Return type:

prediction

save_model(fname)

Save the model to a file.

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

Parameters:: fname (str | PathLike) – Output file name
Return type:: None

score(X, y)

Evaluate score for data using the last evaluation metric. If the model is trained with early stopping, then best_iteration is used automatically.

Parameters:

X (Union[pd.DataFrame, cudf.DataFrame]) – Feature matrix. A DataFrame with a special qid column.
y (Any) – Labels

Returns:

The result of the first evaluation metric for the ranker.

Return type:

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$')

Configure whether metadata should be requested to be passed to the fit method.

Parameters:

self (XGBRanker)
base_margin (bool | None | str)
base_margin_eval_set (bool | None | str)
eval_group (bool | None | str)
eval_qid (bool | None | str)
eval_set (bool | None | str)
feature_weights (bool | None | str)
group (bool | None | str)
qid (bool | None | str)
sample_weight (bool | None | str)
sample_weight_eval_set (bool | None | str)
verbose (bool | None | str)
xgb_model (bool | None | str)

Return type:

XGBRanker

set_params(**params)

Return type:: self
Parameters:: params (Any)

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

Configure whether metadata should be requested to be passed to the predict method.

Parameters:

self (XGBRanker)
base_margin (bool | None | str)
iteration_range (bool | None | str)
output_margin (bool | None | str)
validate_features (bool | None | str)

Return type:

XGBRanker

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

Bases: XGBRegressor

scikit-learn API for XGBoost random forest regression. See Using the Scikit-Learn Estimator Interface for more information.

Parameters:

n_estimators (Optional[int]) – Number of trees in random forest to fit.
max_depth (Optional[int]) – Maximum tree depth for base learners.
max_leaves (Optional[int]) – Maximum number of leaves; 0 indicates no limit.
max_bin (Optional[int]) – If using histogram-based algorithm, maximum number of bins per feature
grow_policy (Optional[str]) –

Tree growing policy.
- depthwise: Favors splitting at nodes closest to the node,
- lossguide: Favors splitting at nodes with highest loss change.
learning_rate (Optional[float]) – Boosting learning rate (xgb’s “eta”)
verbosity (Optional[int]) – The degree of verbosity. Valid values are 0 (silent) - 3 (debug).
objective (Union[str, xgboost.sklearn._SklObjWProto, Callable[[Any, Any], Tuple[numpy.ndarray, numpy.ndarray]], NoneType]) –

Specify the learning task and the corresponding learning objective or a custom objective function to be used.

For custom objective, see Custom Objective and Evaluation Metric and Custom objective and metric for more information, along with the end note for function signatures.
booster (Optional[str]) – Specify which booster to use: gbtree, gblinear or dart.
tree_method (Optional[str]) – Specify which tree method to use. Default to auto. If this parameter is set to default, XGBoost will choose the most conservative option available. It’s recommended to study this option from the parameters document tree method
n_jobs (Optional[int]) – Number of parallel threads used to run xgboost. When used with other Scikit-Learn algorithms like grid search, you may choose which algorithm to parallelize and balance the threads. Creating thread contention will significantly slow down both algorithms.
gamma (Optional[float]) – (min_split_loss) Minimum loss reduction required to make a further partition on a leaf node of the tree.
min_child_weight (Optional[float]) – Minimum sum of instance weight(hessian) needed in a child.
max_delta_step (Optional[float]) – Maximum delta step we allow each tree’s weight estimation to be.
subsample (Optional[float]) – Subsample ratio of the training instance.
sampling_method (Optional[str]) –

Sampling method. Used only by the GPU version of hist tree method.
- uniform: Select random training instances uniformly.
- gradient_based: Select random training instances with higher probability
  
  when the gradient and hessian are larger. (cf. CatBoost)
colsample_bytree (Optional[float]) – Subsample ratio of columns when constructing each tree.
colsample_bylevel (Optional[float]) – Subsample ratio of columns for each level.
colsample_bynode (Optional[float]) – Subsample ratio of columns for each split.
reg_alpha (Optional[float]) – L1 regularization term on weights (xgb’s alpha).
reg_lambda (Optional[float]) – L2 regularization term on weights (xgb’s lambda).
scale_pos_weight (Optional[float]) – Balancing of positive and negative weights.
base_score (Optional[float]) – The initial prediction score of all instances, global bias.
random_state (Union[numpy.random.mtrand.RandomState, numpy.random._generator.Generator, int, NoneType]) –

Random number seed.

Note

Using gblinear booster with shotgun updater is nondeterministic as it uses Hogwild algorithm.
missing (float) – Value in the data which needs to be present as a missing value. Default to numpy.nan.
num_parallel_tree (Optional[int]) – Used for boosting random forest.
monotone_constraints (Union[Dict[str, int], str, NoneType]) – Constraint of variable monotonicity. See tutorial for more information.
interaction_constraints (Union[str, List[Tuple[str]], NoneType]) – Constraints for interaction representing permitted interactions. The constraints must be specified in the form of a nested list, e.g. [[0, 1], [2, 3, 4]], where each inner list is a group of indices of features that are allowed to interact with each other. See tutorial for more information
importance_type (Optional[str]) –

The feature importance type for the feature_importances_ property:
- For tree model, it’s either “gain”, “weight”, “cover”, “total_gain” or “total_cover”.
- For linear model, only “weight” is defined and it’s the normalized coefficients without bias.
device (Optional[str]) –

Added in version 2.0.0.

Device ordinal, available options are cpu, cuda, and gpu.
validate_parameters (Optional[bool]) – Give warnings for unknown parameter.
enable_categorical (bool) – See the same parameter of DMatrix for details.
feature_types (Optional[Sequence[str]]) –

Added in version 1.7.0.

Used for specifying feature types without constructing a dataframe. See the DMatrix for details.
feature_weights (Optional[ArrayLike]) – Weight for each feature, defines the probability of each feature being selected when colsample is being used. All values must be greater than 0, otherwise a ValueError is thrown.
max_cat_to_onehot (Optional[int]) –

Added in version 1.6.0.

Note

This parameter is experimental

A threshold for deciding whether XGBoost should use one-hot encoding based split for categorical data. When number of categories is lesser than the threshold then one-hot encoding is chosen, otherwise the categories will be partitioned into children nodes. Also, enable_categorical needs to be set to have categorical feature support. See Categorical Data and Parameters for Categorical Feature for details.
max_cat_threshold (Optional[int]) –

Added in version 1.7.0.

Note

This parameter is experimental

Maximum number of categories considered for each split. Used only by partition-based splits for preventing over-fitting. Also, enable_categorical needs to be set to have categorical feature support. See Categorical Data and Parameters for Categorical Feature for details.
multi_strategy (Optional[str]) –

Added in version 2.0.0.

Note

This parameter is working-in-progress.

The strategy used for training multi-target models, including multi-target regression and multi-class classification. See Multiple Outputs for more information.
- one_output_per_tree: One model for each target.
- multi_output_tree: Use multi-target trees.
eval_metric (Union[str, List[Union[str, Callable]], Callable, NoneType]) –

Added in version 1.6.0.

Metric used for monitoring the training result and early stopping. It can be a string or list of strings as names of predefined metric in XGBoost (See XGBoost Parameters), one of the metrics in sklearn.metrics, or any other user defined metric that looks like sklearn.metrics.

If custom objective is also provided, then custom metric should implement the corresponding reverse link function.

Unlike the scoring parameter commonly used in scikit-learn, when a callable object is provided, it’s assumed to be a cost function and by default XGBoost will minimize the result during early stopping.

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

See Custom Objective and Evaluation Metric and Custom objective and metric for more information.
```
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.
- Activates early stopping. Validation metric needs to improve at least once in every early_stopping_rounds round(s) to continue training. Requires at least one item in eval_set in fit().
- If early stopping occurs, the model will have two additional attributes: best_score and best_iteration. These are used by the predict() and apply() methods to determine the optimal number of trees during inference. If users want to access the full model (including trees built after early stopping), they can specify the iteration_range in these inference methods. In addition, other utilities like model plotting can also use the entire model.
- If you prefer to discard the trees after best_iteration, consider using the callback function xgboost.callback.EarlyStopping.
- If there’s more than one item in eval_set, the last entry will be used for early stopping. If there’s more than one metric in eval_metric, the last metric will be used for early stopping.
callbacks (Optional[List[xgboost.callback.TrainingCallback]]) –

List of callback functions that are applied at end of each iteration. It is possible to use predefined callbacks by using Callback API.

Note

States in callback are not preserved during training, which means callback objects can not be reused for multiple training sessions without reinitialization or deepcopy.
```
for params in parameters_grid:
    # be sure to (re)initialize the callbacks before each run
    callbacks = [xgb.callback.LearningRateScheduler(custom_rates)]
    reg = xgboost.XGBRegressor(**params, callbacks=callbacks)
    reg.fit(X, y)
```
kwargs (Optional[Any]) –

Keyword arguments for XGBoost Booster object. Full documentation of parameters can be found here. Attempting to set a parameter via the constructor args and **kwargs dict simultaneously will result in a TypeError.

Note

**kwargs unsupported by scikit-learn

**kwargs is unsupported by scikit-learn. We do not guarantee that parameters passed via this argument will interact properly with scikit-learn.

Note

Custom objective function

A custom objective function can be provided for the objective parameter. In this case, it should have the signature objective(y_true, y_pred) -> [grad, hess] or objective(y_true, y_pred, *, sample_weight) -> [grad, hess]:

y_true: array_like of shape [n_samples]

The target values

y_pred: array_like of shape [n_samples]

The predicted values

sample_weight :

Optional sample weights.

grad: array_like of shape [n_samples]

The value of the gradient for each sample point.

hess: array_like of shape [n_samples]

The value of the second derivative for each sample point

Note that, if the custom objective produces negative values for the Hessian, these will be clipped. If the objective is non-convex, one might also consider using the expected Hessian (Fisher information) instead.

apply(X, iteration_range=None)

Return the predicted leaf every tree for each sample. If the model is trained with early stopping, then best_iteration is used automatically.

Parameters:

X (Any) – Input features matrix. See Markers for a list of supported types.
iteration_range (Tuple[int | integer, int | integer] | None) – See predict().

Returns:

X_leaves – For each datapoint x in X and for each tree, return the index of the leaf x ends up in. Leaves are numbered within [0; 2**(self.max_depth+1)), possibly with gaps in the numbering.

Return type:

array_like, shape=[n_samples, n_trees]

property best_iteration: int: The best iteration obtained by early stopping. This attribute is 0-based, for instance if the best iteration is the first round, then best_iteration is 0.

property best_score: float: The best score obtained by early stopping.

property coef_: ndarray

Coefficients property

Note

Coefficients are defined only for linear learners

Coefficients are only defined when the linear model is chosen as base learner (booster=gblinear). It is not defined for other base learner types, such as tree learners (booster=gbtree).

Returns:: coef_
Return type:: array of shape [n_features] or [n_classes, n_features]

evals_result()

Return the evaluation results.

The returned evaluation result is a dictionary:

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

Return type:: evals_result

property feature_importances_: ndarray

Returns:

feature_importances_ (array of shape [n_features] except for multi-class)
linear model, which returns an array with shape (n_features, n_classes)

property feature_names_in_: ndarray: Names of features seen during fit(). Defined only when X has feature names that are all strings.

Fit gradient boosting model.

Note that calling fit() multiple times will cause the model object to be re-fit from scratch. To resume training from a previous checkpoint, explicitly pass xgb_model argument.

Parameters:

X (Any) –

Input feature matrix. See Markers for a list of supported types.

When the tree_method is set to hist, internally, the QuantileDMatrix will be used instead of the DMatrix for conserving memory. However, this has performance implications when the device of input data is not matched with algorithm. For instance, if the input is a numpy array on CPU but cuda is used for training, then the data is first processed on CPU then transferred to GPU.
y (Any) – Labels
sample_weight (Any | None) – instance weights
base_margin (Any | None) – Global bias for each instance. See Intercept for details.
eval_set (Sequence[Tuple[Any, Any]] | None) – A list of (X, y) tuple pairs to use as validation sets, for which metrics will be computed. Validation metrics will help us track the performance of the model.
verbose (bool | int | None) – If verbose is True and an evaluation set is used, the evaluation metric measured on the validation set is printed to stdout at each boosting stage. If verbose is an integer, the evaluation metric is printed at each verbose boosting stage. The last boosting stage / the boosting stage found by using early_stopping_rounds is also printed.
xgb_model (Booster | str | XGBModel | None) – file name of stored XGBoost model or ‘Booster’ instance XGBoost model to be loaded before training (allows training continuation).
sample_weight_eval_set (Sequence[Any] | None) – A list of the form [L_1, L_2, …, L_n], where each L_i is an array like object storing instance weights for the i-th validation set.
base_margin_eval_set (Sequence[Any] | None) – A list of the form [M_1, M_2, …, M_n], where each M_i is an array like object storing base margin for the i-th validation set.
feature_weights (Any | None) –

Deprecated since version 3.0.0.

Use feature_weights in __init__() or set_params() instead.

Return type:

get_booster()

Get the underlying xgboost Booster of this model.

This will raise an exception when fit was not called

Returns:: booster
Return type:: a xgboost booster of underlying model

get_metadata_routing()

Get metadata routing of this object.

Please check User Guide on how the routing mechanism works.

Returns:: routing – A MetadataRequest encapsulating routing information.
Return type:: MetadataRequest

get_num_boosting_rounds()

Gets the number of xgboost boosting rounds.

Return type:: int

get_params(deep=True)

Get parameters.

Parameters:: deep (bool)
Return type:: Dict[str, Any]

get_xgb_params()

Get xgboost specific parameters.

Return type:: Dict[str, Any]

property intercept_: ndarray

Intercept (bias) property

For tree-based model, the returned value is the base_score.

Returns:: intercept_
Return type:: array of shape (1,) or [n_classes]

load_model(fname)

Load the model from a file or a bytearray.

model.save_model("model.json")
model.load_model("model.json")

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

# or
buf = model.save_raw()
model.load_model(buf)

Parameters:: fname (PathLike | bytearray | str) – Input file name or memory buffer(see also save_raw)
Return type:: None

property n_features_in_: int: Number of features seen during fit().

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

Note

This function is only thread safe for gbtree and dart.

Parameters:

X (Any) – Data to predict with. See Markers for a list of supported types.
output_margin (bool) – Whether to output the raw untransformed margin value.
validate_features (bool) – When this is True, validate that the Booster’s and data’s feature_names are identical. Otherwise, it is assumed that the feature_names are the same.
base_margin (Any | None) – Global bias for each instance. See Intercept for details.
iteration_range (Tuple[int | integer, int | integer] | None) –

Specifies which layer of trees are used in prediction. For example, if a random forest is trained with 100 rounds. Specifying iteration_range=(10, 20), then only the forests built during [10, 20) (half open set) rounds are used in this prediction.

Added in version 1.4.0.

Return type:

prediction

save_model(fname)

Save the model to a file.

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

Parameters:: fname (str | PathLike) – Output file name
Return type:: None

score(X, y, sample_weight=None)

Return coefficient of determination on test data.

Parameters:

X (array-like of shape (n_samples, n_features)) – Test samples. For some estimators this may be a precomputed kernel matrix or a list of generic objects instead with shape (n_samples, n_samples_fitted), where n_samples_fitted is the number of samples used in the fitting for the estimator.
y (array-like of shape (n_samples,) or (n_samples, n_outputs)) – True values for X.
sample_weight (array-like of shape (n_samples,), default=None) – Sample weights.

Returns:

score – $R^2$ of self.predict(X) w.r.t. y.

Return type:

Notes

Configure whether metadata should be requested to be passed to the fit method.

Parameters:

self (XGBRFRegressor)
base_margin (bool | None | str)
base_margin_eval_set (bool | None | str)
eval_set (bool | None | str)
feature_weights (bool | None | str)
sample_weight (bool | None | str)
sample_weight_eval_set (bool | None | str)
verbose (bool | None | str)
xgb_model (bool | None | str)

Return type:

set_params(**params)

Return type:: self
Parameters:: params (Any)

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

Configure whether metadata should be requested to be passed to the predict method.

Parameters:

self (XGBRFRegressor)
base_margin (bool | None | str)
iteration_range (bool | None | str)
output_margin (bool | None | str)
validate_features (bool | None | str)

Return type:

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

Configure whether metadata should be requested to be passed to the score method.

Parameters:

self (XGBRFRegressor)
sample_weight (bool | None | str)

Return type:

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

Bases: XGBClassifier

scikit-learn API for XGBoost random forest classification. See Using the Scikit-Learn Estimator Interface for more information.

Parameters:

n_estimators (Optional[int]) – Number of trees in random forest to fit.
max_depth (Optional[int]) – Maximum tree depth for base learners.
max_leaves (Optional[int]) – Maximum number of leaves; 0 indicates no limit.
max_bin (Optional[int]) – If using histogram-based algorithm, maximum number of bins per feature
grow_policy (Optional[str]) –

Tree growing policy.
- depthwise: Favors splitting at nodes closest to the node,
- lossguide: Favors splitting at nodes with highest loss change.
learning_rate (Optional[float]) – Boosting learning rate (xgb’s “eta”)
verbosity (Optional[int]) – The degree of verbosity. Valid values are 0 (silent) - 3 (debug).
objective (Union[str, xgboost.sklearn._SklObjWProto, Callable[[Any, Any], Tuple[numpy.ndarray, numpy.ndarray]], NoneType]) –

Specify the learning task and the corresponding learning objective or a custom objective function to be used.

For custom objective, see Custom Objective and Evaluation Metric and Custom objective and metric for more information, along with the end note for function signatures.
booster (Optional[str]) – Specify which booster to use: gbtree, gblinear or dart.
tree_method (Optional[str]) – Specify which tree method to use. Default to auto. If this parameter is set to default, XGBoost will choose the most conservative option available. It’s recommended to study this option from the parameters document tree method
n_jobs (Optional[int]) – Number of parallel threads used to run xgboost. When used with other Scikit-Learn algorithms like grid search, you may choose which algorithm to parallelize and balance the threads. Creating thread contention will significantly slow down both algorithms.
gamma (Optional[float]) – (min_split_loss) Minimum loss reduction required to make a further partition on a leaf node of the tree.
min_child_weight (Optional[float]) – Minimum sum of instance weight(hessian) needed in a child.
max_delta_step (Optional[float]) – Maximum delta step we allow each tree’s weight estimation to be.
subsample (Optional[float]) – Subsample ratio of the training instance.
sampling_method (Optional[str]) –

Sampling method. Used only by the GPU version of hist tree method.
- uniform: Select random training instances uniformly.
- gradient_based: Select random training instances with higher probability
  
  when the gradient and hessian are larger. (cf. CatBoost)
colsample_bytree (Optional[float]) – Subsample ratio of columns when constructing each tree.
colsample_bylevel (Optional[float]) – Subsample ratio of columns for each level.
colsample_bynode (Optional[float]) – Subsample ratio of columns for each split.
reg_alpha (Optional[float]) – L1 regularization term on weights (xgb’s alpha).
reg_lambda (Optional[float]) – L2 regularization term on weights (xgb’s lambda).
scale_pos_weight (Optional[float]) – Balancing of positive and negative weights.
base_score (Optional[float]) – The initial prediction score of all instances, global bias.
random_state (Union[numpy.random.mtrand.RandomState, numpy.random._generator.Generator, int, NoneType]) –

Random number seed.

Note

Using gblinear booster with shotgun updater is nondeterministic as it uses Hogwild algorithm.
missing (float) – Value in the data which needs to be present as a missing value. Default to numpy.nan.
num_parallel_tree (Optional[int]) – Used for boosting random forest.
monotone_constraints (Union[Dict[str, int], str, NoneType]) – Constraint of variable monotonicity. See tutorial for more information.
interaction_constraints (Union[str, List[Tuple[str]], NoneType]) – Constraints for interaction representing permitted interactions. The constraints must be specified in the form of a nested list, e.g. [[0, 1], [2, 3, 4]], where each inner list is a group of indices of features that are allowed to interact with each other. See tutorial for more information
importance_type (Optional[str]) –

The feature importance type for the feature_importances_ property:
- For tree model, it’s either “gain”, “weight”, “cover”, “total_gain” or “total_cover”.
- For linear model, only “weight” is defined and it’s the normalized coefficients without bias.
device (Optional[str]) –

Added in version 2.0.0.

Device ordinal, available options are cpu, cuda, and gpu.
validate_parameters (Optional[bool]) – Give warnings for unknown parameter.
enable_categorical (bool) – See the same parameter of DMatrix for details.
feature_types (Optional[Sequence[str]]) –

Added in version 1.7.0.

Used for specifying feature types without constructing a dataframe. See the DMatrix for details.
feature_weights (Optional[ArrayLike]) – Weight for each feature, defines the probability of each feature being selected when colsample is being used. All values must be greater than 0, otherwise a ValueError is thrown.
max_cat_to_onehot (Optional[int]) –

Added in version 1.6.0.

Note

This parameter is experimental

A threshold for deciding whether XGBoost should use one-hot encoding based split for categorical data. When number of categories is lesser than the threshold then one-hot encoding is chosen, otherwise the categories will be partitioned into children nodes. Also, enable_categorical needs to be set to have categorical feature support. See Categorical Data and Parameters for Categorical Feature for details.
max_cat_threshold (Optional[int]) –

Added in version 1.7.0.

Note

This parameter is experimental

Maximum number of categories considered for each split. Used only by partition-based splits for preventing over-fitting. Also, enable_categorical needs to be set to have categorical feature support. See Categorical Data and Parameters for Categorical Feature for details.
multi_strategy (Optional[str]) –

Added in version 2.0.0.

Note

This parameter is working-in-progress.

The strategy used for training multi-target models, including multi-target regression and multi-class classification. See Multiple Outputs for more information.
- one_output_per_tree: One model for each target.
- multi_output_tree: Use multi-target trees.
eval_metric (Union[str, List[Union[str, Callable]], Callable, NoneType]) –

Added in version 1.6.0.

Metric used for monitoring the training result and early stopping. It can be a string or list of strings as names of predefined metric in XGBoost (See XGBoost Parameters), one of the metrics in sklearn.metrics, or any other user defined metric that looks like sklearn.metrics.

If custom objective is also provided, then custom metric should implement the corresponding reverse link function.

Unlike the scoring parameter commonly used in scikit-learn, when a callable object is provided, it’s assumed to be a cost function and by default XGBoost will minimize the result during early stopping.

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

See Custom Objective and Evaluation Metric and Custom objective and metric for more information.
```
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.
- Activates early stopping. Validation metric needs to improve at least once in every early_stopping_rounds round(s) to continue training. Requires at least one item in eval_set in fit().
- If early stopping occurs, the model will have two additional attributes: best_score and best_iteration. These are used by the predict() and apply() methods to determine the optimal number of trees during inference. If users want to access the full model (including trees built after early stopping), they can specify the iteration_range in these inference methods. In addition, other utilities like model plotting can also use the entire model.
- If you prefer to discard the trees after best_iteration, consider using the callback function xgboost.callback.EarlyStopping.
- If there’s more than one item in eval_set, the last entry will be used for early stopping. If there’s more than one metric in eval_metric, the last metric will be used for early stopping.
callbacks (Optional[List[xgboost.callback.TrainingCallback]]) –

List of callback functions that are applied at end of each iteration. It is possible to use predefined callbacks by using Callback API.

Note

States in callback are not preserved during training, which means callback objects can not be reused for multiple training sessions without reinitialization or deepcopy.
```
for params in parameters_grid:
    # be sure to (re)initialize the callbacks before each run
    callbacks = [xgb.callback.LearningRateScheduler(custom_rates)]
    reg = xgboost.XGBRegressor(**params, callbacks=callbacks)
    reg.fit(X, y)
```
kwargs (Optional[Any]) –

Keyword arguments for XGBoost Booster object. Full documentation of parameters can be found here. Attempting to set a parameter via the constructor args and **kwargs dict simultaneously will result in a TypeError.

Note

**kwargs unsupported by scikit-learn

**kwargs is unsupported by scikit-learn. We do not guarantee that parameters passed via this argument will interact properly with scikit-learn.

Note

Custom objective function

A custom objective function can be provided for the objective parameter. In this case, it should have the signature objective(y_true, y_pred) -> [grad, hess] or objective(y_true, y_pred, *, sample_weight) -> [grad, hess]:

y_true: array_like of shape [n_samples]

The target values

y_pred: array_like of shape [n_samples]

The predicted values

sample_weight :

Optional sample weights.

grad: array_like of shape [n_samples]

The value of the gradient for each sample point.

hess: array_like of shape [n_samples]

The value of the second derivative for each sample point

Note that, if the custom objective produces negative values for the Hessian, these will be clipped. If the objective is non-convex, one might also consider using the expected Hessian (Fisher information) instead.

apply(X, iteration_range=None)

Return the predicted leaf every tree for each sample. If the model is trained with early stopping, then best_iteration is used automatically.

Parameters:

X (Any) – Input features matrix. See Markers for a list of supported types.
iteration_range (Tuple[int | integer, int | integer] | None) – See predict().

Returns:

X_leaves – For each datapoint x in X and for each tree, return the index of the leaf x ends up in. Leaves are numbered within [0; 2**(self.max_depth+1)), possibly with gaps in the numbering.

Return type:

array_like, shape=[n_samples, n_trees]

property best_iteration: int: The best iteration obtained by early stopping. This attribute is 0-based, for instance if the best iteration is the first round, then best_iteration is 0.

property best_score: float: The best score obtained by early stopping.

property coef_: ndarray

Coefficients property

Note

Coefficients are defined only for linear learners

Coefficients are only defined when the linear model is chosen as base learner (booster=gblinear). It is not defined for other base learner types, such as tree learners (booster=gbtree).

Returns:: coef_
Return type:: array of shape [n_features] or [n_classes, n_features]

evals_result()

Return the evaluation results.

The returned evaluation result is a dictionary:

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

Return type:: evals_result

property feature_importances_: ndarray

Returns:

feature_importances_ (array of shape [n_features] except for multi-class)
linear model, which returns an array with shape (n_features, n_classes)

property feature_names_in_: ndarray: Names of features seen during fit(). Defined only when X has feature names that are all strings.

Fit gradient boosting classifier.

Note that calling fit() multiple times will cause the model object to be re-fit from scratch. To resume training from a previous checkpoint, explicitly pass xgb_model argument.

Parameters:

X (Any) –

Input feature matrix. See Markers for a list of supported types.

When the tree_method is set to hist, internally, the QuantileDMatrix will be used instead of the DMatrix for conserving memory. However, this has performance implications when the device of input data is not matched with algorithm. For instance, if the input is a numpy array on CPU but cuda is used for training, then the data is first processed on CPU then transferred to GPU.
y (Any) – Labels
sample_weight (Any | None) – instance weights
base_margin (Any | None) – Global bias for each instance. See Intercept for details.
eval_set (Sequence[Tuple[Any, Any]] | None) – A list of (X, y) tuple pairs to use as validation sets, for which metrics will be computed. Validation metrics will help us track the performance of the model.
verbose (bool | int | None) – If verbose is True and an evaluation set is used, the evaluation metric measured on the validation set is printed to stdout at each boosting stage. If verbose is an integer, the evaluation metric is printed at each verbose boosting stage. The last boosting stage / the boosting stage found by using early_stopping_rounds is also printed.
xgb_model (Booster | str | XGBModel | None) – file name of stored XGBoost model or ‘Booster’ instance XGBoost model to be loaded before training (allows training continuation).
sample_weight_eval_set (Sequence[Any] | None) – A list of the form [L_1, L_2, …, L_n], where each L_i is an array like object storing instance weights for the i-th validation set.
base_margin_eval_set (Sequence[Any] | None) – A list of the form [M_1, M_2, …, M_n], where each M_i is an array like object storing base margin for the i-th validation set.
feature_weights (Any | None) –

Deprecated since version 3.0.0.

Use feature_weights in __init__() or set_params() instead.

Return type:

get_booster()

Get the underlying xgboost Booster of this model.

This will raise an exception when fit was not called

Returns:: booster
Return type:: a xgboost booster of underlying model

get_metadata_routing()

Get metadata routing of this object.

Please check User Guide on how the routing mechanism works.

Returns:: routing – A MetadataRequest encapsulating routing information.
Return type:: MetadataRequest

get_num_boosting_rounds()

Gets the number of xgboost boosting rounds.

Return type:: int

get_params(deep=True)

Get parameters.

Parameters:: deep (bool)
Return type:: Dict[str, Any]

get_xgb_params()

Get xgboost specific parameters.

Return type:: Dict[str, Any]

property intercept_: ndarray

Intercept (bias) property

For tree-based model, the returned value is the base_score.

Returns:: intercept_
Return type:: array of shape (1,) or [n_classes]

load_model(fname)

Load the model from a file or a bytearray.

model.save_model("model.json")
model.load_model("model.json")

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

# or
buf = model.save_raw()
model.load_model(buf)

Parameters:: fname (PathLike | bytearray | str) – Input file name or memory buffer(see also save_raw)
Return type:: None

property n_features_in_: int: Number of features seen during fit().

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

Note

This function is only thread safe for gbtree and dart.

Parameters:

X (Any) – Data to predict with. See Markers for a list of supported types.
output_margin (bool) – Whether to output the raw untransformed margin value.
validate_features (bool) – When this is True, validate that the Booster’s and data’s feature_names are identical. Otherwise, it is assumed that the feature_names are the same.
base_margin (Any | None) – Global bias for each instance. See Intercept for details.
iteration_range (Tuple[int | integer, int | integer] | None) –

Specifies which layer of trees are used in prediction. For example, if a random forest is trained with 100 rounds. Specifying iteration_range=(10, 20), then only the forests built during [10, 20) (half open set) rounds are used in this prediction.

Added in version 1.4.0.

Return type:

prediction

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

Note

This function is only thread safe for gbtree and dart.

Parameters:

X (Any) – Feature matrix. See Markers for a list of supported types.
validate_features (bool) – When this is True, validate that the Booster’s and data’s feature_names are identical. Otherwise, it is assumed that the feature_names are the same.
base_margin (Any | None) – Global bias for each instance. See Intercept for details.
iteration_range (Tuple[int | integer, int | integer] | None) – Specifies which layer of trees are used in prediction. For example, if a random forest is trained with 100 rounds. Specifying iteration_range=(10, 20), then only the forests built during [10, 20) (half open set) rounds are used in this prediction.

Returns:

a numpy array of shape array-like of shape (n_samples, n_classes) with the probability of each data example being of a given class.

Return type:

prediction

save_model(fname)

Save the model to a file.

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

Parameters:: fname (str | PathLike) – Output file name
Return type:: None

score(X, y, sample_weight=None)

Return accuracy on provided data and labels.

In multi-label classification, this is the subset accuracy which is a harsh metric since you require for each sample that each label set be correctly predicted.

Parameters:

X (array-like of shape (n_samples, n_features)) – Test samples.
y (array-like of shape (n_samples,) or (n_samples, n_outputs)) – True labels for X.
sample_weight (array-like of shape (n_samples,), default=None) – Sample weights.

Returns:

score – Mean accuracy of self.predict(X) w.r.t. y.

Return type:

Configure whether metadata should be requested to be passed to the fit method.

Parameters:

self (XGBRFClassifier)
base_margin (bool | None | str)
base_margin_eval_set (bool | None | str)
eval_set (bool | None | str)
feature_weights (bool | None | str)
sample_weight (bool | None | str)
sample_weight_eval_set (bool | None | str)
verbose (bool | None | str)
xgb_model (bool | None | str)

Return type:

set_params(**params)

Return type:: self
Parameters:: params (Any)

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

Configure whether metadata should be requested to be passed to the predict_proba method.

Parameters:

self (XGBRFClassifier)
base_margin (bool | None | str)
iteration_range (bool | None | str)
validate_features (bool | None | str)

Return type:

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

Configure whether metadata should be requested to be passed to the predict method.

Parameters:

self (XGBRFClassifier)
base_margin (bool | None | str)
iteration_range (bool | None | str)
output_margin (bool | None | str)
validate_features (bool | None | str)

Return type:

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

Configure whether metadata should be requested to be passed to the score method.

Parameters:

self (XGBRFClassifier)
sample_weight (bool | None | str)

Return type:

Plotting API

Plotting Library.

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

Plot importance based on fitted trees.

Parameters:

booster (XGBModel | Booster | dict) – Booster or XGBModel instance, or dict taken by Booster.get_fscore()
ax (matplotlib Axes) – Target axes instance. If None, new figure and axes will be created.
grid (bool) – Turn the axes grids on or off. Default is True (On).
importance_type (str) –

How the importance is calculated: either “weight”, “gain”, or “cover”
- ”weight” is the number of times a feature appears in a tree
- ”gain” is the average gain of splits which use the feature
- ”cover” is the average coverage of splits which use the feature where coverage is defined as the number of samples affected by the split
max_num_features (int | None) – Maximum number of top features displayed on plot. If None, all features will be displayed.
height (float) – Bar height, passed to ax.barh()
xlim (tuple | None) – Tuple passed to axes.xlim()
ylim (tuple | None) – Tuple passed to axes.ylim()
title (str) – Axes title. To disable, pass None.
xlabel (str) – X axis title label. To disable, pass None.
ylabel (str) – Y axis title label. To disable, pass None.
fmap (str | PathLike) – The name of feature map file.
show_values (bool) – Show values on plot. To disable, pass False.
values_format (str) – Format string for values. “v” will be replaced by the value of the feature importance. e.g. Pass “{v:.2f}” in order to limit the number of digits after the decimal point to two, for each value printed on the graph.
kwargs (Any) – Other keywords passed to ax.barh()

Returns:

Return type:

matplotlib Axes

xgboost.plot_tree(booster, *, fmap='', num_trees=None, rankdir=None, ax=None, with_stats=False, tree_idx=0, **kwargs)

Plot specified tree.

Parameters:

booster (Booster | XGBModel) – Booster or XGBModel instance
fmap (str (optional)) – The name of feature map file
num_trees (int | None) –

Deprecated since version 3.0.
rankdir (str, default "TB") – Passed to graphviz via graph_attr
ax (matplotlib Axes, default None) – Target axes instance. If None, new figure and axes will be created.
with_stats (bool) –

Added in version 3.0.

See to_graphviz().
tree_idx (int) –

Added in version 3.0.

See to_graphviz().
kwargs (Any) – Other keywords passed to to_graphviz()

Returns:

Return type:

matplotlib Axes

xgboost.to_graphviz(booster, *, fmap='', num_trees=None, rankdir=None, yes_color=None, no_color=None, condition_node_params=None, leaf_node_params=None, with_stats=False, tree_idx=0, **kwargs)

Convert specified tree to graphviz instance. IPython can automatically plot the returned graphviz instance. Otherwise, you should call .render() method of the returned graphviz instance.

Parameters:

booster (Booster | XGBModel) – Booster or XGBModel instance
fmap (str | PathLike) – The name of feature map file
num_trees (int | None) –

Deprecated since version 3.0.

Specify the ordinal number of target tree
rankdir (str | None) – Passed to graphviz via graph_attr
yes_color (str | None) – Edge color when meets the node condition.
no_color (str | None) – Edge color when doesn’t meet the node condition.
condition_node_params (dict | None) –

Condition node configuration for for graphviz. Example:
```
{'shape': 'box',
 'style': 'filled,rounded',
 'fillcolor': '#78bceb'}
```
leaf_node_params (dict | None) –

Leaf node configuration for graphviz. Example:
```
{'shape': 'box',
 'style': 'filled',
 'fillcolor': '#e48038'}
```
with_stats (bool) –

Added in version 3.0.

Controls whether the split statistics should be included.
tree_idx (int) –

Added in version 3.0.

Specify the ordinal index of target tree.
kwargs (Any) – Other keywords passed to graphviz graph_attr, e.g. graph [ {key} = {value} ]

Returns:

graph

Return type:

graphviz.Source

Callback API

Callback library containing training routines. See Callback Functions for a quick introduction.

class xgboost.callback.TrainingCallback

Interface for training callback.

Added in version 1.3.0.

after_iteration(model, epoch, evals_log)

Run after each iteration. Returns True when training should stop.

Parameters:

model (Any) – Eeither a Booster object or a CVPack if the cv function in xgboost is being used.
epoch (int) – The current training iteration.
evals_log (Dict[str, Dict[str, List[float] | List[Tuple[float, float]]]]) –

A dictionary containing the evaluation history:
```
{"data_name": {"metric_name": [0.5, ...]}}
```

Return type:

after_training(model)

Run after training is finished.

Parameters:: model (Any)
Return type:: Any

before_iteration(model, epoch, evals_log)

Run before each iteration. Returns True when training should stop. See after_iteration() for details.

Parameters:

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

Return type:

before_training(model)

Run before training starts.

Parameters:: model (Any)
Return type:: Any

class xgboost.callback.EvaluationMonitor(rank=0, period=1, show_stdv=False, logger=<function communicator_print>)

Print the evaluation result at each iteration.

Added in version 1.3.0.

Parameters:

rank (int) – Which worker should be used for printing the result.
period (int) – How many epoches between printing.
show_stdv (bool) – Used in cv to show standard deviation. Users should not specify it.
logger (Callable[[str], None]) – A callable used for logging evaluation result.

after_iteration(model, epoch, evals_log)

Run after each iteration. Returns True when training should stop.

Parameters:

model (Any) – Eeither a Booster object or a CVPack if the cv function in xgboost is being used.
epoch (int) – The current training iteration.
evals_log (Dict[str, Dict[str, List[float] | List[Tuple[float, float]]]]) –

A dictionary containing the evaluation history:
```
{"data_name": {"metric_name": [0.5, ...]}}
```

Return type:

after_training(model)

Run after training is finished.

Parameters:: model (Any)
Return type:: Any

class xgboost.callback.EarlyStopping(*, rounds, metric_name=None, data_name=None, maximize=None, save_best=False, min_delta=0.0)

Callback function for early stopping

Added in version 1.3.0.

Parameters:

rounds (int) – Early stopping rounds.
metric_name (str | None) – Name of metric that is used for early stopping.
data_name (str | None) – Name of dataset that is used for early stopping.
maximize (bool | None) – Whether to maximize evaluation metric. None means auto (discouraged).
save_best (bool | None) – Whether training should return the best model or the last model. If set to True, it will only keep the boosting rounds up to the detected best iteration, discarding the ones that come after. This is only supported with tree methods (not gblinear). Also, the cv function doesn’t return a model, the parameter is not applicable.
min_delta (float) –

Added in version 1.5.0.

Minimum absolute change in score to be qualified as an improvement.

Examples

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)

Run after each iteration. Returns True when training should stop.

Parameters:

model (Any) – Eeither a Booster object or a CVPack if the cv function in xgboost is being used.
epoch (int) – The current training iteration.
evals_log (Dict[str, Dict[str, List[float] | List[Tuple[float, float]]]]) –

A dictionary containing the evaluation history:
```
{"data_name": {"metric_name": [0.5, ...]}}
```

Return type:

after_training(model)

Run after training is finished.

Parameters:: model (Any)
Return type:: Any

before_training(model)

Run before training starts.

Parameters:: model (Any)
Return type:: Any

class xgboost.callback.LearningRateScheduler(learning_rates)

Callback function for scheduling learning rate.

Added in version 1.3.0.

Parameters:: learning_rates (Callable[[int], float] | Sequence[float]) – If it’s a callable object, then it should accept an integer parameter epoch and returns the corresponding learning rate. Otherwise it should be a sequence like list or tuple with the same size of boosting rounds.

after_iteration(model, epoch, evals_log)

Run after each iteration. Returns True when training should stop.

Parameters:

model (Any) – Eeither a Booster object or a CVPack if the cv function in xgboost is being used.
epoch (int) – The current training iteration.
evals_log (Dict[str, Dict[str, List[float] | List[Tuple[float, float]]]]) –

A dictionary containing the evaluation history:
```
{"data_name": {"metric_name": [0.5, ...]}}
```

Return type:

class xgboost.callback.TrainingCheckPoint(directory, name='model', as_pickle=False, interval=100)

Checkpointing operation. Users are encouraged to create their own callbacks for checkpoint as XGBoost doesn’t handle distributed file systems. When checkpointing on distributed systems, be sure to know the rank of the worker to avoid multiple workers checkpointing to the same place.

Added in version 1.3.0.

Since XGBoost 2.1.0, the default format is changed to UBJSON.

Parameters:

directory (str | PathLike) – Output model directory.
name (str) – pattern of output model file. Models will be saved as name_0.ubj, name_1.ubj, name_2.ubj ….
as_pickle (bool) – When set to True, all training parameters will be saved in pickle format, instead of saving only the model.
interval (int) – Interval of checkpointing. Checkpointing is slow so setting a larger number can reduce performance hit.

after_iteration(model, epoch, evals_log)

Run after each iteration. Returns True when training should stop.

Parameters:

model (Any) – Eeither a Booster object or a CVPack if the cv function in xgboost is being used.
epoch (int) – The current training iteration.
evals_log (Dict[str, Dict[str, List[float] | List[Tuple[float, float]]]]) –

A dictionary containing the evaluation history:
```
{"data_name": {"metric_name": [0.5, ...]}}
```

Return type: