ray/doc/source/ray-air/package-ref.rst
Kai Fricke 4b9a89ad90
[air] Move python/ray/ml to python/ray/air (#25449)
The package "ml" should be renamed to "air".

Main question: Keep a `ml.py` with `from ray.air import *` for some level of backwards compatibility?
I'd go for no to force people to use the new structure.
2022-06-03 21:53:44 +01:00

140 lines
2.3 KiB
ReStructuredText

.. _air-api-ref:
AIR API
=======
.. contents::
:local:
Components
----------
Preprocessors
~~~~~~~~~~~~~
.. autoclass:: ray.air.preprocessor.Preprocessor
:members:
.. automodule:: ray.air.preprocessors
:members:
:show-inheritance:
.. autofunction:: ray.air.train_test_split
.. _air-trainer-ref:
Trainer
~~~~~~~
.. autoclass:: ray.air.trainer.Trainer
:members:
.. automodule:: ray.air.train.integrations.xgboost
:members:
:show-inheritance:
.. automodule:: ray.air.train.integrations.lightgbm
:members:
:show-inheritance:
.. automodule:: ray.air.train.integrations.tensorflow
:members:
:show-inheritance:
.. automodule:: ray.air.train.integrations.torch
:members:
:show-inheritance:
.. automodule:: ray.air.train.integrations.huggingface
:members:
:show-inheritance:
.. automodule:: ray.air.train.integrations.sklearn
:members:
:show-inheritance:
.. autoclass:: ray.air.train.data_parallel_trainer.DataParallelTrainer
:members:
:show-inheritance:
.. autoclass:: ray.air.train.gbdt_trainer.GBDTTrainer
:members:
:show-inheritance:
.. _air-tuner-ref:
Tuner
~~~~~
.. autoclass:: ray.tune.tuner.Tuner
:members:
.. automodule:: ray.tune.result_grid
:members:
Predictors
~~~~~~~~~~
.. autoclass:: ray.air.predictor.Predictor
:members:
.. autoclass:: ray.air.predictor.DataBatchType
.. autoclass:: ray.air.batch_predictor.BatchPredictor
:members:
.. automodule:: ray.air.predictors.integrations.xgboost
:members:
:show-inheritance:
.. automodule:: ray.air.predictors.integrations.lightgbm
:members:
:show-inheritance:
.. automodule:: ray.air.predictors.integrations.tensorflow
:members:
:show-inheritance:
.. automodule:: ray.air.predictors.integrations.torch
:members:
:show-inheritance:
.. automodule:: ray.air.predictors.integrations.sklearn
:members:
:show-inheritance:
.. automodule:: ray.air.predictors.integrations.huggingface
:members:
:show-inheritance:
.. _air-serve-integration:
Serving
~~~~~~~
.. autoclass:: ray.serve.model_wrappers.ModelWrapperDeployment
.. autoclass:: ray.serve.model_wrappers.ModelWrapper
.. _air-results-ref:
Outputs
~~~~~~~
.. automodule:: ray.air.checkpoint
:members:
.. automodule:: ray.air.result
:members:
Configs
~~~~~~~
.. automodule:: ray.air.config
:members: