Skip to content

[RLlib] Documentation do-over 01: Announce new API stack as alpha; add hints to all RLlib pages; describe how to use it in new page.#44090

Merged
sven1977 merged 17 commits intoray-project:masterfrom
sven1977:rllib_docs_do_over_001_announce_new_api_stack
Mar 20, 2024
Merged

[RLlib] Documentation do-over 01: Announce new API stack as alpha; add hints to all RLlib pages; describe how to use it in new page.#44090
sven1977 merged 17 commits intoray-project:masterfrom
sven1977:rllib_docs_do_over_001_announce_new_api_stack

Conversation

@sven1977
Copy link
Contributor

@sven1977 sven1977 commented Mar 18, 2024 •
edited
Loading

Documentation do-over 01:

  • Announce new API stack as alpha by adding Note:s on top of all RLlib pages
  • Add documentation on how to switch to the new stack (in a new page). The before-mentioned notes link to this new page. Furthermore, from this page, users can get to the already existing API documentation pages for the new API components, such as RLModule and Learner.

TODO (in follow up PRs):

  • Describe ConnectorV2 APIs.
  • Describe new Episode APIs.
  • Describe EnvRunner APIs.

Why are these changes needed?

Related issue number

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
    • I've added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

@sven1977
wip
c21eb3e 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
sven1977 added 5 commits March 18, 2024 18:32
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into rlli…
9a38ff5 
…b_docs_do_over_001_announce_new_api_stack
@sven1977
wip
63a0461 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into rlli…
d5bfee4 
…b_docs_do_over_001_announce_new_api_stack
@sven1977
wip
619f6ec 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
wip
84b2c2b 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977 sven1977 added the tests-ok The tagger certifies test failures are unrelated and assumes personal liability. label Mar 19, 2024
sven1977 added 4 commits March 19, 2024 11:24
@sven1977
wip
f0b5c9b 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
wip
4669105 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
wip
fa75913 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into rlli…
e874b6e 
…b_docs_do_over_001_announce_new_api_stack
zhe-thoughts
zhe-thoughts approved these changes Mar 19, 2024
View reviewed changes
Copy link
Contributor

@zhe-thoughts zhe-thoughts left a comment

Choose a reason for hiding this comment

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

This is a large PR, but docs only changes

@sven1977
wip
41656dc 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
angelinalg
angelinalg approved these changes Mar 19, 2024
View reviewed changes
@angelinalg
Copy link
Contributor

angelinalg commented Mar 19, 2024

Just had some nits

sven1977 and others added 6 commits March 20, 2024 10:10
@sven1977 @angelinalg
Update doc/source/_includes/rllib/new_api_stack.rst
23ba871 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Sven Mika <sven@anyscale.io>
@sven1977 @angelinalg
Update doc/source/_includes/rllib/new_api_stack.rst
c542e46 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Sven Mika <sven@anyscale.io>
@sven1977 @angelinalg
Update doc/source/_includes/rllib/new_api_stack.rst
a2e773a 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Sven Mika <sven@anyscale.io>
@sven1977 @angelinalg
Apply suggestions from code review
d9ceaea 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Sven Mika <sven@anyscale.io>
@sven1977
wip
fc52d1a 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into rlli…
846932c 
…b_docs_do_over_001_announce_new_api_stack
@sven1977 sven1977 merged commit fc630c9 into ray-project:master Mar 20, 2024
stephanie-wang pushed a commit to stephanie-wang/ray that referenced this pull request Mar 27, 2024
@sven1977 @stephanie-wang
[RLlib] Documentation do-over 01: Announce new API stack as alpha; ad…
391fd94 
…d hints to all RLlib pages; describe how to use it in new page. (ray-project#44090)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@zhe-thoughts zhe-thoughts zhe-thoughts approved these changes

@angelinalg angelinalg angelinalg approved these changes

@avnishn avnishn Awaiting requested review from avnishn

@ArturNiederfahrenhorst ArturNiederfahrenhorst Awaiting requested review from ArturNiederfahrenhorst

@maxpumperla maxpumperla Awaiting requested review from maxpumperla

@kouroshHakha kouroshHakha Awaiting requested review from kouroshHakha

@simonsays1980 simonsays1980 Awaiting requested review from simonsays1980

Assignees

@simonsays1980 simonsays1980

@angelinalg angelinalg

Labels

tests-ok The tagger certifies test failures are unrelated and assumes personal liability.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@sven1977 @angelinalg @zhe-thoughts @simonsays1980