Skip to content

xgboost 3.2.0

Version history | Download JSON

  • PyPI https://pypi.org/project/xgboost/
    Repository https://github.com/dmlc/xgboost

  • py.typed

  • Coverage

    %%{init: {"pie": {"textPosition": 0.85}, "theme": "neutral", "themeVariables": {"pieStrokeWidth": "1px"}}}%%
pie title
    "Typed" : 1789
    "Any" : 80
    "Untyped" : 149
    • 92.6% coverage
    • 88.7% coverage (strict)
    • 2018 typable
      • 1789 typed
      • 149 untyped
      • 80 Any

  • Typables

    %%{init: {"pie": {"textPosition": 0.85}, "theme": "neutral", "themeVariables": {"pieStrokeWidth": "1px"}}}%%
pie title
    "functions" : 861
    "classes" : 992
    "other" : 31
    • 272 functions (+3 overloads)
      • 589 parameters
    • 75 classes
      • 267 methods (+0 overloads)
        • 699 parameters
      • 20 properties
    • 47 modules
      • 31 attrs

Modules

Module Coverage Coverage (strict) Typables Ignores
xgboost.callback 87.9% 64.5% 107 0
xgboost.collective 92.0% 84.0% 25 0
xgboost.compat 100.0% 94.4% 18 3
xgboost.config 100.0% 81.8% 11 0
xgboost.core 94.6% 93.3% 298 0
xgboost.dask 97.0% 94.0% 232 0
xgboost.dask.data 95.5% 90.9% 22 0
xgboost.dask.utils 85.7% 85.7% 7 0
xgboost.data 92.9% 85.7% 70 0
xgboost.federated 94.1% 94.1% 17 0
xgboost.libpath 100.0% 100.0% 2 0
xgboost.objective 100.0% 100.0% 8 0
xgboost.plotting 100.0% 83.8% 37 0
xgboost.sklearn 84.0% 80.3% 269 0
xgboost.spark.core 64.0% 64.0% 25 0
xgboost.spark.data 97.2% 94.4% 36 0
xgboost.spark.estimator 100.0% 95.2% 63 0
xgboost.spark.params 50.0% 50.0% 8 0
xgboost.spark.summary 100.0% 100.0% 2 0
xgboost.spark.utils 100.0% 100.0% 19 0
xgboost.testing 91.4% 85.2% 128 0
xgboost.testing.basic_models 100.0% 100.0% 5 0
xgboost.testing.callbacks 100.0% 100.0% 12 0
xgboost.testing.collective 100.0% 100.0% 1 0
xgboost.testing.continuation 100.0% 100.0% 3 0
xgboost.testing.dask 100.0% 97.9% 48 0
xgboost.testing.data 90.9% 90.9% 88 0
xgboost.testing.data_iter 76.9% 76.9% 26 0
xgboost.testing.federated 100.0% 100.0% 18 0
xgboost.testing.interaction_constraints 100.0% 100.0% 9 0
xgboost.testing.intercept 100.0% 100.0% 11 0
xgboost.testing.metrics 100.0% 100.0% 24 0
xgboost.testing.monotone_constraints 53.8% 53.8% 13 0
xgboost.testing.multi_target 96.1% 96.1% 77 0
xgboost.testing.ordinal 100.0% 97.7% 44 0
xgboost.testing.params 0.0% 0.0% 7 0
xgboost.testing.parse_tree 100.0% 100.0% 6 0
xgboost.testing.plotting 100.0% 100.0% 3 0
xgboost.testing.predict 100.0% 100.0% 5 0
xgboost.testing.quantile_dmatrix 100.0% 100.0% 4 0
xgboost.testing.ranking 100.0% 100.0% 11 0
xgboost.testing.shared 100.0% 100.0% 15 0
xgboost.testing.updater 100.0% 98.4% 64 0
xgboost.testing.utils 100.0% 87.5% 16 0
xgboost.testing.with_skl 100.0% 100.0% 20 0
xgboost.tracker 93.3% 93.3% 15 0
xgboost.training 94.2% 94.2% 69 0

Incomplete Annotations

xgboost.callback (13 missing, 25 any)

