ray/doc/source/ray-air/package-ref.rst

.. _air-api-ref:

Ray 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.horovod
    :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: