Skip to content

Commit

Permalink
[train] add reference to XGBoost/LightGBM Checkpoints (ray-project#38084
Browse files Browse the repository at this point in the history
)

Signed-off-by: Matthew Deng <matt@anyscale.com>
Signed-off-by: NripeshN <nn2012@hw.ac.uk>
  • Loading branch information
matthewdeng authored and NripeshN committed Aug 15, 2023
1 parent 2895820 commit 5b5f393
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion doc/source/train/distributed-xgboost-lightgbm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,9 @@ Saving and Loading XGBoost and LightGBM Checkpoints
When a new tree is trained on every boosting round,
it's possible to save a checkpoint to snapshot the training progress so far.
:class:`~ray.train.xgboost.XGBoostTrainer` and :class:`~ray.train.lightgbm.LightGBMTrainer`
both implement checkpointing out of the box.
both implement checkpointing out of the box and will create
:class:`~ray.train.xgboost.XGBoostCheckpoint`\s and :class:`~ray.train.lightgbm.LightGBMCheckpoint`\s
respectively.

The only required change is to configure :class:`~ray.air.CheckpointConfig` to set
the checkpointing frequency. For example, the following configuration will
Expand Down

0 comments on commit 5b5f393

Please sign in to comment.