From 2702b15b04f3e8a84f65f98ccb6e7300755a217f Mon Sep 17 00:00:00 2001 From: Timon Ruban Date: Wed, 5 Jun 2019 18:04:36 +0200 Subject: [PATCH] [tune] Add requirements-dev.txt and update docs for contributing (#4925) * Add requirements-dev.txt and update docs. * Update doc/source/tune-contrib.rst Co-Authored-By: Richard Liaw * Unpin everything except for yapf. --- doc/source/tune-contrib.rst | 15 ++++++++++----- python/ray/tune/requirements-dev.txt | 9 +++++++++ 2 files changed, 19 insertions(+), 5 deletions(-) create mode 100644 python/ray/tune/requirements-dev.txt diff --git a/doc/source/tune-contrib.rst b/doc/source/tune-contrib.rst index f945ee679..4774791e3 100644 --- a/doc/source/tune-contrib.rst +++ b/doc/source/tune-contrib.rst @@ -15,10 +15,9 @@ We welcome (and encourage!) all forms of contributions to Tune, including and no Setting up a development environment ------------------------------------ -If you have Ray installed via pip (``pip install -U ray``), you can develop Tune locally without needing to compile Ray. +If you have Ray installed via pip (``pip install -U [link to wheel]`` - you can find the link to the latest wheel `here `__), you can develop Tune locally without needing to compile Ray. - -First, you will need your own [fork](https://help.github.com/en/articles/fork-a-repo) to work on the code. Press the Fork button on the `ray project page `__. +First, you will need your own `fork `__ to work on the code. Press the Fork button on the `ray project page `__. Then, clone the project to your machine and connect your repository to the upstream (main project) ray repository. .. code-block:: shell @@ -28,10 +27,16 @@ Then, clone the project to your machine and connect your repository to the upstr git remote add upstream https://github.com/ray-project/ray.git +Before continuing, 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.) + Then, run `[path to ray directory]/python/ray/setup-dev.py` `(also here on Github) `__ script. This sets up links between the ``tune`` dir (among other directories) in your local repo and the one bundled with the ``ray`` package. -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.) +As a last step make sure to install all packages required for development of tune. This can be done by running: + +.. code-block:: shell + + pip install -r [path to ray directory]/python/ray/tune/requirements-dev.txt What can I work on? @@ -89,7 +94,7 @@ burden and speedup review process. Documentation should be documented in `Google style `__ format. We also have tests for code formatting and linting that need to pass before merge. -Install `yapf==0.23, flake8, flake8-quotes`. You can run the following locally: +Install `yapf==0.23, flake8, flake8-quotes` (these are also in the `requirements-dev.txt` found in ``python/ray/tune``). You can run the following locally: .. code-block:: shell diff --git a/python/ray/tune/requirements-dev.txt b/python/ray/tune/requirements-dev.txt new file mode 100644 index 000000000..9d3d3ddab --- /dev/null +++ b/python/ray/tune/requirements-dev.txt @@ -0,0 +1,9 @@ +flake8 +flake8-quotes +gym +opencv-python +pandas +requests +tabulate +tensorflow +yapf==0.23.0