Skip to content

[docs] rllib conference material#22503

Merged
mwtian merged 3 commits intoreleases/1.11.0from
mp_rllib_conf_cp
Feb 19, 2022
Merged

[docs] rllib conference material#22503
mwtian merged 3 commits intoreleases/1.11.0from
mp_rllib_conf_cp

Conversation

@maxpumperla
Copy link
Copy Markdown
Contributor

Signed-off-by: Max Pumperla max.pumperla@googlemail.com

Why are these changes needed?

Related issue number

Checks

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

maxpumperla and others added 2 commits February 18, 2022 19:03
Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>
We're introducing the usage of [MyST Notebooks](https://myst-nb.readthedocs.io/en/latest/index.html) here and demonstrate how it works by rewriting (and extending) the RLLib Serve tutorial. Benefits:

- [x] Write notebooks in markdown. Can be converted into other formats e.g. with `jupytext`
- [x] Tutorials like this have a binderhub link added to the top nav (launch button).
- [x] Notebooks get executed when docs are built, so it's impossible to have stale docs.
- [x] But locally those builds are cached so that you don't have to wait too long.
- [x] The notebook cell outputs can be shown, hidden or removed.  In particular, we can now avoid adding expected code output as comments in our scripts (which might get outdated).

We're also clarifying  #22022.

Old tutorial: [here](https://docs.ray.io/en/latest/serve/tutorials/rllib.html)
New tutorial (preview): [here](https://ray--22030.org.readthedocs.build/en/22030/serve/tutorials/rllib.html)

Co-authored-by: simon-mo <simon.mo@hey.com>
@gjoliver
Copy link
Copy Markdown
Member

the diff is pretty huge. is it intended that you want to include everything?
also there is a super minor lint error.

Signed-off-by: Max Pumperla <max.pumperla@googlemail.com>
@maxpumperla
Copy link
Copy Markdown
Contributor Author

@gjoliver fixed the linter. 600 loc, not small, yes. It's just doc changes though, to promote the RL conf.

Copy link
Copy Markdown
Member

@mwtian mwtian left a comment

Choose a reason for hiding this comment

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

Poster looks great!

@mwtian
Copy link
Copy Markdown
Member

mwtian commented Feb 18, 2022

If there is no objection to cherry picking, after lint passes I (or anyone) can merge the change.

@gjoliver
Copy link
Copy Markdown
Member

@gjoliver fixed the linter. 600 loc, not small, yes. It's just doc changes though, to promote the RL conf.

sure, you make the call 👌

@maxpumperla
Copy link
Copy Markdown
Contributor Author

let's wait for the full build and then decide. it's desirable, but we don't have to force it (should tests still fail).

@mwtian mwtian merged commit c0afd1c into releases/1.11.0 Feb 19, 2022
@mwtian mwtian deleted the mp_rllib_conf_cp branch February 19, 2022 02:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants