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

[RLlib; docs] Adjust the documentation of the default API stack and replace 'rollouts' with 'env_runners'. #49304

Merged
merged 1 commit into from
Dec 18, 2024
Merged

[RLlib; docs] Adjust the documentation of the default API stack and replace 'rollouts' with 'env_runners'. #49304

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions doc/source/rllib/new-api-stack-migration-guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ RLlib classes and code to RLlib's new API stack.
Change your AlgorithmConfig
---------------------------

RLlib turns off the new API stack by default for all RLlib algorithms. To activate it, use the `api_stack()` method
RLlib turns on the new API stack by default for all RLlib algorithms. To deactivate it, use the `api_stack()` method
Copy link
Contributor

Choose a reason for hiding this comment

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

Great catch!

in your `AlgorithmConfig` object like so:

.. testcode::
Expand All @@ -34,14 +34,14 @@ in your `AlgorithmConfig` object like so:

config = (
PPOConfig()
# Switch both the new API stack flags to True (both False by default).
# This action enables the use of
# Switch both the new API stack flags to False (both True by default).
# This action disables the use of
# a) RLModule (replaces ModelV2) and Learner (replaces Policy).
# b) the correct EnvRunner, which replaces RolloutWorker, and
# ConnectorV2 pipelines, which replaces the old stack Connectors.
.api_stack(
enable_rl_module_and_learner=True,
enable_env_runner_and_connector_v2=True,
enable_rl_module_and_learner=False,
enable_env_runner_and_connector_v2=False,
)
)

Expand Down
2 changes: 1 addition & 1 deletion doc/source/rllib/rllib-training.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ Specifying Framework Options
Specifying Rollout Workers
~~~~~~~~~~~~~~~~~~~~~~~~~~

.. automethod:: ray.rllib.algorithms.algorithm_config.AlgorithmConfig.rollouts
.. automethod:: ray.rllib.algorithms.algorithm_config.AlgorithmConfig.env_runners
:noindex:


Expand Down
Loading