[RLlib; docs] Adjust the documentation of the default API stack and replace 'rollouts' with 'env_runners'. #49304
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…llouts' with 'env_runners' in 'Getting Started'. Signed-off-by: simonsays1980 <simon.zehnder@gmail.com>
simonsays1980
added
rllib
simonsays1980
requested review from
sven1977,
maxpumperla and
a team
as code owners
sven1977
changed the title
sven1977
reviewed
Dec 18, 2024
| @@ -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 | |||
sven1977
approved these changes
Dec 18, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
…llouts' with 'env_runners' in 'Getting Started'.
Why are these changes needed?
RLlib's default API stack is now the new API stack, however, the documentation still tells the other way around. This PR makes some primer adjustments. For the long run we need to rewrite the pages fully and replace references therein.
Related issue number
Closes #49076 #49073
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/under thecorresponding
.rstfile.