xgboost API reference
211 public APIs from xgboost (dmlc/xgboost) — 38 classes, 103 functions, 70 methods. Signatures extracted by static analysis of the actual source.
Repository: dmlc/xgboost
| Kind | Count |
|---|---|
| Classes | 38 |
| Functions | 103 |
| Methods | 70 |
API list
func
jvm-packages.create_jni.build(config:dict[str, str], build_dir:Path) -> NoneBuild the native library.
func
jvm-packages.create_jni.cmake_args(config:dict[str, str]) -> list[str]Create CMake command line arguments.
func
jvm-packages.create_jni.cmake_config(options:argparse.Namespace) -> dict[str, str]Create CMake configuration from CLI options.
func
jvm-packages.create_jni.configure(config_args:list[str], build_dir:Path) -> NoneConfigure the CMake build.
func
jvm-packages.create_jni.copy_file(source:Path, target:Path) -> NoneCopy a file to a target path or directory.
func
jvm-packages.create_jni.copy_glob(pattern:str, target:Path) -> NoneCopy files matching a glob pattern to a target directory.
func
jvm-packages.create_jni.copy_native_library() -> NoneCopy the native library into the JVM package resources.
func
jvm-packages.create_jni.copy_test_resources(*use_cuda:bool) -> NoneCopy training data used by JVM package tests.
func
jvm-packages.create_jni.mkdir(path:Path) -> NoneCreate a directory if it does not already exist.
func
jvm-packages.create_jni.native_build(options:argparse.Namespace) -> NoneBuild and copy the native JNI library and its test resources.
func
jvm-packages.create_jni.run(command:Sequence[str], *cwd:Path | None=None) -> NoneRun a shell command.
func
jvm-packages.create_jni.windows_generators() -> tuple[list[str], ...]Return CMake generator arguments to try on Windows.
func
ops.pipeline.trigger-rtd-impl.trigger_build(token:str) -> NoneTrigger RTD build.
method
ops.script.lint_cpp.Lint.print_summary(strm:TextIO) -> intPrint summary of lint.
method
ops.script.lint_cpp.Lint.process_cpp(path:str, suffix:str) -> NoneProcess a cpp file.
func
ops.script.lint_cpp.filepath_enumerate(paths:list[str]) -> list[str]Enumerate the file paths of all subfiles of the list of paths
func
ops.script.lint_cpp.get_header_guard_dmlc(filename:str) -> strGet Header Guard Convention for DMLC Projects.
func
ops.script.lint_cpp.process(fname:str, allow_type:list[str]) -> NoneProcess a file.
func
ops.script.prepare_jvm_release.cp(source:str, target:str) -> NoneCopy a file after normalizing both paths.
func
ops.script.prepare_jvm_release.deploy(local:bool, profile:Literal['default', 'gpu'], pl:str | None) -> NoneDeploy JVM artifacts with the selected Maven profile.
func
ops.script.prepare_jvm_release.deploy_cuda_pkg(local:bool, version:str) -> NoneDeploy CUDA JVM packages.
func
ops.script.prepare_jvm_release.get_current_commit_hash() -> strGet the last commit of the current branch.
func
ops.script.prepare_jvm_release.get_current_git_branch() -> strGet the current branch.
func
ops.script.prepare_jvm_release.main() -> NoneAssemble and deploy the packages.
func
ops.script.prepare_jvm_release.maybe_makedirs(path:str) -> NoneCreate a directory and its parents if needed.
func
ops.script.prepare_jvm_release.normpath(path:str) -> strNormalize UNIX path to a native path.
func
ops.script.prepare_jvm_release.parse_args() -> argparse.NamespaceParse command-line arguments.
func
ops.script.prepare_jvm_release.retrieve(url:str, filename:str | None=None) -> NoneDownload a file from a URL and print the destination.
func
ops.script.prepare_jvm_release.run(command:str, **kwargs:Any) -> NoneRun a shell command and fail if it exits with an error.
func
ops.script.release_artifacts.check_path() -> NoneEnsure the script is run from the project root directory.
func
ops.script.release_artifacts.download_python_wheels(branch:str, commit_hash:str, outdir:Path) -> NoneDownload all Python binary wheels for the specified branch.
func
ops.script.release_artifacts.latest_hash() -> strGet latest commit hash.
func
ops.script.release_artifacts.make_python_sdist(release:str, rc:Optional[str], rc_ver:Optional[int], outdir:Path) -> NoneMake Python source distribution.
func
ops.script.release_artifacts.release_note(release:str, artifact_hashes:List[str], r_urls:Dict[str, str], tarball_name:str, outdir:Path) -> NoneGenerate a note for GitHub release description.
func
ops.script.release_artifacts.retrieve(url:str, filename:Optional[Path]=None) -> strRetrieve a file from a URL with progress indication.
func
ops.script.release_artifacts.show_progress(block_num:int, block_size:int, total_size:int) -> NoneShow file download progress.
class
ops.script.type_check_python.TypeCheckPathsThe paths mypy runs on.
class
python-package.xgboost._c_api.XGBoostErrorError thrown by xgboost trainer.
func
python-package.xgboost._c_api.c_str(string:str) -> ctypes.c_char_pConvert a python string to cstring.
func
python-package.xgboost._c_api.from_cstr_to_pystr(data:CStrPptr, length:c_bst_ulong) -> List[str]Revert C pointer to Python str.
func
python-package.xgboost._c_api.make_jcargs(**kwargs:Any) -> bytesMake JSON-based arguments for C functions.
class
python-package.xgboost._data_utils.ArrayWrapper type for communicating with numpy and cupy.
method
python-package.xgboost._data_utils.Array.shape() -> Tuple[int, ...]Shape of the input array.
method
python-package.xgboost._data_utils.Array.size() -> np.signedintegerTotal size of the input array.
class
python-package.xgboost._data_utils.DfCatAccessorProtocol for pandas cat accessor.
class
python-package.xgboost._data_utils.TransformedDfInternal class for storing transformed dataframe.
method
python-package.xgboost._data_utils.TransformedDf.shape() -> Tuple[int, int]Return the shape of the dataframe.
func
python-package.xgboost._data_utils.array_hasobject(data:DataType) -> boolWhether the numpy array has object dtype.
func
python-package.xgboost._data_utils.array_interface(data:np.ndarray) -> bytesMake array interface str.
func
python-package.xgboost._data_utils.array_interface_dict(data:np.ndarray) -> ArrayInfReturns an array interface from the input.
func
python-package.xgboost._data_utils.check_cudf_meta(data:_CudaArrayLikeArg, field:str) -> NoneMake sure no missing value in meta data.
func
python-package.xgboost._data_utils.cuda_array_interface(data:_CudaArrayLikeArg) -> bytesMake cuda array interface str.
func
python-package.xgboost._data_utils.cuda_array_interface_dict(data:_CudaArrayLikeArg) -> CudaArrayInfReturns a dictionary storing the CUDA array interface.
func
python-package.xgboost._data_utils.from_array_interface(interface:ArrayInf, zero_copy:bool=False) -> NumpyOrCupyConvert array interface to numpy or cupy array
func
python-package.xgboost._data_utils.is_arrow_dict(data:Any) -> TypeGuard['pa.DictionaryArray']Is this an arrow dictionary array?
func
python-package.xgboost._data_utils.npstr_to_arrow_strarr(strarr:Any) -> Tuple[np.ndarray, bytes]Convert a string-like array to an arrow string array.
class
python-package.xgboost.callback.EarlyStoppingCallback function for early stopping ..
func
python-package.xgboost.callback.EarlyStopping.get_s(value:_Score) -> floatget score if it's cross validation history.
func
python-package.xgboost.callback.EarlyStopping.maximize(new:_Score, best:_Score) -> boolNew score should be greater than the old one.
func
python-package.xgboost.callback.EarlyStopping.minimize(new:_Score, best:_Score) -> boolNew score should be lesser than the old one.
class
python-package.xgboost.callback.EvaluationMonitorPrint the evaluation result at each iteration.
class
python-package.xgboost.callback.LearningRateSchedulerCallback function for scheduling learning rate.
class
python-package.xgboost.callback.TrainingCallbackInterface for training callback.
method
python-package.xgboost.callback.TrainingCallback.after_iteration(model:_Model, epoch:int, evals_log:EvalsLog) -> boolRun after each iteration.
method
python-package.xgboost.callback.TrainingCallback.after_training(model:_Model) -> _ModelRun after training is finished.
method
python-package.xgboost.callback.TrainingCallback.before_iteration(model:_Model, epoch:int, evals_log:EvalsLog) -> boolRun before each iteration.
method
python-package.xgboost.callback.TrainingCallback.before_training(model:_Model) -> _ModelRun before training starts.
class
python-package.xgboost.callback.TrainingCheckPointCheckpointing operation.
class
python-package.xgboost.collective.ConfigUser configuration for the communicator context.
method
python-package.xgboost.collective.Config.get_comm_config(args:_Conf) -> _ConfUpdate the arguments for the communicator.
method
python-package.xgboost.collective.Config.update_worker_args(args:_Conf) -> _ConfWorker side arguments resolution.
class
python-package.xgboost.collective.OpSupported operations for allreduce.
func
python-package.xgboost.collective.allreduce(data:np.ndarray, op:Op) -> np.ndarrayPerform allreduce, return the result.
func
python-package.xgboost.collective.broadcast(data:_T, root:int) -> _TBroadcast object from one node to all other nodes.
func
python-package.xgboost.collective.communicator_print(msg:Any) -> NonePrint message to the communicator.
func
python-package.xgboost.collective.finalize() -> NoneFinalize the communicator.
func
python-package.xgboost.collective.get_processor_name() -> strGet the processor name.
func
python-package.xgboost.collective.get_rank() -> intGet rank of current process.
func
python-package.xgboost.collective.get_world_size() -> intGet total number workers.
func
python-package.xgboost.collective.init(**args:_ArgVals) -> NoneInitialize the collective library with arguments.
func
python-package.xgboost.collective.is_distributed() -> boolIf the collective communicator is distributed.
func
python-package.xgboost.collective.signal_error() -> NoneKill the process.
class
python-package.xgboost.compat.XGBClassifierBaseDummy class for sklearn.base.ClassifierMixin.
class
python-package.xgboost.compat.XGBModelBaseDummy class for sklearn.base.BaseEstimator.
class
python-package.xgboost.compat.XGBRegressorBaseDummy class for sklearn.base.RegressorMixin.
func
python-package.xgboost.compat.concat(value:Sequence[_T]) -> _TConcatenate row-wise.
func
python-package.xgboost.compat.import_cupy() -> types.ModuleTypeImport cupy.
func
python-package.xgboost.compat.import_pandas() -> types.ModuleTypeImport pandas with memory cache.
func
python-package.xgboost.compat.import_polars() -> types.ModuleTypeImport polars with memory cache.
func
python-package.xgboost.compat.import_pyarrow() -> types.ModuleTypeImport pyarrow with memory cache.
func
python-package.xgboost.compat.is_cudf_available() -> boolCheck cuDF package available or not
func
python-package.xgboost.compat.is_cupy_available() -> boolCheck cupy package available or not
func
python-package.xgboost.compat.is_dataframe(data:DataType) -> boolWhether the input is a dataframe.
func
python-package.xgboost.compat.is_pandas_available() -> boolCheck the pandas package is available or not.
func
python-package.xgboost.compat.is_pyarrow_available() -> boolCheck pyarrow package available or not
func
python-package.xgboost.compat.lazy_isinstance(instance:Any, module:str, name:str) -> boolUse string representation to identify a type.
func
python-package.xgboost.compat.py_str(x:bytes | None) -> strconvert c string back to python string
class
python-package.xgboost.core.BoosterA Booster of XGBoost.
method
python-package.xgboost.core.Booster.attr(key:str) -> Optional[str]Get attribute string from the Booster.
method
python-package.xgboost.core.Booster.best_iteration() -> intThe best iteration during training.
method
python-package.xgboost.core.Booster.best_score() -> floatThe best evaluation score during training.
method
python-package.xgboost.core.Booster.copy() -> 'Booster'Copy the booster object.
method
python-package.xgboost.core.Booster.dump_model(fout:PathLike, fmap:PathLike='', with_stats:bool=False, dump_format:str='text') -> NoneDump model into a text or JSON file.
method
python-package.xgboost.core.Booster.eval(data:DMatrix, name:str='eval', iteration:int=0) -> strEvaluate the model on mat.
method
python-package.xgboost.core.Booster.eval_set(evals:Sequence[Tuple[DMatrix, str]], iteration:int=0, feval:Optional[Metric]=None, output_margin:bool=True) -> strEvaluate a set of data.
method
python-package.xgboost.core.Booster.feature_names() -> Optional[FeatureNames]Feature names for this booster.
method
python-package.xgboost.core.Booster.feature_types() -> Optional[FeatureTypes]Feature types for this booster.
method
python-package.xgboost.core.Booster.get_categories(export_to_arrow:bool=False) -> CategoriesSame method as :py:meth:`DMatrix.get_categories`.
method
python-package.xgboost.core.Booster.get_dump(fmap:PathLike='', with_stats:bool=False, dump_format:str='text') -> List[str]Returns the model dump as a list of strings.
method
python-package.xgboost.core.Booster.get_fscore(fmap:PathLike='') -> Dict[str, Union[float, List[float]]]Get feature importance of each feature.
method
python-package.xgboost.core.Booster.get_score(fmap:PathLike='', importance_type:str='weight') -> Dict[str, Union[float, List[float]]]Get feature importance of each feature.
method
python-package.xgboost.core.Booster.load_config(config:str) -> NoneLoad configuration returned by `save_config`.
method
python-package.xgboost.core.Booster.load_model(fname:ModelIn) -> NoneLoad the model from a file or a bytearray.
method
python-package.xgboost.core.Booster.num_boosted_rounds() -> intGet number of boosted rounds.
method
python-package.xgboost.core.Booster.num_features() -> intNumber of features in booster.
method
python-package.xgboost.core.Booster.save_model(fname:PathLike) -> NoneSave the model to a file.
method
python-package.xgboost.core.Booster.save_raw(raw_format:str='ubj') -> bytearraySave the model to a in memory buffer representation instead of file.
method
python-package.xgboost.core.Booster.set_attr(**kwargs:Optional[Any]) -> NoneSet the attribute of the Booster.
method
python-package.xgboost.core.Booster.set_param(params:Union[Dict, Iterable[Tuple[str, Any]], str], value:Optional[str]=None) -> NoneSet parameters into the Booster.
method
python-package.xgboost.core.Booster.trees_to_dataframe(fmap:PathLike='') -> PdDataFrameParse a boosted tree model into a pandas DataFrame.
class
python-package.xgboost.core.DMatrixData Matrix used in XGBoost.
method
python-package.xgboost.core.DMatrix.feature_names() -> Optional[FeatureNames]Labels for features (column labels).
method
python-package.xgboost.core.DMatrix.feature_types() -> Optional[FeatureTypes]Type of features (column types).
method
python-package.xgboost.core.DMatrix.get_base_margin() -> NumpyOrCupyGet the base margin of the DMatrix.
method
python-package.xgboost.core.DMatrix.get_categories(export_to_arrow:bool=False) -> CategoriesGet the categories in the dataset.
method
python-package.xgboost.core.DMatrix.get_data() -> scipy.sparse.csr_matrixGet the predictors from DMatrix as a CSR matrix.
method
python-package.xgboost.core.DMatrix.get_float_info(field:str) -> NumpyOrCupyGet float property from the DMatrix.
method
python-package.xgboost.core.DMatrix.get_group() -> np.ndarrayGet the group of the DMatrix.
method
python-package.xgboost.core.DMatrix.get_label() -> NumpyOrCupyGet the label of the DMatrix.
method
python-package.xgboost.core.DMatrix.get_quantile_cut() -> Tuple[np.ndarray, np.ndarray]Get quantile cuts for quantization.
method
python-package.xgboost.core.DMatrix.get_uint_info(field:str) -> NumpyOrCupyGet unsigned integer property from the DMatrix.
method
python-package.xgboost.core.DMatrix.get_weight() -> NumpyOrCupyGet the weight of the DMatrix.
method
python-package.xgboost.core.DMatrix.num_col() -> intGet the number of columns (features) in the DMatrix.
method
python-package.xgboost.core.DMatrix.num_nonmissing() -> intGet the number of non-missing values in the DMatrix.
method
python-package.xgboost.core.DMatrix.num_row() -> intGet the number of rows in the DMatrix.
method
python-package.xgboost.core.DMatrix.save_binary(fname:PathLike, silent:bool=True) -> NoneSave DMatrix to an XGBoost buffer.
method
python-package.xgboost.core.DMatrix.set_base_margin(margin:ArrayLike) -> NoneSet base margin of booster to start from.
method
python-package.xgboost.core.DMatrix.set_float_info(field:str, data:ArrayLike) -> NoneSet float type property into the DMatrix.
method
python-package.xgboost.core.DMatrix.set_group(group:ArrayLike) -> NoneSet group size of DMatrix (used for ranking).
method
python-package.xgboost.core.DMatrix.set_uint_info(field:str, data:ArrayLike) -> NoneSet uint type property into the DMatrix.
method
python-package.xgboost.core.DMatrix.set_weight(weight:ArrayLike) -> NoneSet weight of each instance.
class
python-package.xgboost.core.DataIterThe interface for user defined data iterator.
method
python-package.xgboost.core.DataIter.get_callbacks(enable_categorical:bool) -> Tuple[Callable, Callable]Get callback functions for iterating in C.
method
python-package.xgboost.core.DataIter.next(input_data:Callable) -> boolSet the next batch of data.
method
python-package.xgboost.core.DataIter.proxy() -> '_ProxyDMatrix'Handle of DMatrix proxy.
method
python-package.xgboost.core.DataIter.reraise() -> NoneReraise the exception thrown during iteration.
method
python-package.xgboost.core.DataIter.reset() -> NoneReset the data iterator.
func
python-package.xgboost.core.build_info() -> dictBuild information of XGBoost.
func
python-package.xgboost.core.c_array(ctype:Type[CTypeT], values:ArrayLike) -> Union[ctypes.Array, ctypes._Pointer]Convert a python array to c array.
func
python-package.xgboost.core.ctypes2buffer(cptr:CStrPtr, length:int) -> bytearrayConvert ctypes pointer to buffer type.
func
python-package.xgboost.core.ctypes2numpy(cptr:CNumericPtr, length:int, dtype:Type[np.number]) -> np.ndarrayConvert a ctypes pointer array to a numpy array.
class
python-package.xgboost.dask.DaskDMatrixDMatrix holding on references to Dask DataFrame or Dask Array.
method
python-package.xgboost.dask.DaskDMatrix.num_col() -> intGet the number of columns (features) in the DMatrix.
func
python-package.xgboost.dask.DaskDMatrix.to_futures(d:_DaskCollection) -> List[Future]Breaking data into partitions.
class
python-package.xgboost.dask.DaskQuantileDMatrixA dask version of :py:class:`QuantileDMatrix`.
method
python-package.xgboost.dask.DaskScikitLearnBase.client() -> 'distributed.Client'The dask client used in this model.
class
python-package.xgboost.dask.data.DaskPartitionIterA data iterator for the `DaskQuantileDMatrix`.
method
python-package.xgboost.dask.data.DaskPartitionIter.data() -> AnyUtility function for obtaining current batch of data.
method
python-package.xgboost.dask.data.DaskPartitionIter.next(input_data:Callable) -> boolYield next batch of data
method
python-package.xgboost.dask.data.DaskPartitionIter.reset() -> NoneReset the iterator
func
python-package.xgboost.dask.data.get_dict(i:int) -> Dict[str, list]Return a dictionary containing all the meta info and all partitions.
class
python-package.xgboost.data.ArrowTransformedA storage class for transformed arrow table.
method
python-package.xgboost.data.ArrowTransformed.shape() -> Tuple[int, int]Return shape of the transformed DataFrame.
class
python-package.xgboost.data.CudfTransformedA storage class for transformed cuDF dataframe.
method
python-package.xgboost.data.CudfTransformed.shape() -> Tuple[int, int]Return shape of the transformed DataFrame.
class
python-package.xgboost.data.PandasTransformedA storage class for transformed pandas DataFrame.
method
python-package.xgboost.data.PandasTransformed.shape() -> Tuple[int, int]Return shape of the transformed DataFrame.
func
python-package.xgboost.data.dispatch_meta_backend(matrix:'DMatrix', data:DataType, name:str, dtype:Optional[NumpyDType]=None) -> NoneDispatch for meta info.
func
python-package.xgboost.data.dispatch_proxy_set_data(proxy:'_ProxyDMatrix', data:DataType) -> NoneDispatch for QuantileDMatrix.
func
python-package.xgboost.data.is_nullable_dtype(dtype:PandasDType) -> boolWhether dtype is a pandas nullable type.
func
python-package.xgboost.data.is_on_cuda(data:Any) -> boolWhether the data is a CUDA-based data structure.
func
python-package.xgboost.data.is_pa_ext_categorical_dtype(dtype:Any) -> boolCheck whether dtype is a dictionary type.
func
python-package.xgboost.data.is_pa_ext_dtype(dtype:Any) -> boolReturn whether dtype is a pyarrow extension type for pandas
func
python-package.xgboost.data.is_pd_cat_dtype(dtype:PandasDType) -> boolWrapper for testing pandas category type.
func
python-package.xgboost.data.is_pd_sparse_dtype(dtype:PandasDType) -> boolWrapper for testing pandas sparse type.
func
python-package.xgboost.data.is_scipy_coo(data:DataType) -> boolPredicate for scipy COO input.
func
python-package.xgboost.data.is_scipy_csc(data:DataType) -> boolPredicate for scipy CSC input.
func
python-package.xgboost.data.is_scipy_csr(data:DataType) -> boolPredicate for scipy CSR input.
func
python-package.xgboost.data.pandas_pa_type(ser:Any) -> np.ndarrayHandle pandas pyarrow extension.
class
python-package.xgboost.libpath.XGBoostLibraryNotFoundError thrown by when xgboost is not found
func
python-package.xgboost.libpath.find_lib_path() -> List[str]Find the path to xgboost dynamic library files.
class
python-package.xgboost.objective.ObjectiveBase class for custom objective functions.
class
python-package.xgboost.objective.TreeObjectiveBase class for tree-specific custom objective functions.
func
python-package.xgboost.plotting.plot_tree(booster:Union[Booster, XGBModel], *fmap:PathLike='', *num_trees:Optional[int]=None, *rankdir:Optional[str]=None, *ax:Optional[Axes]=None, *with_stats:bool=False, *tree_idx:int=0, **kwargs:Any) -> AxesPlot specified tree.
func
python-package.xgboost.sklearn.get_doc(item:str) -> strReturn selected item
func
python-package.xgboost.sklearn.inner(preds:np.ndarray, dmatrix:DMatrix) -> Tuple[np.ndarray, np.ndarray]Internal function.
func
python-package.xgboost.sklearn.ltr_metric_decorator(func:Callable, n_jobs:Optional[int]) -> MetricDecorate a learning to rank metric.
class
python-package.xgboost.spark.core.SparkXGBModelReaderSpark Xgboost model reader.
class
python-package.xgboost.spark.core.SparkXGBModelWriterSpark Xgboost model writer.
class
python-package.xgboost.spark.core.SparkXGBReaderSpark Xgboost estimator reader.
method
python-package.xgboost.spark.core.SparkXGBReader.load(path:str) -> '_SparkXGBEstimator'load model.
class
python-package.xgboost.spark.core.SparkXGBWriterSpark Xgboost estimator writer.
method
python-package.xgboost.spark.core.SparkXGBWriter.saveImpl(path:str) -> Nonesave model.
func
python-package.xgboost.spark.core._SparkXGBModel.to_gpu_if_possible(data:ArrayLike) -> ArrayLikeMove the data to gpu if possible
class
python-package.xgboost.spark.data.PartIterIterator for creating Quantile DMatrix from partitions.
func
python-package.xgboost.spark.data.cache_partitions(iterator:Iterator[pd.DataFrame], append:Callable[[pd.DataFrame, str, bool], None]) -> NoneExtract partitions from pyspark iterator.
func
python-package.xgboost.spark.data.concat_or_none(seq:Optional[Sequence[np.ndarray]]) -> Optional[np.ndarray]Concatenate the data if it's not None.
func
python-package.xgboost.spark.data.stack_series(series:pd.Series) -> np.ndarrayStack a series of arrays.
class
python-package.xgboost.spark.estimator.SparkXGBClassifierSparkXGBClassifier is a PySpark ML estimator.
class
python-package.xgboost.spark.estimator.SparkXGBRankerSparkXGBRanker is a PySpark ML estimator.
class
python-package.xgboost.spark.estimator.SparkXGBRegressorSparkXGBRegressor is a PySpark ML estimator.
class
python-package.xgboost.spark.params.HasQueryIdColMixin for param qid_col: query id column name.
class
python-package.xgboost.spark.utils.CommunicatorContextContext with PySpark specific task ID.
func
python-package.xgboost.spark.utils.get_class_name(cls:Type) -> strReturn the class name.
func
python-package.xgboost.spark.utils.get_logger_level(name:str) -> Optional[int]Get the logger level for the given log name
func
python-package.xgboost.spark.utils.serialize_booster(booster:Booster) -> strSerialize the input booster to a string.
func
python-package.xgboost.spark.utils.use_cuda(device:Optional[str]) -> boolWhether xgboost is using CUDA workers.
func
python-package.xgboost.tracker.get_family(addr:str) -> intGet network family from address.
class
python-package.xgboost.training.CVPack"Auxiliary datastruct to hold one fold of CV.
method
python-package.xgboost.training.CVPack.eval(iteration:int, feval:Optional[Metric], output_margin:bool) -> str"Evaluate the CVPack for one iteration.
method
python-package.xgboost.training.CVPack.update(iteration:int, fobj:Optional[CustomObj]) -> None"Update the boosters for one iteration
About this data
These signatures were extracted from the public source of dmlc/xgboost
using Python's ast module. Argument names, default values,
type annotations and return types are taken verbatim from the code.
Implementation bodies are never stored. See
how it works for details.