ray/doc/source/ray-air/examples/index.rst

.. _air-examples-ref:

========
Examples
========

.. air-general-examples:

Guides
------

- :doc:`/ray-air/examples/analyze_tuning_results`: How to analyze trial results (e.g. find the best trial) of a hyperparameter tuning run.
- :doc:`/ray-air/examples/rl_serving_example`
- :doc:`/ray-air/examples/upload_to_comet_ml`
- :doc:`/ray-air/examples/upload_to_wandb`


Trainers
--------

- :doc:`/ray-air/examples/lightgbm_example`
- :doc:`/ray-air/examples/rl_offline_example`
- :doc:`/ray-air/examples/rl_online_example`
- :doc:`/ray-air/examples/sklearn_example`
- :doc:`/ray-air/examples/xgboost_example`

.. air-huggingface-examples:

Hugging Face Examples
---------------------

- :doc:`/ray-air/examples/huggingface_text_classification`: How to use Ray AIR to run Hugging Face Transformers fine-tuning on a text classification task.
[air/doc] Add examples doc structure (#24770) Add the basic toc/structure for Ray AIR examples 2022-05-13 11:56:34 +01:00			`.. _air-examples-ref:`

			`========`
			`Examples`
			`========`

			`.. air-general-examples:`

[air/docs] Move some examples from `ml/examples` to docs (#24959) This moves the basic LightGBM, Sklearn, and XGBoost examples from the examples/ folder to the docs. We keep a symlink in the examples folder. 2022-05-19 14:01:49 +01:00			`Guides`
			`------`
[air/doc] Add examples doc structure (#24770) Add the basic toc/structure for Ray AIR examples 2022-05-13 11:56:34 +01:00
[air] Example to run tuning and analyze results (#24602) This is a notebook showing how to tune an xgboost model and analyze the results. Also adds a `get_dataframe()` method to `ResultsGrid` to fetch the trial results. Depends on #24483 for toctree. 2022-05-13 15:22:36 +01:00			- :doc:`/ray-air/examples/analyze_tuning_results`: How to analyze trial results (e.g. find the best trial) of a hyperparameter tuning run.
[air/docs] Move RL examples to docs (#24962) Following #24959, this PR moves the RL examples (online/offline/serving) into the Ray ML docs. It also splits the online and offline parts. 2022-05-20 14:55:01 +01:00			- :doc:`/ray-air/examples/rl_serving_example`
[docs/air] Move upload example to docs (#25022) 2022-05-21 20:16:33 +01:00			- :doc:`/ray-air/examples/upload_to_comet_ml`
			- :doc:`/ray-air/examples/upload_to_wandb`
[AIR] HuggingFace Text Classification example (#24402) 2022-05-18 18:35:12 +02:00

[air/docs] Move some examples from `ml/examples` to docs (#24959) This moves the basic LightGBM, Sklearn, and XGBoost examples from the examples/ folder to the docs. We keep a symlink in the examples folder. 2022-05-19 14:01:49 +01:00			`Trainers`
			`--------`

			- :doc:`/ray-air/examples/lightgbm_example`
[air/docs] Move RL examples to docs (#24962) Following #24959, this PR moves the RL examples (online/offline/serving) into the Ray ML docs. It also splits the online and offline parts. 2022-05-20 14:55:01 +01:00			- :doc:`/ray-air/examples/rl_offline_example`
			- :doc:`/ray-air/examples/rl_online_example`
[air/docs] Move some examples from `ml/examples` to docs (#24959) This moves the basic LightGBM, Sklearn, and XGBoost examples from the examples/ folder to the docs. We keep a symlink in the examples folder. 2022-05-19 14:01:49 +01:00			- :doc:`/ray-air/examples/sklearn_example`
			- :doc:`/ray-air/examples/xgboost_example`

[AIR] HuggingFace Text Classification example (#24402) 2022-05-18 18:35:12 +02:00			`.. air-huggingface-examples:`

			`Hugging Face Examples`
			`---------------------`

			- :doc:`/ray-air/examples/huggingface_text_classification`: How to use Ray AIR to run Hugging Face Transformers fine-tuning on a text classification task.