[tune] API revamp fix (#10518)

This commit is contained in:
Richard Liaw
2020-09-05 15:34:53 -07:00
committed by GitHub
parent 8a891b3c30
commit 551c597312
26 changed files with 349 additions and 269 deletions
+2 -2
View File
@@ -3,11 +3,11 @@ Tune Client API
You can interact with an ongoing experiment with the Tune Client API. The Tune Client API is organized around REST, which includes resource-oriented URLs, accepts form-encoded requests, returns JSON-encoded responses, and uses standard HTTP protocol.
To allow Tune to receive and respond to your API calls, you have to start your experiment with ``with_server=True``:
To allow Tune to receive and respond to your API calls, you have to start your experiment with ``tune.run(server_port)``:
.. code-block:: python
tune.run(..., with_server=True, server_port=4321)
tune.run(..., server_port=4321)
The easiest way to use the Tune Client API is with the built-in TuneClient. To use TuneClient, verify that you have the ``requests`` library installed:
+7
View File
@@ -25,3 +25,10 @@ Stopper (tune.Stopper)
.. autoclass:: ray.tune.Stopper
:members: __call__, stop_all
.. _tune-sync-config:
tune.SyncConfig
---------------
.. autofunction:: ray.tune.SyncConfig