[docs] update to expose libraries + landing page #1642
Conversation
|
Test FAILed. |
|
Test PASSed. |
|
Test PASSed. |
|
Test PASSed. |
|
Somehow it might be nice to indicate that HyperBand isn't a library, as with PBT. I do believe these things are worth highlighting and am not sure about the right formatting. @robertnishihara @pcmoritz @concretevitamin @vlad17 any thoughts? |
|
Yeah I don't know if readthedocs has some syntax for a nested page. |
|
|
|
seems good to me |
|
Test PASSed. |
|
Test PASSed. |
doc/source/hyperband.rst
Outdated
| Asynchronous HyperBand | ||
| ---------------------- | ||
|
|
||
| Ray Tune also implements an `asynchronous version of HyperBand <https://openreview.net/forum?id=S1Y7OOlRZ>`__, providing better parallelism and avoids straggler issues during eliminations. An example of this can be found in `async_hyperband_example.py <https://github.com/ray-project/ray/blob/master/python/ray/tune/examples/async_hyperband_example.py>`__. **We recommend using this over the vanilla HyperBand scheduler.** |
There was a problem hiding this comment.
Should we recommend this as the default one?
There was a problem hiding this comment.
reordered the docs so that it shows up first
doc/source/hyperband.rst
Outdated
|
|
||
| .. image:: images/hyperband_eta.png | ||
|
|
||
| We figured that it would be a lot easier for majority of people to use if we fixed the parameters to be the same as the example given in the paper and only exposed `max_t`. |
There was a problem hiding this comment.
This phrasing sounds more like a blog post, reword for documentation?
|
addressed comments and tweaked a little more; I'll merge for now after tests pass(as there are no substantial changes) but if there are issues we can just patch it. |
|
Sounds good! |
|
Test PASSed. |
|
Test PASSed. |
|
Test PASSed. |
|
Test PASSed. |
|
Test PASSed. |
What do these changes do?
This reorganizes the tune docs to give important algorithms their own page (we should add more as new algorithms are added). This should hopefully help with SEO -- currently if you search for "HyperBand" the tune docs don't even show up in the first couple pages. However if you search for "A3C" or "Rllib" those terms already rank highly.