ray/doc/source/ray-air/package-ref.rst
Antoni Baum 7158aeda33
[Datasets] Add Dataset.split_proportionately and ray.ml.train_test_split (#24476)
Adds a Dataset.split_proportionately method that allows the user to split a dataset using proportions. This is a very common use-case for eg. train-test splitting. The implementation is a thin wrapper over Dataset.split_at_indices.

Additionally, this PR adds a ray.ml.train_test_split function intended to provide a familiar API to ML practitioners.
2022-05-16 20:47:29 -07:00

138 lines
2.3 KiB
ReStructuredText

.. _air-api-ref:
AIR API
=======
.. contents::
:local:
Components
----------
Preprocessors
~~~~~~~~~~~~~
.. autoclass:: ray.ml.preprocessor.Preprocessor
:members:
.. automodule:: ray.ml.preprocessors
:members:
:show-inheritance:
.. autofunction:: ray.ml.train_test_split
.. _air-trainer-ref:
Trainer
~~~~~~~
.. autoclass:: ray.ml.trainer.Trainer
:members:
.. automodule:: ray.ml.train.integrations.xgboost
:members:
:show-inheritance:
.. automodule:: ray.ml.train.integrations.lightgbm
:members:
:show-inheritance:
.. automodule:: ray.ml.train.integrations.tensorflow
:members:
:show-inheritance:
.. automodule:: ray.ml.train.integrations.torch
:members:
:show-inheritance:
.. automodule:: ray.ml.train.integrations.huggingface
:members:
:show-inheritance:
.. automodule:: ray.ml.train.integrations.sklearn
:members:
:show-inheritance:
.. autoclass:: ray.ml.train.data_parallel_trainer.DataParallelTrainer
:members:
:show-inheritance:
.. autoclass:: ray.ml.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.ml.predictor.Predictor
:members:
.. autoclass:: ray.ml.batch_predictor.BatchPredictor
:members:
.. automodule:: ray.ml.predictors.integrations.xgboost
:members:
:show-inheritance:
.. automodule:: ray.ml.predictors.integrations.lightgbm
:members:
:show-inheritance:
.. automodule:: ray.ml.predictors.integrations.tensorflow
:members:
:show-inheritance:
.. automodule:: ray.ml.predictors.integrations.torch
:members:
:show-inheritance:
.. automodule:: ray.ml.predictors.integrations.sklearn
:members:
:show-inheritance:
.. automodule:: ray.ml.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.ml.checkpoint
:members:
.. automodule:: ray.ml.result
:members:
Configs
~~~~~~~
.. automodule:: ray.ml.config
:members: