[docs][tune] Make search algorithm, scheduler docs better! (#8179)

This commit is contained in:
Richard Liaw
2020-05-17 12:19:44 -07:00
committed by GitHub
parent 2ff26f13d2
commit 87cbf2aedd
19 changed files with 630 additions and 720 deletions
@@ -132,9 +132,9 @@ To optimize the hyperparameters of your training process, you will want to use a
stop={"training_iteration": 20}
)
Tune has SearchAlgorithms that integrate with many popular **optimization** libraries, such as :ref:`Nevergrad <tune-nevergrad>` and :ref:`Hyperopt <tune-hyperopt>`.
Tune has SearchAlgorithms that integrate with many popular **optimization** libraries, such as :ref:`Nevergrad <nevergrad>` and :ref:`Hyperopt <tune-hyperopt>`.
See the documentation: :ref:`searchalg-ref`.
See the documentation: :ref:`tune-search-alg`.
Trial Schedulers
----------------
+4 -3
View File
@@ -282,8 +282,11 @@ Note that in the above example the currently running trials will not stop immedi
Logging/Tensorboard
-------------------
Tune by default will log results for Tensorboard, CSV, and JSON formats. If you need to log something lower level like model weights or gradients, see :ref:`Trainable Logging <trainable-logging>`.
**Learn more about logging and customizations here**: :ref:`loggers-docstring`.
Tune will log the results of each trial to a subfolder under a specified local dir, which defaults to ``~/ray_results``.
Tune by default will log results for Tensorboard, CSV, and JSON formats.
.. code-block:: bash
@@ -292,8 +295,6 @@ Tune by default will log results for Tensorboard, CSV, and JSON formats.
# trainable_name and trial_name are autogenerated.
tune.run(trainable, num_samples=2)
Learn about how to customize logging paths and outputs: :ref:`loggers-docstring`.
Tune automatically outputs Tensorboard files during ``tune.run``. To visualize learning in tensorboard, install tensorboardX:
.. code-block:: bash