Skip to content

Commit

Permalink
[train] minor updates to XGBoost/LightGBM Trainer API docs' (ray-proj…
Browse files Browse the repository at this point in the history
…ect#38542)

Signed-off-by: Matthew Deng <matt@anyscale.com>
Signed-off-by: Victor <vctr.y.m@example.com>
  • Loading branch information
matthewdeng authored and Victor committed Oct 11, 2023
1 parent 31d8bf9 commit 3331810
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions python/ray/train/lightgbm/lightgbm_trainer.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ class LightGBMTrainer(GBDTTrainer):
...
Args:
datasets: Datasets to use for training and validation. Must include a
datasets: The Ray Datasets to use for training and validation. Must include a
"train" key denoting the training dataset. If a ``preprocessor``
is provided and has not already been fit, it will be fit on the training
dataset. All datasets will be transformed by the ``preprocessor`` if
Expand All @@ -77,7 +77,7 @@ class LightGBMTrainer(GBDTTrainer):
dmatrix_params: Dict of ``dataset name:dict of kwargs`` passed to respective
:class:`xgboost_ray.RayDMatrix` initializations, which in turn are passed
to ``lightgbm.Dataset`` objects created on each worker. For example, this
can be used to add sample weights with the ``weights`` parameter.
can be used to add sample weights with the ``weight`` parameter.
num_boost_round: Target number of boosting iterations (trees in the model).
Note that unlike in ``lightgbm.train``, this is the target number
of trees, meaning that if you set ``num_boost_round=10`` and pass a model
Expand Down
4 changes: 2 additions & 2 deletions python/ray/train/xgboost/xgboost_trainer.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ class XGBoostTrainer(GBDTTrainer):
...
Args:
datasets: Datasets to use for training and validation. Must include a
datasets: The Ray Datasets to use for training and validation. Must include a
"train" key denoting the training dataset. If a ``preprocessor``
is provided and has not already been fit, it will be fit on the training
dataset. All datasets will be transformed by the ``preprocessor`` if
Expand All @@ -72,7 +72,7 @@ class XGBoostTrainer(GBDTTrainer):
dmatrix_params: Dict of ``dataset name:dict of kwargs`` passed to respective
:class:`xgboost_ray.RayDMatrix` initializations, which in turn are passed
to ``xgboost.DMatrix`` objects created on each worker. For example, this can
be used to add sample weights with the ``weights`` parameter.
be used to add sample weights with the ``weight`` parameter.
num_boost_round: Target number of boosting iterations (trees in the model).
Note that unlike in ``xgboost.train``, this is the target number
of trees, meaning that if you set ``num_boost_round=10`` and pass a model
Expand Down

0 comments on commit 3331810

Please sign in to comment.