Symbol Typable Typed Any
meth LearningRateScheduler.after_iteration 4 4 1
attr LearningRateScheduler.learning_rates 1 0 0
meth EarlyStopping.before_training 2 2 2
meth EarlyStopping._update_rounds 6 6 1
meth EarlyStopping.after_iteration 4 4 1
meth EarlyStopping.after_training 2 2 2
attr EarlyStopping.data 1 0 0
attr EarlyStopping.metric_name 1 0 0
attr EarlyStopping.rounds 1 0 0
attr EarlyStopping.save_best 1 0 0
attr EarlyStopping.maximize 1 0 0
meth TrainingCheckPoint.before_training 2 2 2
meth TrainingCheckPoint.after_iteration 4 4 1
meth CallbackContainer.before_training 2 2 2
meth CallbackContainer.after_training 2 2 2
meth CallbackContainer.before_iteration 5 5 1
meth CallbackContainer.after_iteration 5 5 1
attr CallbackContainer.callbacks 1 0 0
attr CallbackContainer.metric 1 0 0
attr CallbackContainer.is_cv 1 0 0
meth EvaluationMonitor.init 5 4 0
meth EvaluationMonitor.after_iteration 4 4 1
meth EvaluationMonitor.after_training 2 2 2
attr EvaluationMonitor.printer_rank 1 0 0
attr EvaluationMonitor.show_stdv 1 0 0
attr EvaluationMonitor.period 1 0 0
meth TrainingCallback.before_training 2 2 2
meth TrainingCallback.after_training 2 2 2
meth TrainingCallback.before_iteration 4 4 1
meth TrainingCallback.after_iteration 4 4 1

xgboost.collective (2 missing, 2 any)

Symbol Typable Typed Any
attr LOGGER 1 0 0
func communicator_print 2 2 1
meth CommunicatorContext.exit 2 2 1
attr CommunicatorContext.args 1 0 0

xgboost.compat (0 missing, 1 any)

Symbol Typable Typed Any
func lazy_isinstance 4 4 1

xgboost.config (0 missing, 2 any)

Symbol Typable Typed Any
func set_config 2 2 1
func config_context 2 2 1

xgboost.core (16 missing, 4 any)

Symbol Typable Typed Any
attr DataIter.cache_prefix 1 0 0
attr DataIter.on_host 1 0 0
attr DataIter.min_cache_page_bytes 1 0 0
attr DMatrix.missing 1 0 0
attr DMatrix.nthread 1 0 0
attr DMatrix.silent 1 0 0
attr DMatrix.handle 1 0 0
attr DMatrix.feature_names 1 0 0
attr DMatrix.feature_types 1 0 0
meth Booster.deepcopy 2 2 1
meth Booster.inplace_predict 8 8 1
attr ExtMemQuantileDMatrix.max_bin 1 0 0
attr ExtMemQuantileDMatrix.missing 1 0 0
attr ExtMemQuantileDMatrix.nthread 1 0 0
meth QuantileDMatrix._init 6 6 1
attr QuantileDMatrix.max_bin 1 0 0
attr QuantileDMatrix.missing 1 0 0
attr QuantileDMatrix.nthread 1 0 0
attr QuantileDMatrix.handle 1 0 0
func make_jcargs 2 2 1

xgboost.dask (7 missing, 7 any)

Symbol Typable Typed Any
meth DaskXGBRanker.init 5 5 1
attr DaskXGBRanker.allow_group_split 1 0 0
func predict 13 13 1
meth DaskXGBRFRegressor.init 7 7 1
meth DaskXGBClassifier.predict_proba 5 5 1
func inplace_predict 10 10 1
attr DaskDMatrix.feature_names 1 0 0
attr DaskDMatrix.feature_types 1 0 0
attr DaskDMatrix.missing 1 0 0
attr DaskDMatrix.enable_categorical 1 0 0
attr DaskQuantileDMatrix.max_bin 1 0 0
attr DaskQuantileDMatrix.max_quantile_batches 1 0 0
func train 13 13 1
meth DaskXGBRFClassifier.init 7 7 1

xgboost.dask.data (1 missing, 1 any)

Symbol Typable Typed Any
attr LOGGER 1 0 0
meth DaskPartitionIter.data 1 1 1

