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] Docs do-over (new API stack): Add new AlgorithmConfig rst page and redo package_ref page for algo configs. #49464

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

[RLlib; docs] Docs do-over (new API stack): Add new AlgorithmConfig rst page and redo package_ref page for algo configs. #49464

wants to merge 9 commits into from

Conversation

sven1977
Copy link
Contributor

@sven1977 sven1977 commented Dec 27, 2024 •
edited
Loading

Docs do-over (new API stack):

  • Add new AlgorithmConfig rst page.
  • Redo existing package_ref page for algo configs.
  • Change AlgorithmConfig.is_multi_agent from method to property (to unify class' behavior).

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 sven1977 added rllib RLlib related issues rllib-algorithms An RLlib algorithm/Trainer is not learning. 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 Dec 27, 2024
@sven1977
wip
f53d8d9
@sven1977
wip
2707cc6
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into docs…
9c5ea8d 
…_redo_key_concepts

# Conflicts:
#	doc/source/rllib/rllib-rlmodule.rst
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
rllib RLlib related issues rllib-algorithms An RLlib algorithm/Trainer is not learning. 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
Projects
None yet
Milestone
No milestone
Development

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