Conversation
|
@richardliaw do you know how to access readthedocs.org log files? Specifically the one mentioned here: it seems like the build can't find rllib (at least that's my guess). In commit sys.path.insert(0, os.path.abspath("../../python/"))this should take care of having access to all Ray libs, but doesn't. The problem is, I can't reproduce this issue locally. Starting from a fresh venv, everything is fine for me. |
|
One issue I foresee is that when building the doc in readthedocs, their server doesn't have enough resource to let us execute end to end. |
|
@simon-mo I've made notebook execution configurable. By default, readthedocs will not have to run them, but we can force that behaviour on CI like this: Not necessary right now, can be added later. |
|
@maxpumperla this is great! I think this will definitely work in readthedocs environment now. However, how can we execute as a test case in CI now we don't have the python script anymore? It would be great if we can change the bazel rule in python/ray/serve/BUILD's |
Continuing docs overhaul, tune now has: - [x] better landing page - [x] a getting started guide - [x] user guide was cut down, partially merged with FAQ, and partially integrated with tutorials - [x] the new user guide contains guides to tune features and practical integrations - [x] we rewrote some of the feature guides for clarity - [x] we got rid of sphinx-gallery for this sub-project (only data and core left), as it looks bad and is unnecessarily complicated anyway (plus, makes the build slower) - [x] sphinx-gallery examples are now moved to markdown notebook, as started in #22030. - [x] Examples are tested in the new framework, of course. There's still a lot one can do, but this is already getting too large. Will follow up with more fine-tuning next week. Co-authored-by: Antoni Baum <antoni.baum@protonmail.com> Co-authored-by: Kai Fricke <krfricke@users.noreply.github.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>
* merge Signed-off-by: Max Pumperla <max.pumperla@googlemail.com> * [Docs] Executable notebook tutorial (#22030) 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> * lint Signed-off-by: Max Pumperla <max.pumperla@googlemail.com> Co-authored-by: simon-mo <simon.mo@hey.com>
Continuing docs overhaul, tune now has: - [x] better landing page - [x] a getting started guide - [x] user guide was cut down, partially merged with FAQ, and partially integrated with tutorials - [x] the new user guide contains guides to tune features and practical integrations - [x] we rewrote some of the feature guides for clarity - [x] we got rid of sphinx-gallery for this sub-project (only data and core left), as it looks bad and is unnecessarily complicated anyway (plus, makes the build slower) - [x] sphinx-gallery examples are now moved to markdown notebook, as started in ray-project#22030. - [x] Examples are tested in the new framework, of course. There's still a lot one can do, but this is already getting too large. Will follow up with more fine-tuning next week. Co-authored-by: Antoni Baum <antoni.baum@protonmail.com> Co-authored-by: Kai Fricke <krfricke@users.noreply.github.com>
We're introducing the usage of MyST Notebooks here and demonstrate how it works by rewriting (and extending) the RLLib Serve tutorial. Benefits:
jupytextWe're also clarifying #22022.
@simon-mo let me know what you think about this. A "drawback" of this approach is that we're not using
literalincludeanymore. The jupyter philosophy is to keep text and code in a common source. But then again, I'm not sure these snippets here are actually tested anyway.Old tutorial: here
New tutorial (preview): here