xgboost.dask.utils (1 missing, 0 any)

Symbol Typable Typed Any
attr LOGGER 1 0 0

xgboost.data (5 missing, 5 any)

Symbol Typable Typed Any
func pandas_pa_type 2 2 1
attr CudfTransformed.columns 1 0 0
meth SingleBatchInternalIter.init 2 2 1
attr SingleBatchInternalIter.kwargs 1 0 0
attr SingleBatchInternalIter.it 1 0 0
func is_pa_ext_dtype 2 2 1
attr PandasTransformed.columns 1 0 0
func is_pa_ext_categorical_dtype 2 2 1
func is_on_cuda 2 2 1
attr ArrowTransformed.columns 1 0 0

xgboost.federated (1 missing, 0 any)

Symbol Typable Typed Any
attr FederatedTracker.handle 1 0 0

xgboost.plotting (0 missing, 6 any)

Symbol Typable Typed Any
func plot_tree 9 9 2
func to_graphviz 12 12 2
func plot_importance 16 16 2

xgboost.sklearn (43 missing, 10 any)

Symbol Typable Typed Any
meth XGBRFClassifier.init 6 5 1
meth XGBRegressor.init 3 3 1
meth XGBRanker.init 3 2 1
meth XGBRanker._create_ltr_dmatrix 5 5 1
meth XGBModel.init 42 42 1
meth XGBModel.set_params 2 2 1
meth XGBModel._create_dmatrix 3 3 1
attr XGBModel.n_estimators 1 0 0
attr XGBModel.objective 1 0 0
attr XGBModel.max_depth 1 0 0
attr XGBModel.max_leaves 1 0 0
attr XGBModel.max_bin 1 0 0
attr XGBModel.grow_policy 1 0 0
attr XGBModel.learning_rate 1 0 0
attr XGBModel.verbosity 1 0 0
attr XGBModel.booster 1 0 0
attr XGBModel.tree_method 1 0 0
attr XGBModel.gamma 1 0 0
attr XGBModel.min_child_weight 1 0 0
attr XGBModel.max_delta_step 1 0 0
attr XGBModel.subsample 1 0 0
attr XGBModel.sampling_method 1 0 0
attr XGBModel.colsample_bytree 1 0 0
attr XGBModel.colsample_bylevel 1 0 0
attr XGBModel.colsample_bynode 1 0 0
attr XGBModel.reg_alpha 1 0 0
attr XGBModel.reg_lambda 1 0 0
attr XGBModel.scale_pos_weight 1 0 0
attr XGBModel.base_score 1 0 0
attr XGBModel.missing 1 0 0
attr XGBModel.num_parallel_tree 1 0 0
attr XGBModel.random_state 1 0 0
attr XGBModel.n_jobs 1 0 0
attr XGBModel.monotone_constraints 1 0 0
attr XGBModel.interaction_constraints 1 0 0
attr XGBModel.importance_type 1 0 0
attr XGBModel.device 1 0 0
attr XGBModel.validate_parameters 1 0 0
attr XGBModel.enable_categorical 1 0 0
attr XGBModel.feature_types 1 0 0
attr XGBModel.feature_weights 1 0 0
attr XGBModel.max_cat_to_onehot 1 0 0
attr XGBModel.max_cat_threshold 1 0 0
attr XGBModel.multi_strategy 1 0 0
attr XGBModel.eval_metric 1 0 0
attr XGBModel.early_stopping_rounds 1 0 0
attr XGBModel.callbacks 1 0 0
attr XGBModel.kwargs 1 0 0
meth XGBClassifier.init 3 3 1
meth XGBRFRegressor.init 6 6 1
func pick_ref_categories 4 4 1

xgboost.spark.core (9 missing, 0 any)

Symbol Typable Typed Any
attr SparkXGBModelReader.cls 1 0 0
attr SparkXGBModelReader.logger 1 0 0
attr SparkXGBModelWriter.instance 1 0 0
attr SparkXGBModelWriter.logger 1 0 0
attr SparkXGBReader.cls 1 0 0
attr SparkXGBReader.logger 1 0 0
attr pred 1 0 0
attr SparkXGBWriter.instance 1 0 0
attr SparkXGBWriter.logger 1 0 0

xgboost.spark.data (1 missing, 1 any)

Symbol Typable Typed Any
meth PartIter.init 4 4 1
attr alias 1 0 0

xgboost.spark.estimator (0 missing, 3 any)

Symbol Typable Typed Any
meth SparkXGBClassifier.init 18 18 1
meth SparkXGBRanker.init 17 17 1
meth SparkXGBRegressor.init 16 16 1

xgboost.spark.params (4 missing, 0 any)

Symbol Typable Typed Any
attr HasFeaturesCols.features_cols 1 0 0
attr HasBaseMarginCol.base_margin_col 1 0 0
attr HasEnableSparseDataOptim.enable_sparse_data_optim 1 0 0
attr HasQueryIdCol.qid_col 1 0 0

xgboost.testing (11 missing, 8 any)

Symbol Typable Typed Any
attr sparse_datasets_strategy 1 0 0
attr TestDataset.name 1 0 0
attr TestDataset.objective 1 0 0
attr TestDataset.metric 1 0 0
attr datasets 1 0 0
attr multi_dataset_strategy 1 0 0
func timeout 5 5 3
func setup_rmm_pool 3 3 1
meth DirectoryExcursion.init 3 2 0
meth DirectoryExcursion.exit 2 2 1
attr DirectoryExcursion.path 1 0 0
attr DirectoryExcursion.curdir 1 0 0
attr DirectoryExcursion.cleanup 1 0 0
func no_multiple 2 2 1
func run_with_rabit 5 5 2
attr hypothesis 1 0 0

xgboost.testing.dask (0 missing, 1 any)

Symbol Typable Typed Any
func get_rabit_args 3 3 1

xgboost.testing.data (8 missing, 0 any)

Symbol Typable Typed Any
attr IteratorForTest.X 1 0 0
attr IteratorForTest.y 1 0 0
attr IteratorForTest.w 1 0 0
attr IteratorForTest.it 1 0 0
attr joblib 1 0 0
attr PBM.click_prob 1 0 0
attr PBM.exam_prob 1 0 0
attr memory 1 0 0

xgboost.testing.data_iter (6 missing, 0 any)

Symbol Typable Typed Any
attr CatIter.n_batches 1 0 0
attr CatIter.device 1 0 0
attr CatIter.xs 1 0 0
attr CatIter.ys 1 0 0
attr CatIter.x 1 0 0
attr CatIter.y 1 0 0

xgboost.testing.monotone_constraints (6 missing, 0 any)

Symbol Typable Typed Any
attr x 1 0 0
attr y 1 0 0
attr x2_negatively_correlated_with_y 1 0 0
attr training_dset 1 0 0
attr zs 1 0 0
attr x1_positively_correlated_with_y 1 0 0

xgboost.testing.multi_target (3 missing, 0 any)

Symbol Typable Typed Any
attr LsObj1.device 1 0 0
attr LsObj0.device 1 0 0
meth LsObj2.init 3 2 0

xgboost.testing.ordinal (0 missing, 1 any)

Symbol Typable Typed Any
func asarray 3 3 1

xgboost.testing.params (7 missing, 0 any)

Symbol Typable Typed Any
attr strategies 1 0 0
attr hist_cache_strategy 1 0 0
attr hist_multi_parameter_strategy 1 0 0
attr lambdarank_parameter_strategy 1 0 0
attr hist_parameter_strategy 1 0 0
attr exact_parameter_strategy 1 0 0
attr cat_parameter_strategy 1 0 0

xgboost.testing.updater (0 missing, 1 any)

Symbol Typable Typed Any
func check_cut 5 5 1

xgboost.testing.utils (0 missing, 2 any)

Symbol Typable Typed Any
func assert_allclose 6 6 2

xgboost.tracker (1 missing, 0 any)

Symbol Typable Typed Any
attr RabitTracker.handle 1 0 0

xgboost.training (4 missing, 0 any)

Symbol Typable Typed Any
attr CVPack.dtrain 1 0 0
attr CVPack.dtest 1 0 0
attr CVPack.watchlist 1 0 0
attr CVPack.bst 1 0 0

Type-Ignore Comments

Flavor Count
type: ignore[no-redef] 3