From 0dfa786c8fc73309278454afc30e5d233c9d0a8d Mon Sep 17 00:00:00 2001 From: Jun Gong Date: Tue, 15 Feb 2022 00:21:23 -0800 Subject: [PATCH 1/2] Add example commands for using setup-dev.py --- doc/source/rllib/rllib-dev.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/doc/source/rllib/rllib-dev.rst b/doc/source/rllib/rllib-dev.rst index 527a9a43b2c5..26e5614d6932 100644 --- a/doc/source/rllib/rllib-dev.rst +++ b/doc/source/rllib/rllib-dev.rst @@ -6,7 +6,13 @@ Contributing to RLlib Development Install ------------------- -You can develop RLlib locally without needing to compile Ray by using the `setup-dev.py `__ script. This sets up links between the ``rllib`` dir in your git repo and the one bundled with the ``ray`` package. However if you have installed ray from source using `these instructions `__ then do not this as these steps should have already created this symlink. When using this script, make sure that your git branch is in sync with the installed Ray binaries (i.e., you are up-to-date on `master `__ and have the latest `wheel `__ installed.) +You can develop RLlib locally without needing to compile Ray by using the `setup-dev.py `__ script. This sets up links between the ``rllib`` dir in your git repo and the one bundled with the ``ray`` package. However if you have installed ray from source using `these instructions `__ then do not use this, as these steps should have already created this symlink. When using this script, make sure that your git branch is in sync with the installed Ray binaries (i.e., you are up-to-date on `master `__ and have the latest `wheel `__ installed.) + +.. code-block:: bash + git clone [your fork] + cd ray + # only enter 'Y' at the first question on linking RLlib + python python/ray/setup-dev.py API Stability ------------- From 79c20c256d859a60d3e8066ee4b8ee06f52d493f Mon Sep 17 00:00:00 2001 From: Sven Mika Date: Tue, 15 Feb 2022 10:36:24 +0100 Subject: [PATCH 2/2] Apply suggestions from code review --- doc/source/rllib/rllib-dev.rst | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/doc/source/rllib/rllib-dev.rst b/doc/source/rllib/rllib-dev.rst index 26e5614d6932..223c3fe6b29e 100644 --- a/doc/source/rllib/rllib-dev.rst +++ b/doc/source/rllib/rllib-dev.rst @@ -6,12 +6,20 @@ Contributing to RLlib Development Install ------------------- -You can develop RLlib locally without needing to compile Ray by using the `setup-dev.py `__ script. This sets up links between the ``rllib`` dir in your git repo and the one bundled with the ``ray`` package. However if you have installed ray from source using `these instructions `__ then do not use this, as these steps should have already created this symlink. When using this script, make sure that your git branch is in sync with the installed Ray binaries (i.e., you are up-to-date on `master `__ and have the latest `wheel `__ installed.) +You can develop RLlib locally without needing to compile Ray by using the `setup-dev.py `__ script. +This sets up symlinks between the ``ray/rllib`` dir in your local git clone and the respective directory bundled with the pip-installed ``ray`` package. This way, every change you make in the source files in your local git clone will immediately be reflected in your installed ``ray`` as well. +However if you have installed ray from source using `these instructions `__ then do not use this, as these steps should have already created this symlink. +When using this script, make sure that your git branch is in sync with the installed Ray binaries (i.e., you are up-to-date on `master `__ and have the latest `wheel `__ installed.) .. code-block:: bash - git clone [your fork] + + # Clone your fork onto your local machine, e.g.: + git clone https://github.com/[your username]/ray.git cd ray - # only enter 'Y' at the first question on linking RLlib + # Only enter 'Y' at the first question on linking RLlib. + # This leads to the most stable behavior and you won't have to re-install ray as often. + # If you anticipate making changes to e.g. tune quite often, consider also symlinking ray tune here + # (say 'Y' when asked by the script about creating the tune symlink). python python/ray/setup-dev.py API Stability