Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[AIR][Docs] Clarify how LGBM/XGB trainers work #28122

Merged
merged 4 commits into from
Aug 26, 2022
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions doc/source/train/gbdt.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@ XGBoost / LightGBM User Guide

Ray Train has built-in support for XGBoost and LightGBM.

.. note::
Yard1 marked this conversation as resolved.
Show resolved Hide resolved
Ray Train does not modify or otherwise alter the working
of the underlying XGBoost / LightGBM distributed training algorithms.
Ray only provides orchestration, data ingest and fault tolerance.
For more information on GBDT distributed training, refer to
`XGBoost documentation <https://xgboost.readthedocs.io>`__ and
`LightGBM documentation <https://lightgbm.readthedocs.io/>`__.

Basic Usage
-----------

Expand Down
7 changes: 7 additions & 0 deletions python/ray/train/lightgbm/lightgbm_trainer.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,13 @@ class LightGBMTrainer(GBDTTrainer):
for features with the categorical data type, consider using the
:class:`Categorizer` preprocessor to set the dtypes in the dataset.

.. note::
``LightGBMTrainer`` does not modify or otherwise alter the working
of the LightGBM distributed training algorithm.
Ray only provides orchestration, data ingest and fault tolerance.
For more information on LightGBM distributed training, refer to
`LightGBM documentation <https://lightgbm.readthedocs.io/>`__.

Example:
.. code-block:: python

Expand Down
7 changes: 7 additions & 0 deletions python/ray/train/xgboost/xgboost_trainer.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,13 @@ class XGBoostTrainer(GBDTTrainer):
This Trainer runs the XGBoost training loop in a distributed manner
using multiple Ray Actors.

.. note::
``XGBoostTrainer`` does not modify or otherwise alter the working
of the XGBoost distributed training algorithm.
Ray only provides orchestration, data ingest and fault tolerance.
For more information on XGBoost distributed training, refer to
`XGBoost documentation <https://xgboost.readthedocs.io>`__.

Example:
.. code-block:: python

Expand Down