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] New API stack is enabled by default, but "New API stack migration guide" says the opposite #49076

Closed
ema-pe opened this issue Dec 4, 2024 · 1 comment · Fixed by #49304
Assignees
Labels
docs An issue or change related to documentation rllib RLlib related issues rllib-docs-or-examples Issues related to RLlib documentation or rllib/examples rllib-newstack

Comments

@ema-pe
Copy link

ema-pe commented Dec 4, 2024

Description

Hi, I'm using Ray RLlib 2.40.0 and the new API stack is enabled by default, but the documentation web page "New API stack migration guide" in the "Change your AlgorithmConfig" section says that "RLlib turns off the new API stack by default for all RLlib algorithms", see the attached screenshot and code:

# `self.api_stack()`
self.enable_rl_module_and_learner = True
self.enable_env_runner_and_connector_v2 = True
self.api_stack(
enable_rl_module_and_learner=True,
enable_env_runner_and_connector_v2=True,
)

1

I think the documentation is wrong and out of date.

Link

https://docs.ray.io/en/releases-2.40.0/rllib/new-api-stack-migration-guide.html#change-your-algorithmconfig

@ema-pe ema-pe added docs An issue or change related to documentation triage Needs triage (eg: priority, bug/not-bug, and owning component) labels Dec 4, 2024
@jcotant1 jcotant1 added the rllib RLlib related issues label Dec 9, 2024
@simonsays1980
Copy link
Collaborator

@ema-pe thanks for raising this issue. You are right. We changed lately the default to the new API stack and forgot to change the docs accordingly. Great catch!

@simonsays1980 simonsays1980 added rllib-docs-or-examples Issues related to RLlib documentation or rllib/examples rllib-newstack and removed triage Needs triage (eg: priority, bug/not-bug, and owning component) labels Dec 17, 2024
@simonsays1980 simonsays1980 self-assigned this Dec 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs An issue or change related to documentation rllib RLlib related issues rllib-docs-or-examples Issues related to RLlib documentation or rllib/examples rllib-newstack
Projects
None yet
3 participants