Skip to content
This repository has been archived by the owner on Dec 11, 2022. It is now read-only.

Commit

Permalink
Docs updates following github repo change
Browse files Browse the repository at this point in the history
  • Loading branch information
@galnov
galnov committed Nov 8, 2020
1 parent bc65f1f commit 57e809c
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 23 deletions.
28 changes: 14 additions & 14 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,21 @@ Thanks for taking the time to contribute!
If you would like to make code changes to Coach, whether adding new functionality or fixing a bug, please make sure to follow this list:
1. Create a new [branch](https://help.github.com/articles/about-branches/) for your work (give it a short but meaningful name related to the functionality or bug you are working on), then add commits as necessary. Once its in a reviewable state [open up a pull request](https://help.github.com/articles/about-pull-requests/)
1. Add unit tests to any new component, or update existing tests for modified component’s functionality
1. Make sure [regression tests](https://github.com/NervanaSystems/coach/tree/master/rl_coach/tests) are passing. See the [Testing section](#testing) for more details on the Coach testing methodology
1. Make sure [regression tests](https://github.com/IntelLabs/coach/tree/master/rl_coach/tests) are passing. See the [Testing section](#testing) for more details on the Coach testing methodology
1. Update documentation to reflect any API changes, or added algorithm or environment. See the [Documentation section](#documentation) for more details on Coach documentation.
1. Adding an algorithm?
1. Please follow the guidelines [here](https://nervanasystems.github.io/coach/contributing/add_agent.html)
1. Add a [benchmark](https://github.com/NervanaSystems/coach/blob/master/benchmarks/README.md) showing the results match those of the relevant research paper
1. Update the algorithms diagram (https://github.com/NervanaSystems/coach/blob/master/docs_raw/source/diagrams.xml), export as png and update the README image (https://github.com/NervanaSystems/coach/blob/master/img/algorithms.png)
1. Please follow the guidelines [here](https://intellabs.github.io/coach/contributing/add_agent.html)
1. Add a [benchmark](https://github.com/IntelLabs/coach/blob/master/benchmarks/README.md) showing the results match those of the relevant research paper
1. Update the algorithms diagram (https://github.com/IntelLabs/coach/blob/master/docs_raw/source/diagrams.xml), export as png and update the README image (https://github.com/IntelLabs/coach/blob/master/img/algorithms.png)
1. Adding an environment?
1. Please follow the guidelines here (https://nervanasystems.github.io/coach/contributing/add_env.html)
1. Please follow the guidelines here (https://intellabs.github.io/coach/contributing/add_env.html)
1. (Nice to have) Create a preset of an agent solving that environment
1. Ensure your branch is up-to-date with latest master, and get your PR reviewed and merged. Generally a reviewer will be assigned once one of the project maintainers notices a new PR (if it has been a couple of days and there hasn't been progress feel free to add a new comment or [email us](#contact)). There may be some back and forth discussion or modifications required, but if a reviewer has approved your PR they will then squash your set of commits and merge it into the master branch.


## Filing an Issue
Before filing an issue, please make sure you:
1. Search through the [issues list](https://github.com/NervanaSystems/coach/issues) to make sure a similar issue does not exist
1. Search through the [issues list](https://github.com/IntelLabs/coach/issues) to make sure a similar issue does not exist
1. Specify the following details:
1. Setup - operating system, versions of installed environments or packages (if relevant), hardware details (if relevant)
1. Use case description - command line, parameters
Expand All @@ -31,26 +31,26 @@ Before filing an issue, please make sure you:


## Testing
Coach uses the pytest framework for its tests. All tests are located in the [tests folder](https://github.com/NervanaSystems/coach/tree/master/rl_coach/tests), and are divided to four categories - Unit, Integration, Golden and Trace tests.
Please refer to the tests [README](https://github.com/NervanaSystems/coach/blob/master/rl_coach/tests/README.md) for the full details of the Coach testing methodology.
Coach uses the pytest framework for its tests. All tests are located in the [tests folder](https://github.com/IntelLabs/coach/tree/master/rl_coach/tests), and are divided to four categories - Unit, Integration, Golden and Trace tests.
Please refer to the tests [README](https://github.com/IntelLabs/coach/blob/master/rl_coach/tests/README.md) for the full details of the Coach testing methodology.
Before proposing any code changes to Coach please make sure any new functionality is tested, and that regression tests are passing.

All pull request commits are automatically run through our unit and integration tests via our CI suite, the results of which are visible on the github PR page as well as the CircleCI [Coach test results page](https://circleci.com/gh/NervanaSystems/coach). Merges to the `master` branch are blocked until these tests pass. Further end-to-end tests can optionally be run against these commits and are kicked off from the PR page by the assigned reviewer.
All pull request commits are automatically run through our unit and integration tests via our CI suite, the results of which are visible on the github PR page as well as the CircleCI [Coach test results page](https://circleci.com/gh/IntelLabs/coach). Merges to the `master` branch are blocked until these tests pass. Further end-to-end tests can optionally be run against these commits and are kicked off from the PR page by the assigned reviewer.


## Documentation
Most of Coach’s documentation is located on the [Coach GitHub Pages](https://nervanasystems.github.io/coach/). The pages contain information on Coach’s usage and features, design and components, and on how to add new agents or environments.
Their content is located in the [docs](https://github.com/NervanaSystems/coach/tree/master/docs) folder, which is built from the raw files under the [docs_raw](https://github.com/NervanaSystems/coach/tree/master/docs_raw) folder.
When making documentation changes, please modify the files in the docs_raw folder, and refer to the [README](https://github.com/NervanaSystems/coach/blob/master/docs_raw/README.md) for instructions on how to build the docs folder.
Most of Coach’s documentation is located on the [Coach GitHub Pages](https://intellabs.github.io/coach/). The pages contain information on Coach’s usage and features, design and components, and on how to add new agents or environments.
Their content is located in the [docs](https://github.com/IntelLabs/coach/tree/master/docs) folder, which is built from the raw files under the [docs_raw](https://github.com/IntelLabs/coach/tree/master/docs_raw) folder.
When making documentation changes, please modify the files in the docs_raw folder, and refer to the [README](https://github.com/IntelLabs/coach/blob/master/docs_raw/README.md) for instructions on how to build the docs folder.
Both the docs_raw and docs folders need to be committed when documentation changes are made.


## Releases
Coach is released as two pypi packages:

[rl-coach](https://pypi.org/project/rl-coach/) - contains the full tensorflow-based installation. Note that most environments require additional packages to be installed. We point to the relevant installation instructions in the [README](https://github.com/NervanaSystems/coach#supported-environments).
[rl-coach](https://pypi.org/project/rl-coach/) - contains the full tensorflow-based installation. Note that most environments require additional packages to be installed. We point to the relevant installation instructions in the [README](https://github.com/IntelLabs/coach#supported-environments).

[rl-coach-slim](https://pypi.org/project/rl-coach-slim/) - same as rl-coach, except for the deep learning framework (so user can use an already installed Tensorflow or MxNet framework, or explicitly state which one to install), and Kubernetes (for [distributed Coach](https://nervanasystems.github.io/coach/dist_usage.html)).
[rl-coach-slim](https://pypi.org/project/rl-coach-slim/) - same as rl-coach, except for the deep learning framework (so user can use an already installed Tensorflow or MxNet framework, or explicitly state which one to install), and Kubernetes (for [distributed Coach](https://intellabs.github.io/coach/dist_usage.html)).

Each pypi package release has a GitHub release and tag with the same version number. The numbers are of the X.Y.Z format, where

Expand Down
18 changes: 9 additions & 9 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Coach

[![CI](https://img.shields.io/circleci/project/github/NervanaSystems/coach/master.svg)](https://circleci.com/gh/NervanaSystems/workflows/coach/tree/master)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/NervanaSystems/coach/blob/master/LICENSE)
[![Docs](https://readthedocs.org/projects/carla/badge/?version=latest)](https://nervanasystems.github.io/coach/)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/IntelLabs/coach/blob/master/LICENSE)
[![Docs](https://readthedocs.org/projects/carla/badge/?version=latest)](https://intellabs.github.io/coach/)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.1134898.svg)](https://doi.org/10.5281/zenodo.1134898)

<p align="center"><img src="img/coach_logo.png" alt="Coach Logo" width="200"/></p>
Expand All @@ -29,7 +29,7 @@ coach -p CartPole_DQN -r
* [Release 0.9.0](https://ai.intel.com/reinforcement-learning-coach-carla-qr-dqn/)
* [Release 0.10.0](https://ai.intel.com/introducing-reinforcement-learning-coach-0-10-0/)
* [Release 0.11.0](https://ai.intel.com/rl-coach-data-science-at-scale)
* [Release 0.12.0](https://github.com/NervanaSystems/coach/releases/tag/v0.12.0)
* [Release 0.12.0](https://github.com/IntelLabs/coach/releases/tag/v0.12.0)
* [Release 1.0.0](https://www.intel.ai/rl-coach-new-release) (current release)


Expand Down Expand Up @@ -58,7 +58,7 @@ One of the main challenges when building a research project, or a solution based

Note: Coach has only been tested on Ubuntu 16.04 LTS, and with Python 3.5.

For some information on installing on Ubuntu 17.10 with Python 3.6.3, please refer to the following issue: https://github.com/NervanaSystems/coach/issues/54
For some information on installing on Ubuntu 17.10 with Python 3.6.3, please refer to the following issue: https://github.com/IntelLabs/coach/issues/54

In order to install coach, there are a few prerequisites required. This will setup all the basics needed to get the user going with running Coach on top of [OpenAI Gym](https://github.com/openai/gym) environments:

Expand Down Expand Up @@ -111,9 +111,9 @@ In addition to OpenAI Gym, several other environments were tested and are suppor
## Getting Started

### Tutorials and Documentation
[Jupyter notebooks demonstrating how to run Coach from command line or as a library, implement an algorithm, or integrate an environment](https://github.com/NervanaSystems/coach/tree/master/tutorials).
[Jupyter notebooks demonstrating how to run Coach from command line or as a library, implement an algorithm, or integrate an environment](https://github.com/IntelLabs/coach/tree/master/tutorials).

[Framework documentation, algorithm description and instructions on how to contribute a new agent/environment](https://nervanasystems.github.io/coach/).
[Framework documentation, algorithm description and instructions on how to contribute a new agent/environment](https://intellabs.github.io/coach/).

### Basic Usage

Expand Down Expand Up @@ -167,7 +167,7 @@ For example:

It is easy to create new presets for different levels or environments by following the same pattern as in presets.py

More usage examples can be found [here](https://github.com/NervanaSystems/coach/blob/master/tutorials/0.%20Quick%20Start%20Guide.ipynb).
More usage examples can be found [here](https://github.com/IntelLabs/coach/blob/master/tutorials/0.%20Quick%20Start%20Guide.ipynb).

#### Running Coach Dashboard (Visualization)
Training an agent to solve an environment can be tricky, at times.
Expand All @@ -190,12 +190,12 @@ dashboard
### Distributed Multi-Node Coach

As of release 0.11.0, Coach supports horizontal scaling for training RL agents on multiple nodes. In release 0.11.0 this was tested on the ClippedPPO and DQN agents.
For usage instructions please refer to the documentation [here](https://nervanasystems.github.io/coach/dist_usage.html).
For usage instructions please refer to the documentation [here](https://intellabs.github.io/coach/dist_usage.html).

### Batch Reinforcement Learning

Training and evaluating an agent from a dataset of experience, where no simulator is available, is supported in Coach.
There are [example](https://github.com/NervanaSystems/coach/blob/master/rl_coach/presets/CartPole_DDQN_BatchRL.py) [presets](https://github.com/NervanaSystems/coach/blob/master/rl_coach/presets/Acrobot_DDQN_BCQ_BatchRL.py) and a [tutorial](https://github.com/NervanaSystems/coach/blob/master/tutorials/4.%20Batch%20Reinforcement%20Learning.ipynb).
There are [example](https://github.com/IntelLabs/coach/blob/master/rl_coach/presets/CartPole_DDQN_BatchRL.py) [presets](https://github.com/IntelLabs/coach/blob/master/rl_coach/presets/Acrobot_DDQN_BCQ_BatchRL.py) and a [tutorial](https://github.com/IntelLabs/coach/blob/master/tutorials/4.%20Batch%20Reinforcement%20Learning.ipynb).


## Supported Environments
Expand Down

0 comments on commit 57e809c

Please sign in to comment.