Skip to content

[rllib] Update RLlib docs and README #1288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 20 commits into from
Dec 7, 2017
Merged

[rllib] Update RLlib docs and README #1288

merged 20 commits into from
Dec 7, 2017

Conversation

ericl
Copy link
Contributor

@ericl ericl commented Dec 4, 2017 •
edited
Loading

What do these changes do?

Updates the rllib docs.

cc @pcmoritz @richardliaw

@AmplabJenkins
Copy link

Merged build finished. Test FAILed.

@AmplabJenkins
Copy link

Test FAILed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/2638/
Test FAILed.

@AmplabJenkins
Copy link

Merged build finished. Test FAILed.

@AmplabJenkins
Copy link

Test FAILed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/2639/
Test FAILed.

@AmplabJenkins
Copy link

Merged build finished. Test FAILed.

@AmplabJenkins
Copy link

Test FAILed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/2640/
Test FAILed.

@pcmoritz pcmoritz self-requested a review December 6, 2017 01:33
pcmoritz
pcmoritz reviewed Dec 6, 2017
View reviewed changes
Copy link
Contributor

@pcmoritz pcmoritz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We probably want to have a sphinx file for developers too so that we can have autogenerated documentation. The README should contain a higher level description to RLlib, link to the documentation and the paper once it is up.

@ericl
Copy link
Contributor Author

ericl commented Dec 6, 2017 •
edited
Loading

@pcmoritz that makes sense, I think we should have in the Sphinx docs (1) a user-facing RLlib page, and a (2) page with RLlib developer APIs and docs.

For now though I just moved the dev API to the end of the user doc page.

@ericl ericl changed the title [rllib] Split documentation across sphinx docs and README [rllib] Update RLlib docs and README Dec 6, 2017
@AmplabJenkins
Copy link

Merged build finished. Test FAILed.

@AmplabJenkins
Copy link

Test FAILed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/2645/
Test FAILed.

@AmplabJenkins
Copy link

Merged build finished. Test FAILed.

@AmplabJenkins
Copy link

Test FAILed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/2646/
Test FAILed.

@AmplabJenkins
Copy link

Merged build finished. Test FAILed.

@AmplabJenkins
Copy link

Test FAILed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/2647/
Test FAILed.

@AmplabJenkins
Copy link

Merged build finished. Test FAILed.

@AmplabJenkins
Copy link

Test FAILed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/2648/
Test FAILed.

richardliaw
richardliaw reviewed Dec 6, 2017
View reviewed changes
Copy link
Contributor

@richardliaw richardliaw left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One other change is to add a link to Tune and RLlib on https://github.com/ray-project/ray/blob/master/README.rst so that people who stumble upon the ray repository can find RLlib easily.

doc/source/rllib.rst Outdated
- Pluggable distributed RL execution strategies

- Composability
- Integration with the Ray.tune hyperparam tuning tool
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you link to the Tune docs here?

@ericl ericl force-pushed the rllib-doc-refactor branch 3 times, most recently from 603303f to e839e9b Compare December 7, 2017 00:18
@ericl ericl force-pushed the rllib-doc-refactor branch from e839e9b to c1add88 Compare December 7, 2017 00:18
@AmplabJenkins
Copy link

Merged build finished. Test FAILed.

@AmplabJenkins
Copy link

Test FAILed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/2656/
Test FAILed.

@AmplabJenkins
Copy link

Merged build finished. Test FAILed.

@AmplabJenkins
Copy link

Test FAILed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/2657/
Test FAILed.

@AmplabJenkins
Copy link

Merged build finished. Test FAILed.

@AmplabJenkins
Copy link

Test FAILed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/Ray-PRB/2658/
Test FAILed.

@richardliaw richardliaw mentioned this pull request Dec 7, 2017
Merged
@ericl
Copy link
Contributor Author

ericl commented Dec 7, 2017

jenkins builds are currently down
the linux travis tests all pass, but the mac tests are backlogged

@ericl ericl merged commit 35f7398 into ray-project:master Dec 7, 2017
@aldanor
Copy link

aldanor commented Dec 8, 2017

Minor suggestion, would it be cleaner to provide rllib/requirements.txt so the users can just pip install -r rlllib/requirements.txt as opposed to copying/pasting from the README? (Travis can use the same file too then)

@robertnishihara
Copy link
Collaborator

@aldanor that would be fine, though it seems cleaner to me to let users do pip install ray[rllib], e.g., as in

https://github.com/openai/gym/blob/efeadfdd20992aeba69e038205af90d340c5f95b/setup.py#L9-L16

what do you think?

@robertnishihara robertnishihara deleted the rllib-doc-refactor branch December 9, 2017 09:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pcmoritz pcmoritz pcmoritz left review comments

@richardliaw richardliaw richardliaw approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@ericl @AmplabJenkins @aldanor @robertnishihara @pcmoritz @richardliaw