Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TUNE] Tune Docs re-organization #9600

Merged
merged 9 commits into from
Jul 29, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fix-tutorils
  • Loading branch information
richardliaw committed Jul 29, 2020
commit d084d5e73ae6641db2c26de927bbec6633b2e2d6
39 changes: 34 additions & 5 deletions doc/source/tune/_tutorials/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ Tutorials

.. tip:: We'd love to hear your feedback on using Tune - fill out a `short survey <https://forms.gle/PTRvGLbKRdUfuzQo9>`_!

.. tip:: We'd love to hear your feedback on using Tune - fill out a `short survey <https://forms.gle/PTRvGLbKRdUfuzQo9>`_!

In this section, you can find material on how to use Tune and its various features. If any of the materials is out of date or broken, or if you'd like to add an example to this page, feel free to raise an issue on our Github repository.

Take a look at any of the below tutorials to get started with Tune.
Expand All @@ -14,23 +12,54 @@ Take a look at any of the below tutorials to get started with Tune.
<div class="sphx-glr-bigcontainer">

.. customgalleryitem::
:tooltip: Tune concepts in 60 seconds.
:tooltip: Key concepts in 60 seconds.
:figure: /images/tune-workflow.png
:description: :doc:`Tune concepts in 60 seconds <tune-60-seconds>`
:description: :doc:`Key concepts in 60 seconds </tune/key-concepts>`

.. customgalleryitem::
:tooltip: A simple Tune walkthrough.
:figure: /images/tune.png
:description: :doc:`A walkthrough to setup your first Tune experiment <tune-tutorial>`

.. customgalleryitem::
:tooltip: A simple guide to Population-based Training
:figure: /images/tune-pbt-small.png
:description: :doc:`A simple guide to Population-based Training <tune-advanced-tutorial>`

.. customgalleryitem::
:tooltip: A guide to distributed hyperparameter tuning
:figure: /images/tune.png
:description: :doc:`A guide to distributed hyperparameter tuning <tune-distributed>`

.. customgalleryitem::
:tooltip: Tune's Scikit-Learn Adapters
:figure: /images/tune-sklearn.png
:description: :doc:`Tune's Scikit-Learn Adapters <tune-sklearn>`

.. customgalleryitem::
:tooltip: How to use Tune with PyTorch
:figure: /images/pytorch_logo.png
:description: :doc:`How to use Tune with PyTorch <tune-pytorch-cifar>`

.. customgalleryitem::
:tooltip: Tuning PyTorch Lightning modules
:figure: /images/pytorch_lightning_small.png
:description: :doc:`Tuning PyTorch Lightning modules <tune-pytorch-lightning>`

.. customgalleryitem::
:tooltip: Tuning XGBoost parameters.
:figure: /images/xgboost_logo.png
:description: :doc:`A guide to tuning XGBoost parameters with Tune <tune-xgboost>`


.. raw:: html

</div>


.. toctree::
:hidden:

tune-60-seconds.rst
tune-tutorial.rst
tune-advanced-tutorial.rst
tune-distributed.rst
Expand Down
208 changes: 0 additions & 208 deletions doc/source/tune/_tutorials/tune-60-seconds.rst

This file was deleted.

2 changes: 1 addition & 1 deletion doc/source/tune/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Tune is a Python library for experiment execution and hyperparameter tuning at a

.. _`Ray Serve`: serve/index.html

**Want to get started?** Head over to the :ref:`60 second Tune tutorial <tune-60-seconds>`.
**Want to get started?** Head over to the :doc:`Key Concepts page </tune/key-concepts>`.

.. tip:: We'd love to hear your feedback on using Tune - fill out a `short survey <https://forms.gle/PTRvGLbKRdUfuzQo9>`_!

Expand Down
4 changes: 3 additions & 1 deletion doc/source/tune/key-concepts.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _tune-60-seconds:

============
Key Concepts
============
Expand Down Expand Up @@ -192,7 +194,7 @@ Now that you have a working understanding of Tune, check out:
* :doc:`/tune/user-guide`: A comprehensive overview of Tune's features.
* :doc:`/tune/examples/index`: Examples and templates for using Tune with your preferred machine learning library.
* :ref:`tune-tutorial`: A simple tutorial that walks you through the process of setting up a Tune experiment.


Further Questions or Issues?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down