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

docs: Updated documentation #732

Merged
merged 2 commits into from
Jun 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
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
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,16 @@ tuner.run()

The above example runs ASHA with 4 asynchronous workers on a local machine.

## Experimentation with Syne Tune

If you plan to use advanced features of Syne Tune, such as different execution
backends or running experiments remotely, writing launcher scripts like
`examples/launch_height_simple.py` can become tedious. Syne Tune provides an
advanced experimentation framework, which you can learn about in
[this tutorial](https://syne-tune.readthedocs.io/en/latest/tutorials/experimentation/README.html)
or also in
[this one](https://syne-tune.readthedocs.io/en/latest/tutorials/odsc_tutorial/README.html).

## Supported HPO methods

The following hyperparameter optimization (HPO) methods are available in Syne Tune:
Expand Down Expand Up @@ -198,6 +208,12 @@ different functionalities provided by Syne Tune. For example:
launches HPO locally with [Ray Tune](https://docs.ray.io/en/master/tune/index.html)
scheduler

## Examples for Experimentation and Benchmarking

You will find many examples for experimentation and benchmarking in
[benchmarking/examples/](benchmarking/examples/) and in
benchmarking/nusery/](benchmarking/nursery/).

## FAQ and Tutorials

You can check our [FAQ](https://syne-tune.readthedocs.io/en/latest/faq.html), to
Expand Down Expand Up @@ -242,10 +258,12 @@ Do you want to know more? Here are a number of tutorials.
* [Using the Built-in Schedulers](https://syne-tune.readthedocs.io/en/latest/schedulers.html)
* [Multi-Fidelity Hyperparameter Optimization](https://syne-tune.readthedocs.io/en/latest/tutorials/multifidelity/README.html)
* [Benchmarking in Syne Tune](https://syne-tune.readthedocs.io/en/latest/tutorials/benchmarking/README.html)
* [Visualization of Results](https://syne-tune.readthedocs.io/en/latest/tutorials/visualization/README.html)
* [Rapid Experimentation with Syne Tune](https://syne-tune.readthedocs.io/en/latest/tutorials/experimentation/README.html)
* [How to Contribute a New Scheduler](https://syne-tune.readthedocs.io/en/latest/tutorials/developer/README.html)
* [PASHA: Efficient HPO and NAS with Progressive Resource Allocation](https://syne-tune.readthedocs.io/en/latest/tutorials/pasha/pasha.html)
* [Using Syne Tune for Transfer Learning](https://syne-tune.readthedocs.io/en/latest/tutorials/transfer_learning/transfer_learning.html)

* [Distributed Hyperparameter Tuning: Finding the Right Model can be Fast and Fun](https://syne-tune.readthedocs.io/en/latest/tutorials/odsc_tutorial/README.html)

## Blog Posts

Expand Down
4 changes: 3 additions & 1 deletion docs/source/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,9 @@ backends or running experiments remotely, writing launcher scripts like
``examples/launch_height_simple.py`` can become tedious. Syne Tune provides an
advanced experimentation framework, which you can learn about in
`this tutorial <tutorials/experimentation/README.html>`__, or also in
`this one <tutorials/odsc_tutorial/README.html>`__.
`this one <tutorials/odsc_tutorial/README.html>`__. Examples for the
experimentation framework are given in :mod:`benchmarking.examples` and
:mod:`benchmarking.nursery`.

Supported HPO Methods
=====================
Expand Down
5 changes: 5 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,11 @@ What's New?
tutorials/transfer_learning/transfer_learning
tutorials/odsc_tutorial/README

Videos
------

* `Martin Wistuba: Hyperparameter Optimization for the Impatient (PyData 2023) <https://www.youtube.com/watch?v=onX6fXzp9Yk>`__

.. toctree::
:name: API docs
:caption: API docs
Expand Down