ray.train.xgboost.XGBoostCheckpoint

class ray.train.xgboost.XGBoostCheckpoint(local_path: Optional[Union[str, os.PathLike]] = None, data_dict: Optional[dict] = None, uri: Optional[str] = None)

Bases: ray.air.checkpoint.Checkpoint

A Checkpoint with XGBoost-specific functionality.

Create this from a generic Checkpoint by calling XGBoostCheckpoint.from_checkpoint(ckpt).

PublicAPI (beta): This API is in beta and may change before becoming stable.

Methods

__init__([local_path, data_dict, uri])	DeveloperAPI: This API may change across minor Ray releases.
as_directory()	Return checkpoint directory path in a context.
from_bytes(data)	Create a checkpoint from the given byte string.
from_checkpoint(other)	Create a checkpoint from a generic ray.air.checkpoint.Checkpoint.
from_dict(data)	Create checkpoint object from dictionary.
from_directory(path)	Create checkpoint object from directory.
from_model(booster, *[, preprocessor])	Create a Checkpoint that stores an XGBoost model.
from_uri(uri)	Create checkpoint object from location URI (e.g.
get_internal_representation()	Return tuple of (type, data) for the internal representation.
get_model()	Retrieve the XGBoost model stored in this checkpoint.
get_preprocessor()	Return the saved preprocessor, if one exists.
set_preprocessor(preprocessor)	Saves the provided preprocessor to this Checkpoint.
to_bytes()	Return Checkpoint serialized as bytes object.
to_dict()	Return checkpoint data as dictionary.
to_directory([path])	Write checkpoint data to directory.
to_uri(uri)	Write checkpoint data to location URI (e.g.

Attributes

path	Return path to checkpoint, if available.
uri	Return checkpoint URI, if available.