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

[RLlib] AlgorithmConfig docs #29796

Merged

richardliaw merged 34 commits into master from mp_algo_config_docs

Nov 10, 2022

Contributor

maxpumperla commented Oct 28, 2022 •

edited

Loading

We finally got around to documenting AlgoConfigs. We did so by splitting up the previously massive "Training API" doc and gave it a bit more direction. Quick breakdown:

AlgoConfigs now replace the "common config" section in a more structured fashion.
We also revised the API reference section and added resp. paragraphs there.
The code in the touched documents is now tested (was in parts quite outdated)
We moved some of the advanced material into special user guides to make things a bit less intimidating.

Not perfect yet, but a big step forward. we can iterate on this.

Please review starting in the docs build here

maxpumperla added 2 commits

October 28, 2022 10:33


          improvements to index

b906169

Signed-off-by: Max Pumperla <[email protected]>


          factor out adv. material and apis

a974288

Signed-off-by: Max Pumperla <[email protected]>

maxpumperla requested review from sven1977, gjoliver, avnishn, ArturNiederfahrenhorst, smorad, kouroshHakha, krfricke and a team as code owners

October 28, 2022 09:36

maxpumperla added 10 commits

October 28, 2022 11:49


          Merge branch 'master' into mp_algo_config_docs

a454534

Signed-off-by: Max Pumperla <[email protected]>


          fix toc, refs

1dd1bd7

Signed-off-by: Max Pumperla <[email protected]>


          fix ref

6d1f2a7

Signed-off-by: Max Pumperla <[email protected]>


          move getting started guide to top

13089a0

Signed-off-by: Max Pumperla <[email protected]>


          Merge remote-tracking branch 'upstream/master' into mp_algo_config_docs

22a8cad


          rm old test

a84cb02

Signed-off-by: Max Pumperla <[email protected]>


          finish new main guide

03477d1

Signed-off-by: Max Pumperla <[email protected]>


          wrap algo docs

c90d548

Signed-off-by: Max Pumperla <[email protected]>


          wrap algo docs

ed19836

Signed-off-by: Max Pumperla <[email protected]>


          api ref update

77dd553

Signed-off-by: Max Pumperla <[email protected]>

maxpumperla changed the title ~~[RLlib] [WIP] AlgorithmConfig docs~~ [RLlib] AlgorithmConfig docs


          math fixes and lint

828e0a0

Signed-off-by: Max Pumperla <[email protected]>

sven1977 reviewed

View reviewed changes

doc/source/rllib/core-concepts.rst Outdated Show resolved Hide resolved

sven1977 reviewed

View reviewed changes

doc/source/rllib/doc_code/getting_started.py Outdated Show resolved Hide resolved

sven1977 reviewed

View reviewed changes

doc/source/rllib/doc_code/rllib_in_60s.py Show resolved Hide resolved

sven1977 reviewed

View reviewed changes

rllib/algorithms/crr/crr.py Show resolved Hide resolved

sven1977 reviewed

View reviewed changes

doc/source/rllib/index.rst Outdated Show resolved Hide resolved

sven1977 reviewed

View reviewed changes

doc/source/rllib/package_ref/algorithm.rst Outdated Show resolved Hide resolved

sven1977 reviewed

View reviewed changes

doc/source/rllib/package_ref/external-app.rst Show resolved Hide resolved

sven1977 reviewed

View reviewed changes

doc/source/rllib/package_ref/external-app.rst Show resolved Hide resolved

sven1977 approved these changes

View reviewed changes

Contributor

sven1977 left a comment

Sounds great! Again, thanks for the PR @maxpumperla !

LGTM now.

maxpumperla added 7 commits

November 4, 2022 16:22


          noqa

aced242

Signed-off-by: Max Pumperla <[email protected]>


          bc doctests

cdeb88b

Signed-off-by: Max Pumperla <[email protected]>


          fix doctests

5c9befd

Signed-off-by: Max Pumperla <[email protected]>


          skip doctests

dd8c408

Signed-off-by: Max Pumperla <[email protected]>


          speed up getting started test

542ddfc

Signed-off-by: Max Pumperla <[email protected]>


          fix doctests

d806f87

Signed-off-by: Max Pumperla <[email protected]>


          lint

b27296e

Signed-off-by: Max Pumperla <[email protected]>

maxpumperla requested review from ericl, scv119, clarkzinzow, jjyao, jianoaix and c21 as code owners

November 8, 2022 12:34

maxpumperla added 2 commits

November 8, 2022 13:35


          Merge branch 'master' into mp_algo_config_docs

4b7fe55

Signed-off-by: Max Pumperla <[email protected]>


          lint

08d8b28

Signed-off-by: Max Pumperla <[email protected]>

maxpumperla mentioned this pull request

[RLlib] AlgorithmConfig: Replace more occurrences of old config dicts; Make all Algorithms use the non-dict lookup for config properties. #30096

Merged

7 tasks

maxpumperla added 8 commits

November 8, 2022 17:13


          skip more tests

d3c499e

Signed-off-by: Max Pumperla <[email protected]>


          skip tests

7dade18

Signed-off-by: Max Pumperla <[email protected]>


          format

ad51ac0

Signed-off-by: Max Pumperla <[email protected]>


          skip tests

72493a2

Signed-off-by: Max Pumperla <[email protected]>


          undo unrelated doctest changes

7b56d52

Signed-off-by: Max Pumperla <[email protected]>


          skip even more tests, fix docstring rendering

655e975

Signed-off-by: Max Pumperla <[email protected]>


          fix tests

7fcdd95

Signed-off-by: Max Pumperla <[email protected]>


          lint and last test

c9f2d9e

Signed-off-by: Max Pumperla <[email protected]>

ericl approved these changes

View reviewed changes

richardliaw merged commit 23f460b into master

richardliaw deleted the mp_algo_config_docs branch

November 10, 2022 07:56

WeichenXu123 pushed a commit to WeichenXu123/ray that referenced this pull request


          [RLlib] AlgorithmConfig docs (ray-project#29796)

d92351a

Signed-off-by: Weichen Xu <[email protected]>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

sven1977 sven1977 approved these changes

ericl ericl approved these changes

gjoliver Awaiting requested review from gjoliver

avnishn Awaiting requested review from avnishn

ArturNiederfahrenhorst Awaiting requested review from ArturNiederfahrenhorst

smorad Awaiting requested review from smorad

kouroshHakha Awaiting requested review from kouroshHakha

krfricke Awaiting requested review from krfricke

scv119 Awaiting requested review from scv119

clarkzinzow Awaiting requested review from clarkzinzow

jjyao Awaiting requested review from jjyao

jianoaix Awaiting requested review from jianoaix

c21 Awaiting requested review from c21

Labels

None yet