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.

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

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

Merged

Conversation

sven1977
Copy link
Contributor

@sven1977 sven1977 commented Dec 27, 2024

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
…_redo_key_concepts

# Conflicts:
#	doc/source/rllib/rllib-rlmodule.rst
Signed-off-by: sven1977 <svenmika1977@gmail.com>
Signed-off-by: sven1977 <svenmika1977@gmail.com>
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977 sven1977 enabled auto-merge (squash) December 31, 2024 12:45
@github-actions github-actions bot added the go add ONLY when ready to merge, run all tests label Dec 31, 2024
@sven1977 sven1977 disabled auto-merge December 31, 2024 12:45
Copy link
Collaborator

@simonsays1980 simonsays1980 left a comment

Choose a reason for hiding this comment

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

LGTM. A small nit.

config.env = "CartPole-v1" # <- don't set attributes directly

# CORRECT!
config.environment(env="CartPole-v1") # call the proper method
Copy link
Collaborator

Choose a reason for hiding this comment

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

Great example!

Rollout length
~~~~~~~~~~~~~~

Set the number of timesteps each :py:class:`~ray.rllib.env.env_runner.EnvRunner` steps through each of its env copies
Copy link
Collaborator

Choose a reason for hiding this comment

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

We should mention here that the rollout length has a relation to the train batch size b/c this can raise errors.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

Signed-off-by: sven1977 <svenmika1977@gmail.com>
Signed-off-by: sven1977 <svenmika1977@gmail.com>
Signed-off-by: sven1977 <svenmika1977@gmail.com>
k
Signed-off-by: sven1977 <svenmika1977@gmail.com>
k
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977 sven1977 enabled auto-merge (squash) January 1, 2025 17:50
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@github-actions github-actions bot disabled auto-merge January 1, 2025 17:51
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977 sven1977 merged commit 5a96473 into ray-project:master Jan 3, 2025
5 checks passed
@sven1977 sven1977 deleted the docs_redo_algorithm_configurations branch January 3, 2025 14:25
roshankathawate pushed a commit to roshankathawate/ray that referenced this pull request Jan 7, 2025
… rst page and redo `package_ref` page for algo configs. (ray-project#49464)
roshankathawate pushed a commit to roshankathawate/ray that referenced this pull request Jan 9, 2025
… rst page and redo `package_ref` page for algo configs. (ray-project#49464)

Signed-off-by: Roshan Kathawate <roshankathawate@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
go add ONLY when ready to merge, run all tests 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
Development

Successfully merging this pull request may close these issues.

3 participants