say which port is local and which one is remote (#1591)

This commit is contained in:
Philipp Moritz 2018-02-25 10:19:12 -08:00 committed by Robert Nishihara
parent 5859a2d249
commit 2026c147ec
2 changed files with 2 additions and 2 deletions

View file

@ -237,7 +237,7 @@ To use the Client API, you can start your experiment with ``with_server=True``:
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 <port>:localhost:<port> <address>``) so that you can use the Client on your local machine.
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.
.. autoclass:: ray.tune.web_server.TuneClient
:members:

View file

@ -50,7 +50,7 @@ with the ``-L`` option as such:
.. code-block:: bash
ssh -L <port>:localhost:<port> <user>@<ip-address>
ssh -L <local_port>:localhost:<remote_port> <user>@<ip-address>
So for the above URL, you would use the port 8889. The Jupyter notebook attempts
to run on port 8888, but if that fails it tries successive ports until it finds