diff --git a/doc/source/tune/_tutorials/overview.rst b/doc/source/tune/_tutorials/overview.rst index 4a3572175..c03593114 100644 --- a/doc/source/tune/_tutorials/overview.rst +++ b/doc/source/tune/_tutorials/overview.rst @@ -148,55 +148,55 @@ If any example is broken, or if you'd like to add an example to this page, feel General Examples ~~~~~~~~~~~~~~~~ -- `async_hyperband_example `__: Example of using a Trainable class with AsyncHyperBandScheduler. -- `hyperband_example `__: Example of using a Trainable class with HyperBandScheduler. Also uses the Experiment class API for specifying the experiment configuration. Also uses the AsyncHyperBandScheduler. -- `pbt_example `__: Example of using a Trainable class with PopulationBasedTraining scheduler. -- `PBT with Function API `__: Example of using the function API with a PopulationBasedTraining scheduler. -- `pbt_ppo_example `__: Example of optimizing a distributed RLlib algorithm (PPO) with the PopulationBasedTraining scheduler. -- `logging_example `__: Example of custom loggers and custom trial directory naming. +- :doc:`/tune/examples/async_hyperband_example`: Example of using a Trainable class with AsyncHyperBandScheduler. +- :doc:`/tune/examples/hyperband_example`: Example of using a Trainable class with HyperBandScheduler. Also uses the Experiment class API for specifying the experiment configuration. Also uses the AsyncHyperBandScheduler. +- :doc:`/tune/examples/pbt_example`: Example of using a Trainable class with PopulationBasedTraining scheduler. +- :doc:`/tune/examples/pbt_function`: Example of using the function API with a PopulationBasedTraining scheduler. +- :doc:`/tune/examples/pbt_ppo_example`: Example of optimizing a distributed RLlib algorithm (PPO) with the PopulationBasedTraining scheduler. +- :doc:`/tune/examples/logging_example`: Example of custom loggers and custom trial directory naming. Search Algorithm Examples ~~~~~~~~~~~~~~~~~~~~~~~~~ -- `Ax example `__: Optimize a Hartmann function with `Ax `_ with 4 parallel workers. -- `HyperOpt Example `__: Optimizes a basic function using the function-based API and the HyperOptSearch (SearchAlgorithm wrapper for HyperOpt TPE). -- `Nevergrad example `__: Optimize a simple toy function with the gradient-free optimization package `Nevergrad `_ with 4 parallel workers. -- `Bayesian Optimization example `__: Optimize a simple toy function using `Bayesian Optimization `_ with 4 parallel workers. +- :doc:`/tune/examples/ax_example`: Optimize a Hartmann function with `Ax `_ with 4 parallel workers. +- :doc:`/tune/examples/hyperopt_example`: Optimizes a basic function using the function-based API and the HyperOptSearch (SearchAlgorithm wrapper for HyperOpt TPE). +- :doc:`/tune/examples/nevergrad_example`: Optimize a simple toy function with the gradient-free optimization package `Nevergrad `_ with 4 parallel workers. +- :doc:`/tune/examples/bayesopt_example`: Optimize a simple toy function using `Bayesian Optimization `_ with 4 parallel workers. Tensorflow/Keras Examples ~~~~~~~~~~~~~~~~~~~~~~~~~ -- `tune_mnist_keras `__: Converts the Keras MNIST example to use Tune with the function-based API and a Keras callback. Also shows how to easily convert something relying on argparse to use Tune. -- `pbt_memnn_example `__: Example of training a Memory NN on bAbI with Keras using PBT. -- `Tensorflow 2 Example `__: Converts the Advanced TF2.0 MNIST example to use Tune with the Trainable. This uses `tf.function`. Original code from tensorflow: https://www.tensorflow.org/tutorials/quickstart/advanced +- :doc:`/tune/examples/tune_mnist_keras`: Converts the Keras MNIST example to use Tune with the function-based API and a Keras callback. Also shows how to easily convert something relying on argparse to use Tune. +- :doc:`/tune/examples/pbt_memnn_example`: Example of training a Memory NN on bAbI with Keras using PBT. +- :doc:`/tune/examples/tf_mnist_example`: Converts the Advanced TF2.0 MNIST example to use Tune with the Trainable. This uses `tf.function`. Original code from tensorflow: https://www.tensorflow.org/tutorials/quickstart/advanced PyTorch Examples ~~~~~~~~~~~~~~~~ -- `mnist_pytorch `__: Converts the PyTorch MNIST example to use Tune with the function-based API. Also shows how to easily convert something relying on argparse to use Tune. -- `mnist_pytorch_trainable `__: Converts the PyTorch MNIST example to use Tune with Trainable API. Also uses the HyperBandScheduler and checkpoints the model at the end. +- :doc:`/tune/examples/mnist_pytorch`: Converts the PyTorch MNIST example to use Tune with the function-based API. Also shows how to easily convert something relying on argparse to use Tune. +- :doc:`/tune/examples/mnist_pytorch_trainable`: Converts the PyTorch MNIST example to use Tune with Trainable API. Also uses the HyperBandScheduler and checkpoints the model at the end. XGBoost Example ~~~~~~~~~~~~~~~ - :ref:`XGBoost tutorial `: A guide to tuning XGBoost parameters with Tune. -- `xgboost_example `__: Trains a basic XGBoost model with Tune with the function-based API and an XGBoost callback. +- :doc:`/tune/examples/xgboost_example`: Trains a basic XGBoost model with Tune with the function-based API and an XGBoost callback. LightGBM Example ~~~~~~~~~~~~~~~~ -- `lightgbm_example `__: Trains a basic LightGBM model with Tune with the function-based API and a LightGBM callback. +- :doc:`/tune/examples/lightgbm_example`: Trains a basic LightGBM model with Tune with the function-based API and a LightGBM callback. Contributed Examples ~~~~~~~~~~~~~~~~~~~~ -- `pbt_tune_cifar10_with_keras `__: A contributed example of tuning a Keras model on CIFAR10 with the PopulationBasedTraining scheduler. -- `genetic_example `__: Optimizing the michalewicz function using the contributed GeneticSearch algorithm with AsyncHyperBandScheduler. -- `tune_cifar10_gluon `__: MXNet Gluon example to use Tune with the function-based API on CIFAR-10 dataset. +- :doc:`/tune/examples/pbt_tune_cifar10_with_keras`: A contributed example of tuning a Keras model on CIFAR10 with the PopulationBasedTraining scheduler. +- :doc:`/tune/examples/genetic_example`: Optimizing the michalewicz function using the contributed GeneticSearch algorithm with AsyncHyperBandScheduler. +- :doc:`/tune/examples/tune_cifar10_gluon`: MXNet Gluon example to use Tune with the function-based API on CIFAR-10 dataset. Open Source Projects using Tune ------------------------------- diff --git a/doc/source/tune/_tutorials/tune-usage.rst b/doc/source/tune/_tutorials/tune-usage.rst index 63541cc2a..f456dca97 100644 --- a/doc/source/tune/_tutorials/tune-usage.rst +++ b/doc/source/tune/_tutorials/tune-usage.rst @@ -50,7 +50,7 @@ To leverage GPUs, you must set ``gpu`` in ``resources_per_trial``. This will aut # If you have 4 CPUs on your machine and 1 GPU, this will run 1 trial at a time. tune.run(trainable, num_samples=10, resources_per_trial={"cpu": 2, "gpu": 1}) -You can find an example of this in the `Keras MNIST example `__. +You can find an example of this in the :doc:`Keras MNIST example `. .. warning:: If 'gpu' is not set, ``CUDA_VISIBLE_DEVICES`` environment variable will be set as empty, disallowing GPU access. diff --git a/doc/source/tune/api_docs/logging.rst b/doc/source/tune/api_docs/logging.rst index 46efb6485..993143fea 100644 --- a/doc/source/tune/api_docs/logging.rst +++ b/doc/source/tune/api_docs/logging.rst @@ -58,7 +58,7 @@ You can then pass in your own logger as follows: These loggers will be called along with the default Tune loggers. You can also check out `logger.py `__ for implementation details. -An example of creating a custom logger can be found in `logging_example.py `__. +An example of creating a custom logger can be found in :doc:`/tune/examples/logging_example`. .. _trainable-logging: @@ -164,7 +164,7 @@ CSVLogger MLFLowLogger ------------ -Tune also provides a default logger for `MLFlow `_. You can install MLFlow via ``pip install mlflow``. An example can be found `mlflow_example.py `__. Note that this currently does not include artifact logging support. For this, you can use the native MLFlow APIs inside your Trainable definition. +Tune also provides a default logger for `MLFlow `_. You can install MLFlow via ``pip install mlflow``. An example can be found in :doc:`/tune/examples/mlflow_example`. Note that this currently does not include artifact logging support. For this, you can use the native MLFlow APIs inside your Trainable definition. .. autoclass:: ray.tune.logger.MLFLowLogger diff --git a/doc/source/tune/api_docs/schedulers.rst b/doc/source/tune/api_docs/schedulers.rst index bfabe0640..6c623d869 100644 --- a/doc/source/tune/api_docs/schedulers.rst +++ b/doc/source/tune/api_docs/schedulers.rst @@ -32,7 +32,7 @@ When using schedulers, you may face compatibility issues, as shown in the below * - :ref:`ASHA ` - No - Yes - - `Link `__ + - :doc:`Link ` * - :ref:`Median Stopping Rule ` - No - Yes @@ -40,15 +40,15 @@ When using schedulers, you may face compatibility issues, as shown in the below * - :ref:`HyperBand ` - Yes - Yes - - `Link `__ + - :doc:`Link ` * - :ref:`BOHB ` - Yes - Only TuneBOHB - - `Link `__ + - :doc:`Link ` * - :ref:`Population Based Training ` - Yes - Not Compatible - - `Link `__ + - :doc:`Link ` .. _tune-scheduler-hyperband: @@ -69,7 +69,7 @@ The `ASHA `__ scheduler can be used b brackets=1) tune.run( ... , scheduler=asha_scheduler) -Compared to the original version of HyperBand, this implementation provides better parallelism and avoids straggler issues during eliminations. **We recommend using this over the standard HyperBand scheduler.** An example of this can be `found here `_. +Compared to the original version of HyperBand, this implementation provides better parallelism and avoids straggler issues during eliminations. **We recommend using this over the standard HyperBand scheduler.** An example of this can be found here: :doc:`/tune/examples/async_hyperband_example`. Even though the original paper mentions a bracket count of 3, discussions with the authors concluded that the value should be left to 1 bracket. This is the default used if no value is provided for the ``brackets`` argument. @@ -141,7 +141,7 @@ Tune includes a distributed implementation of `Population Based Training (PBT) < When the PBT scheduler is enabled, each trial variant is treated as a member of the population. Periodically, top-performing trials are checkpointed (this requires your Trainable to support :ref:`save and restore `). Low-performing trials clone the checkpoints of top performers and perturb the configurations in the hope of discovering an even better variation. -You can run this `toy PBT example `__ to get an idea of how how PBT operates. When training in PBT mode, a single trial may see many different hyperparameters over its lifetime, which is recorded in its ``result.json`` file. The following figure generated by the example shows PBT with optimizing a LR schedule over the course of a single experiment: +You can run this :doc:`toy PBT example ` to get an idea of how how PBT operates. When training in PBT mode, a single trial may see many different hyperparameters over its lifetime, which is recorded in its ``result.json`` file. The following figure generated by the example shows PBT with optimizing a LR schedule over the course of a single experiment: .. image:: /pbt.png @@ -157,7 +157,7 @@ This class is a variant of HyperBand that enables the `BOHB Algorithm ` for package requirements, examples, and details. -An example of this in use can be found in `bohb_example.py `_. +An example of this in use can be found here: :doc:`/tune/examples/bohb_example`. .. autoclass:: ray.tune.schedulers.HyperBandForBOHB diff --git a/doc/source/tune/api_docs/suggestion.rst b/doc/source/tune/api_docs/suggestion.rst index 8c1232bc6..d6cafe638 100644 --- a/doc/source/tune/api_docs/suggestion.rst +++ b/doc/source/tune/api_docs/suggestion.rst @@ -25,39 +25,39 @@ Summary * - :ref:`AxSearch ` - Bayesian/Bandit Optimization - [`Ax `__] - - `Link `__ + - :doc:`/tune/examples/ax_example` * - :ref:`DragonflySearch ` - Scalable Bayesian Optimization - [`Dragonfly `__] - - `Link `__ + - :doc:`/tune/examples/dragonfly_example` * - :ref:`SkoptSearch ` - Bayesian Optimization - [`Scikit-Optimize `__] - - `Link `__ + - :doc:`/tune/examples/skopt_example` * - :ref:`HyperOptSearch ` - Tree-Parzen Estimators - [`HyperOpt `__] - - `Link `__ + - :doc:`/tune/examples/hyperopt_example` * - :ref:`BayesOptSearch ` - Bayesian Optimization - [`BayesianOptimization `__] - - `Link `__ + - :doc:`/tune/examples/bayesopt_example` * - :ref:`TuneBOHB ` - Bayesian Opt/HyperBand - [`BOHB `__] - - `Link `__ + - :doc:`/tune/examples/bohb_example` * - :ref:`NevergradSearch ` - Gradient-free Optimization - [`Nevergrad `__] - - `Link `__ + - :doc:`/tune/examples/nevergrad_example` * - :ref:`ZOOptSearch ` - Zeroth-order Optimization - [`ZOOpt `__] - - `Link `__ + - :doc:`/tune/examples/zoopt_example` * - :ref:`SigOptSearch ` - Closed source - [`SigOpt `__] - - `Link `__ + - :doc:`/tune/examples/sigopt_example` .. note::Search algorithms will require a different search space declaration than the default Tune format - meaning that you will not be able to combine ``tune.grid_search`` with the below integrations. diff --git a/doc/source/tune/examples/async_hyperband_example.rst b/doc/source/tune/examples/async_hyperband_example.rst new file mode 100644 index 000000000..5bc655d1c --- /dev/null +++ b/doc/source/tune/examples/async_hyperband_example.rst @@ -0,0 +1,6 @@ +:orphan: + +async_hyperband_example +~~~~~~~~~~~~~~~~~~~~~~~ + +.. literalinclude:: /../../python/ray/tune/examples/async_hyperband_example.py \ No newline at end of file diff --git a/doc/source/tune/examples/ax_example.rst b/doc/source/tune/examples/ax_example.rst new file mode 100644 index 000000000..5a925f341 --- /dev/null +++ b/doc/source/tune/examples/ax_example.rst @@ -0,0 +1,6 @@ +:orphan: + +ax_example +~~~~~~~~~~ + +.. literalinclude:: /../../python/ray/tune/examples/ax_example.py diff --git a/doc/source/tune/examples/bayesopt_example.rst b/doc/source/tune/examples/bayesopt_example.rst new file mode 100644 index 000000000..8e37d0399 --- /dev/null +++ b/doc/source/tune/examples/bayesopt_example.rst @@ -0,0 +1,6 @@ +:orphan: + +bayesopt_example +~~~~~~~~~~~~~~~~ + +.. literalinclude:: /../../python/ray/tune/examples/bayesopt_example.py diff --git a/doc/source/tune/examples/bohb_example.rst b/doc/source/tune/examples/bohb_example.rst new file mode 100644 index 000000000..0a8322532 --- /dev/null +++ b/doc/source/tune/examples/bohb_example.rst @@ -0,0 +1,6 @@ +:orphan: + +bohb_example +~~~~~~~~~~~~~~~ + +.. literalinclude:: /../../python/ray/tune/examples/bohb_example.py diff --git a/doc/source/tune/examples/dragonfly_example.rst b/doc/source/tune/examples/dragonfly_example.rst new file mode 100644 index 000000000..3068a60c7 --- /dev/null +++ b/doc/source/tune/examples/dragonfly_example.rst @@ -0,0 +1,6 @@ +:orphan: + +dragonfly_example +~~~~~~~~~~~~~~~~~ + +.. literalinclude:: /../../python/ray/tune/examples/dragonfly_example.py diff --git a/doc/source/tune/examples/genetic_example.rst b/doc/source/tune/examples/genetic_example.rst new file mode 100644 index 000000000..607ecf5cb --- /dev/null +++ b/doc/source/tune/examples/genetic_example.rst @@ -0,0 +1,6 @@ +:orphan: + +genetic_example +~~~~~~~~~~~~~~~ + +.. literalinclude:: /../../python/ray/tune/examples/genetic_example.py diff --git a/doc/source/tune/examples/hyperband_example.rst b/doc/source/tune/examples/hyperband_example.rst new file mode 100644 index 000000000..f023a0aef --- /dev/null +++ b/doc/source/tune/examples/hyperband_example.rst @@ -0,0 +1,6 @@ +:orphan: + +hyperband_example +================= + +.. literalinclude:: /../../python/ray/tune/examples/hyperband_example.py \ No newline at end of file diff --git a/doc/source/tune/examples/hyperopt_example.rst b/doc/source/tune/examples/hyperopt_example.rst new file mode 100644 index 000000000..2792dcb82 --- /dev/null +++ b/doc/source/tune/examples/hyperopt_example.rst @@ -0,0 +1,6 @@ +:orphan: + +hyperopt_example +~~~~~~~~~~~~~~~~ + +.. literalinclude:: /../../python/ray/tune/examples/hyperopt_example.py \ No newline at end of file diff --git a/doc/source/tune/examples/lightgbm_example.rst b/doc/source/tune/examples/lightgbm_example.rst new file mode 100644 index 000000000..41c471678 --- /dev/null +++ b/doc/source/tune/examples/lightgbm_example.rst @@ -0,0 +1,6 @@ +:orphan: + +lightgbm_example +~~~~~~~~~~~~~~~~ + +.. literalinclude:: /../../python/ray/tune/examples/lightgbm_example.py \ No newline at end of file diff --git a/doc/source/tune/examples/logging_example.rst b/doc/source/tune/examples/logging_example.rst new file mode 100644 index 000000000..af5503319 --- /dev/null +++ b/doc/source/tune/examples/logging_example.rst @@ -0,0 +1,6 @@ +:orphan: + +logging_example +~~~~~~~~~~~~~~~ + +.. literalinclude:: /../../python/ray/tune/examples/logging_example.py \ No newline at end of file diff --git a/doc/source/tune/examples/mlflow_example.rst b/doc/source/tune/examples/mlflow_example.rst new file mode 100644 index 000000000..66866990c --- /dev/null +++ b/doc/source/tune/examples/mlflow_example.rst @@ -0,0 +1,6 @@ +:orphan: + +mlflow_example +~~~~~~~~~~~~~~ + +.. literalinclude:: /../../python/ray/tune/examples/mlflow_example.py diff --git a/doc/source/tune/examples/mnist_pytorch.rst b/doc/source/tune/examples/mnist_pytorch.rst new file mode 100644 index 000000000..b01dd5c95 --- /dev/null +++ b/doc/source/tune/examples/mnist_pytorch.rst @@ -0,0 +1,7 @@ +:orphan: + +mnist_pytorch +~~~~~~~~~~~~~ + +.. literalinclude:: /../../python/ray/tune/examples/mnist_pytorch.py + diff --git a/doc/source/tune/examples/mnist_pytorch_trainable.rst b/doc/source/tune/examples/mnist_pytorch_trainable.rst new file mode 100644 index 000000000..18581e5dc --- /dev/null +++ b/doc/source/tune/examples/mnist_pytorch_trainable.rst @@ -0,0 +1,6 @@ +:orphan: + +mnist_pytorch_trainable +~~~~~~~~~~~~~~~~~~~~~~~ + +.. literalinclude:: /../../python/ray/tune/examples/mnist_pytorch_trainable.py diff --git a/doc/source/tune/examples/nevergrad_example.rst b/doc/source/tune/examples/nevergrad_example.rst new file mode 100644 index 000000000..b33b1575d --- /dev/null +++ b/doc/source/tune/examples/nevergrad_example.rst @@ -0,0 +1,6 @@ +:orphan: + +nevergrad_example +~~~~~~~~~~~~~~~~~ + +.. literalinclude:: /../../python/ray/tune/examples/nevergrad_example.py \ No newline at end of file diff --git a/doc/source/tune/examples/pbt_example.rst b/doc/source/tune/examples/pbt_example.rst new file mode 100644 index 000000000..14342e20d --- /dev/null +++ b/doc/source/tune/examples/pbt_example.rst @@ -0,0 +1,6 @@ +:orphan: + +pbt_example +~~~~~~~~~~~ + +.. literalinclude:: /../../python/ray/tune/examples/pbt_example.py diff --git a/doc/source/tune/examples/pbt_function.rst b/doc/source/tune/examples/pbt_function.rst new file mode 100644 index 000000000..ad553aeef --- /dev/null +++ b/doc/source/tune/examples/pbt_function.rst @@ -0,0 +1,6 @@ +:orphan: + +pbt_function +~~~~~~~~~~~~ + +.. literalinclude:: /../../python/ray/tune/examples/pbt_function.py diff --git a/doc/source/tune/examples/pbt_memnn_example.rst b/doc/source/tune/examples/pbt_memnn_example.rst new file mode 100644 index 000000000..11d0464b3 --- /dev/null +++ b/doc/source/tune/examples/pbt_memnn_example.rst @@ -0,0 +1,6 @@ +:orphan: + +pbt_memnn_example +~~~~~~~~~~~~~~~~~ + +.. literalinclude:: /../../python/ray/tune/examples/pbt_memnn_example.py diff --git a/doc/source/tune/examples/pbt_ppo_example.rst b/doc/source/tune/examples/pbt_ppo_example.rst new file mode 100644 index 000000000..fe33fc088 --- /dev/null +++ b/doc/source/tune/examples/pbt_ppo_example.rst @@ -0,0 +1,6 @@ +:orphan: + +pbt_ppo_example +~~~~~~~~~~~~~~~ + +.. literalinclude:: /../../python/ray/tune/examples/pbt_ppo_example.py diff --git a/doc/source/tune/examples/pbt_tune_cifar10_with_keras.rst b/doc/source/tune/examples/pbt_tune_cifar10_with_keras.rst new file mode 100644 index 000000000..db0a9b647 --- /dev/null +++ b/doc/source/tune/examples/pbt_tune_cifar10_with_keras.rst @@ -0,0 +1,6 @@ +:orphan: + +pbt_tune_cifar10_with_keras +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. literalinclude:: /../../python/ray/tune/examples/pbt_tune_cifar10_with_keras.py \ No newline at end of file diff --git a/doc/source/tune/examples/sigopt_example.rst b/doc/source/tune/examples/sigopt_example.rst new file mode 100644 index 000000000..91a1b72cf --- /dev/null +++ b/doc/source/tune/examples/sigopt_example.rst @@ -0,0 +1,6 @@ +:orphan: + +sigopt_example +~~~~~~~~~~~~~~ + +.. literalinclude:: /../../python/ray/tune/examples/sigopt_example.py diff --git a/doc/source/tune/examples/skopt_example.rst b/doc/source/tune/examples/skopt_example.rst new file mode 100644 index 000000000..8d2d55a0e --- /dev/null +++ b/doc/source/tune/examples/skopt_example.rst @@ -0,0 +1,6 @@ +:orphan: + +skopt_example +~~~~~~~~~~~~~ + +.. literalinclude:: /../../python/ray/tune/examples/skopt_example.py diff --git a/doc/source/tune/examples/tf_mnist_example.rst b/doc/source/tune/examples/tf_mnist_example.rst new file mode 100644 index 000000000..d0259b528 --- /dev/null +++ b/doc/source/tune/examples/tf_mnist_example.rst @@ -0,0 +1,6 @@ +:orphan: + +tf_mnist_example +~~~~~~~~~~~~~~~~ + +.. literalinclude:: /../../python/ray/tune/examples/tf_mnist_example.py diff --git a/doc/source/tune/examples/tune_cifar10_gluon.rst b/doc/source/tune/examples/tune_cifar10_gluon.rst new file mode 100644 index 000000000..bc07f6e87 --- /dev/null +++ b/doc/source/tune/examples/tune_cifar10_gluon.rst @@ -0,0 +1,7 @@ +:orphan: + +tune_cifar10_gluon +~~~~~~~~~~~~~~~~~~ + + +.. literalinclude:: /../../python/ray/tune/examples/tune_cifar10_gluon.py diff --git a/doc/source/tune/examples/tune_mnist_keras.rst b/doc/source/tune/examples/tune_mnist_keras.rst new file mode 100644 index 000000000..33accdfe1 --- /dev/null +++ b/doc/source/tune/examples/tune_mnist_keras.rst @@ -0,0 +1,6 @@ +:orphan: + +tune_mnist_keras +~~~~~~~~~~~~~~~~ + +.. literalinclude:: /../../python/ray/tune/examples/tune_mnist_keras.py diff --git a/doc/source/tune/examples/xgboost_example.rst b/doc/source/tune/examples/xgboost_example.rst new file mode 100644 index 000000000..b80f6dab9 --- /dev/null +++ b/doc/source/tune/examples/xgboost_example.rst @@ -0,0 +1,7 @@ +:orphan: + +xgboost_example +~~~~~~~~~~~~~~~ + + +.. literalinclude:: /../../python/ray/tune/examples/xgboost_example.py \ No newline at end of file diff --git a/doc/source/tune/examples/zoopt_example.rst b/doc/source/tune/examples/zoopt_example.rst new file mode 100644 index 000000000..a9e62c1af --- /dev/null +++ b/doc/source/tune/examples/zoopt_example.rst @@ -0,0 +1,6 @@ +:orphan: + +zoopt_example +~~~~~~~~~~~~~ + +.. literalinclude:: /../../python/ray/tune/examples/zoopt_example.py diff --git a/doc/source/using-ray-with-tensorflow.rst b/doc/source/using-ray-with-tensorflow.rst index 683fc1038..00c858959 100644 --- a/doc/source/using-ray-with-tensorflow.rst +++ b/doc/source/using-ray-with-tensorflow.rst @@ -1,10 +1,9 @@ Best Practices: Ray with Tensorflow =================================== -This document describes best practices for using the Ray core APIs with TensorFlow. Ray also provides higher-level utilities for working with Tensorflow, such as distributed training APIs (`training tensorflow example`_), Tune for hyperparameter search (`Tune tensorflow example`_), RLlib for reinforcement learning (`RLlib tensorflow example`_). +This document describes best practices for using the Ray core APIs with TensorFlow. Ray also provides higher-level utilities for working with Tensorflow, such as distributed training APIs (`training tensorflow example`_), Tune for hyperparameter search (:doc:`/tune/examples/tf_mnist_example`), RLlib for reinforcement learning (`RLlib tensorflow example`_). .. _`training tensorflow example`: tf_distributed_training.html -.. _`Tune tensorflow example`: https://github.com/ray-project/ray/blob/master/python/ray/tune/examples/tf_mnist_example.py .. _`RLlib tensorflow example`: rllib-models.html#tensorflow-models Feel free to contribute if you think this document is missing anything.