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): Remove special "new API stack" page (move some of its content to migration guide). #49713

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

Conversation

sven1977
Copy link
Contributor

@sven1977 sven1977 commented Jan 8, 2025

Docs do-over (new API stack):

  • Remove special "new API stack" page (move some of its content to migration guide).
  • Smaller cleanups, vale-related and others.

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 :(

Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977 sven1977 requested review from maxpumperla, simonsays1980 and a team as code owners January 8, 2025 10:17
@sven1977 sven1977 added rllib RLlib related issues rllib-docs-or-examples Issues related to RLlib documentation or rllib/examples rllib-newstack labels Jan 8, 2025
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. Small add.

If you set this to 0, your LearnerGroup only contains a **local** Learner that runs on the main
process (and shares the compute resources with that process, usually 1 CPU).
If you set this to ``0``, your LearnerGroup only contains a **local** Learner that runs on the main
process and shares its compute resources, typically 1 CPU.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Could we add here that for Offline RL this setting should be never 1?

Copy link
Contributor

@angelinalg angelinalg left a comment

Choose a reason for hiding this comment

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

Just some style nits. Sorry you had to correct all the single quotes to double quotes for the code font. I think I did those.

@@ -38,7 +38,7 @@ AlgorithmConfig and Algorithm
.. tip::
The following is a quick overview of **RLlib AlgorithmConfigs and Algorithms**.
See :ref:`here for a detailed description of the Algorithm class <rllib-algorithms-doc>`.
See here for a :ref:`detailed description of the Algorithm class <rllib-algorithms-doc>`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
See here for a :ref:`detailed description of the Algorithm class <rllib-algorithms-doc>`.
See :ref:`<rllib-algorithms-doc>` for a detailed description of the Algorithm class.

doc/source/rllib/new-api-stack-migration-guide.rst Outdated Show resolved Hide resolved
doc/source/rllib/new-api-stack-migration-guide.rst Outdated Show resolved Hide resolved
doc/source/rllib/new-api-stack-migration-guide.rst Outdated Show resolved Hide resolved
doc/source/rllib/new-api-stack-migration-guide.rst Outdated Show resolved Hide resolved
doc/source/rllib/rllib-rlmodule.rst Outdated Show resolved Hide resolved
doc/source/rllib/rllib-rlmodule.rst Outdated Show resolved Hide resolved
doc/source/rllib/rllib-rlmodule.rst Outdated Show resolved Hide resolved
doc/source/rllib/rllib-rlmodule.rst Outdated Show resolved Hide resolved
doc/source/rllib/rllib-rlmodule.rst Outdated Show resolved Hide resolved
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Sven Mika <sven@anyscale.io>
@sven1977 sven1977 enabled auto-merge (squash) January 8, 2025 20:38
@github-actions github-actions bot added the go add ONLY when ready to merge, run all tests label Jan 8, 2025
@github-actions github-actions bot disabled auto-merge January 8, 2025 20:39
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-docs-or-examples Issues related to RLlib documentation or rllib/examples rllib-newstack
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants