mirror of
https://github.com/vale981/ray
synced 2025-03-06 18:41:40 -05:00
ac831fded4
Update documentation to use `session.report`. Next steps: 1. Update our internal caller to use `session.report`. Most importantly, CheckpointManager and DataParallelTrainer. 2. Update `get_trial_resources` to use PGF notions to incorporate the requirement of ResourceChangingScheduler. @Yard1 3. After 2 is done, change all `tune.get_trial_resources` to `session.get_trial_resources` 4. [internal implementation] remove special checkpoint handling logic from huggingface trainer. Optimize the flow for checkpoint conversion with `session.report`. Co-authored-by: Antoni Baum <antoni.baum@protonmail.com>
135 lines
2 KiB
ReStructuredText
135 lines
2 KiB
ReStructuredText
.. _air-api-ref:
|
|
|
|
Ray AIR API
|
|
===========
|
|
|
|
.. contents::
|
|
:local:
|
|
|
|
Components
|
|
----------
|
|
|
|
.. _air-preprocessor-ref:
|
|
|
|
Preprocessors
|
|
~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: ray.data.preprocessor.Preprocessor
|
|
:members:
|
|
|
|
.. automodule:: ray.data.preprocessors
|
|
:members:
|
|
:show-inheritance:
|
|
|
|
.. autofunction:: ray.air.train_test_split
|
|
|
|
|
|
.. _air-trainer-ref:
|
|
|
|
Trainers and Predictors
|
|
~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. autoclass:: ray.train.trainer.BaseTrainer
|
|
:members:
|
|
|
|
.. autoclass:: ray.train.predictor.Predictor
|
|
:members:
|
|
|
|
.. autoclass:: ray.train.predictor.DataBatchType
|
|
|
|
.. autoclass:: ray.train.batch_predictor.BatchPredictor
|
|
:members:
|
|
|
|
.. automodule:: ray.train.xgboost
|
|
:members:
|
|
:show-inheritance:
|
|
|
|
.. automodule:: ray.train.lightgbm
|
|
:members:
|
|
:show-inheritance:
|
|
|
|
.. automodule:: ray.train.tensorflow
|
|
:members:
|
|
:show-inheritance:
|
|
|
|
.. automodule:: ray.train.torch
|
|
:members:
|
|
:show-inheritance:
|
|
|
|
.. automodule:: ray.train.horovod
|
|
:members:
|
|
:show-inheritance:
|
|
|
|
.. automodule:: ray.train.huggingface
|
|
:members:
|
|
:show-inheritance:
|
|
|
|
.. automodule:: ray.train.sklearn
|
|
:members:
|
|
:show-inheritance:
|
|
|
|
.. autoclass:: ray.train.data_parallel_trainer.DataParallelTrainer
|
|
:members:
|
|
:show-inheritance:
|
|
|
|
.. autoclass:: ray.train.gbdt_trainer.GBDTTrainer
|
|
:members:
|
|
:show-inheritance:
|
|
|
|
|
|
|
|
.. _air-tuner-ref:
|
|
|
|
Tuner
|
|
~~~~~
|
|
|
|
.. autoclass:: ray.tune.tuner.Tuner
|
|
:members:
|
|
|
|
.. automodule:: ray.tune.result_grid
|
|
:members:
|
|
|
|
.. _air-serve-integration:
|
|
|
|
Serving
|
|
~~~~~~~
|
|
|
|
.. autoclass:: ray.serve.model_wrappers.ModelWrapperDeployment
|
|
|
|
.. autoclass:: ray.serve.model_wrappers.ModelWrapper
|
|
|
|
.. _air-results-ref:
|
|
|
|
Outputs
|
|
~~~~~~~
|
|
|
|
.. _air-checkpoint-ref:
|
|
|
|
Checkpoint
|
|
##########
|
|
|
|
.. automodule:: ray.air.checkpoint
|
|
:members:
|
|
|
|
Result
|
|
######
|
|
|
|
.. automodule:: ray.air.result
|
|
:members:
|
|
|
|
|
|
Configs
|
|
~~~~~~~
|
|
|
|
.. automodule:: ray.air.config
|
|
:members:
|
|
|
|
.. autoclass:: ray.air.config.CheckpointConfig
|
|
|
|
.. _air-session-ref:
|
|
|
|
Session
|
|
~~~~~~~
|
|
|
|
.. automodule:: ray.air.session
|
|
:members:
|