Skip to content
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] Docs do-over (new API stack): Remove rllib-models.rst. #49966

Open
wants to merge 17 commits into
base: master
Choose a base branch
from
Open

[RLlib] Docs do-over (new API stack): Remove rllib-models.rst. #49966

wants to merge 17 commits into from

Conversation

sven1977
Copy link
Contributor

@sven1977 sven1977 commented Jan 20, 2025 •
edited
Loading

Docs do-over (new API stack):

  • Remove rllib-models.rst (forward to rl-modules.rst).
  • Rename rllib-rlmodule.rst to rl-modules.rst (forward).
  • Enhance RLModule docs (moved some of the old API stack snippets, e.g. the paragraph on autoregressive actions, into the RLModules page).

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
58f8097 
Signed-off-by: sven1977 <[email protected]>
@sven1977
wip
2e7c54b 
Signed-off-by: sven1977 <[email protected]>
@sven1977
wip
23cbd84 
Signed-off-by: sven1977 <[email protected]>
@sven1977
wip
7c114a0 
Signed-off-by: sven1977 <[email protected]>
@sven1977
wip
b5e7b50 
Signed-off-by: sven1977 <[email protected]>
@sven1977
wip
b0fac09 
Signed-off-by: sven1977 <[email protected]>
@sven1977
wip
60736b9 
Signed-off-by: sven1977 <[email protected]>
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into docs…
75b4137 
…_redo_remove_rllib_models_rst

Signed-off-by: sven1977 <[email protected]>

# Conflicts:
#	doc/source/rllib/rllib-rlmodule.rst
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into docs…
2337de6 
…_redo_remove_rllib_models_rst

Signed-off-by: sven1977 <[email protected]>

# Conflicts:
#	doc/source/rllib/rllib-rlmodule.rst
@sven1977
Merge branch 'cleanup_examples_folder_45_autoregressive_actions' into…
b18b285 
… docs_redo_remove_rllib_models_rst
@sven1977
wip
b63e342 
Signed-off-by: sven1977 <[email protected]>
@sven1977 sven1977 changed the title [WIP; RLlib] Docs do-over (new API stack): Remove rllib-models.rst. [RLlib] Docs do-over (new API stack): Remove rllib-models.rst. Jan 20, 2025
@sven1977 sven1977 added do-not-merge Do not merge this PR! rllib RLlib related issues rllib-models An issue related to RLlib (default or custom) Models. rllib-docs-or-examples Issues related to RLlib documentation or rllib/examples rllib-newstack rllib-oldstack-cleanup Issues related to cleaning up classes, utilities on the old API stack labels Jan 20, 2025
@sven1977
wip
3436ad9 
Signed-off-by: sven1977 <[email protected]>
@sven1977
wip
f0fe383 
Signed-off-by: sven1977 <[email protected]>
@sven1977
wip
eb6900c 
Signed-off-by: sven1977 <[email protected]>
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into docs…
b4f11fd 
…_redo_remove_rllib_models_rst

Signed-off-by: sven1977 <[email protected]>

# Conflicts:
#	rllib/BUILD
#	rllib/examples/envs/classes/correlated_actions_env.py
#	rllib/examples/rl_modules/classes/autoregressive_actions_rlm.py
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into docs…
7390829 
…_redo_remove_rllib_models_rst
@sven1977
wip
be0f6ee 
Signed-off-by: sven1977 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@maxpumperla maxpumperla Awaiting requested review from maxpumperla maxpumperla is a code owner

@simonsays1980 simonsays1980 Awaiting requested review from simonsays1980 simonsays1980 is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

@simonsays1980 simonsays1980

@angelinalg angelinalg

Labels
do-not-merge Do not merge this PR! rllib RLlib related issues rllib-docs-or-examples Issues related to RLlib documentation or rllib/examples rllib-models An issue related to RLlib (default or custom) Models. rllib-newstack rllib-oldstack-cleanup Issues related to cleaning up classes, utilities on the old API stack
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@sven1977 @simonsays1980 @angelinalg