[RLlib; documentation] "RLlib in 60sec" overhaul. #20215
Merged
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
…_rllib_in_60sec_overhaul
6 tasks
…_rllib_in_60sec_overhaul
sven1977
commented
Nov 10, 2021
| @@ -318,8 +318,9 @@ Papers | |||
| :maxdepth: -1 | |||
| :caption: Ray RLlib | |||
|
|
|||
| rllib.rst | |||
| rllib/index.rst | |||
There was a problem hiding this comment.
Will start moving all rllib docs files into the rllib sub-folder to the rst's will no longer be in the top-leve directory. Analogous to how tune docs do this.
sven1977
commented
Nov 10, 2021
| @@ -0,0 +1,195 @@ | |||
| .. admonition:: We're hiring! | |||
There was a problem hiding this comment.
This is the new RLlib main index page.
sven1977
commented
Nov 10, 2021
| @@ -40,6 +40,10 @@ | |||
| # starting letter of the test name (e.g. "examples_A", or "tests_dir_F") for | |||
| # split-up purposes in buildkite. | |||
|
|
|||
| # Note: There is a special directory in examples: "documentation" which contains | |||
There was a problem hiding this comment.
Start CI-testing any code snippet in the RLlib documentation.
| @@ -749,8 +749,9 @@ def env_creator_from_classpath(env_context): | |||
| # Evaluation setup. | |||
| self.evaluation_workers = None | |||
| self.evaluation_metrics = {} | |||
| # Do automatic evaluation from time to time. | |||
| if self.config.get("evaluation_interval"): | |||
| # User would like to setup a separate evaluation worker set. | |||
There was a problem hiding this comment.
Small change in the code to make the new example (RLlib in 60s) work with fewer config-overrides.
| @@ -0,0 +1,43 @@ | |||
| # __rllib-in-60s-begin__ | |||
There was a problem hiding this comment.
Script linked to from the documentation (new "RLlib in 60s" page)
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.
"RLlib in 60sec" overhaul.
doc/source/rllib-index.rstpage (moved todoc/source/rllib/index.rst)TODO: In a follow up PR, we'll add sigils to the "Feature Overview" section, such that each feature of RLlib (e.g. multi-agent) has its own sigil. These will then also be usable in the examples scripts- and other sections of the new documentation.
Why are these changes needed?
Related issue number
Checks
scripts/format.shto lint the changes in this PR.