wassname/ray
1
0
Fork 0
mirror of https://github.com/wassname/ray.git synced 2026-08-15 12:45:23 +08:00
Code Issues Packages Projects Releases Wiki Activity

[tune] Support RESTful API for the Web Server (#4080)

Browse Source 
Change the client/server API to RESTful design. This includes resource modeling, model URI's, and correct HTTP methods.
This commit is contained in:
Adi Zimmerman
2019-02-26 21:56:02 -08:00
committed by Richard Liaw
parent 33663bef94
commit 5cf388f29d
5 changed files with 209 additions and 112 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/source/tune-usage.rst
+24 -10
View File
@@ -457,29 +457,43 @@ be wrapped with ``tune.function``):
)
Client API
----------
Tune Client API
---------------
You can modify an ongoing experiment by adding or deleting trials using the Tune Client API. To do this, verify that you have the ``requests`` library installed:
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.
.. code-block:: bash
$ pip install requests
To use the Client API, you can 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 ``with_server=True``:
.. code-block:: python
run_experiments({...}, with_server=True, server_port=4321)
Then, on the client side, you can use the following class. The server address defaults to ``localhost:4321``. If on a cluster, you may want to forward this port (e.g. ``ssh -L <local_port>:localhost:<remote_port> <address>``) so that you can use the Client on your local machine.
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:
.. code-block:: bash
$ pip install requests
Then, on the client side, you can use the following class. If on a cluster, you may want to forward this port (e.g. ``ssh -L <local_port>:localhost:<remote_port> <address>``) so that you can use the Client on your local machine.
.. autoclass:: ray.tune.web_server.TuneClient
:members:
For an example notebook for using the Client API, see the `Client API Example <https://github.com/ray-project/ray/tree/master/python/ray/tune/TuneClient.ipynb>`__.
The API also supports curl. Here are the examples for getting trials (``GET /trials/[:id]``):
.. code-block:: bash
curl http://<address>:<port>/trials
curl http://<address>:<port>/trials/<trial_id>
And stopping a trial (``PUT /trials/[:id]``):
.. code-block:: bash
curl -X PUT http://<address>:<port>/trials/<trial_id>
Further Questions or Issues?
----------------------------