mirror of
https://github.com/vale981/ray
synced 2025-03-09 12:56:46 -04:00

Continuing docs overhaul, tune now has: - [x] better landing page - [x] a getting started guide - [x] user guide was cut down, partially merged with FAQ, and partially integrated with tutorials - [x] the new user guide contains guides to tune features and practical integrations - [x] we rewrote some of the feature guides for clarity - [x] we got rid of sphinx-gallery for this sub-project (only data and core left), as it looks bad and is unnecessarily complicated anyway (plus, makes the build slower) - [x] sphinx-gallery examples are now moved to markdown notebook, as started in #22030. - [x] Examples are tested in the new framework, of course. There's still a lot one can do, but this is already getting too large. Will follow up with more fine-tuning next week. Co-authored-by: Antoni Baum <antoni.baum@protonmail.com> Co-authored-by: Kai Fricke <krfricke@users.noreply.github.com>
31 lines
641 B
ReStructuredText
31 lines
641 B
ReStructuredText
.. _tune-api-ref:
|
|
|
|
Ray Tune API
|
|
============
|
|
|
|
.. tip:: We'd love to hear your feedback on using Tune - `get in touch <https://forms.gle/PTRvGLbKRdUfuzQo9>`_!
|
|
|
|
This section contains a reference for the Tune API. If there is anything missing, please open an issue
|
|
on `Github`_.
|
|
|
|
.. _`GitHub`: https://github.com/ray-project/ray/issues
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
execution.rst
|
|
env.rst
|
|
trainable.rst
|
|
search_space.rst
|
|
suggestion.rst
|
|
schedulers.rst
|
|
stoppers.rst
|
|
reporters.rst
|
|
analysis.rst
|
|
sklearn.rst
|
|
logging.rst
|
|
integration.rst
|
|
internals.rst
|
|
client.rst
|
|
cli.rst
|
|
scalability.rst
|