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; documentation] "RLlib in 60sec" overhaul. #20215

Merged
merged 9 commits into from
Nov 10, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion .buildkite/pipeline.yml
Original file line number Diff line number Diff line change
Expand Up @@ -529,7 +529,7 @@
# "learning_tests|quick_train|examples|tests_dir".
- bazel test --config=ci $(./scripts/bazel_export_options)
--build_tests_only
--test_tag_filters=-learning_tests,-quick_train,-examples,-tests_dir,-trainers_dir,-flaky,-multi_gpu
--test_tag_filters=-learning_tests,-quick_train,-examples,-tests_dir,-trainers_dir,-documentation,-flaky,-multi_gpu
--test_env=RAY_USE_MULTIPROCESSING_CPU_COUNT=1
rllib/...

Expand Down Expand Up @@ -615,6 +615,17 @@
--test_tag_filters=tests_dir_R,-flaky,-multi_gpu --test_env=RAY_USE_MULTIPROCESSING_CPU_COUNT=1
rllib/...

- label: ":brain: RLlib: Documentation code/examples"
conditions: ["RAY_CI_RLLIB_DIRECTLY_AFFECTED"]
commands:
- cleanup() { if [ "${BUILDKITE_PULL_REQUEST}" = "false" ]; then ./ci/travis/upload_build_info.sh; fi }; trap cleanup EXIT
- RLLIB_TESTING=1 PYTHON=3.7 ./ci/travis/install-dependencies.sh
# Because Python version changed, we need to re-install Ray here
- rm -rf ./python/ray/thirdparty_files; rm -rf ./python/ray/pickle5_files; ./ci/travis/ci.sh build
- bazel test --config=ci $(./scripts/bazel_export_options) --build_tests_only
--test_tag_filters=documentation,-flaky --test_env=RAY_USE_MULTIPROCESSING_CPU_COUNT=1
rllib/...

- label: ":octopus: Tune tests and examples {1/2; no RLlib}"
conditions: ["RAY_CI_TUNE_AFFECTED"]
commands:
Expand Down
11 changes: 10 additions & 1 deletion doc/source/_static/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -79,4 +79,13 @@ dt:target, span.highlighted {
}
img.horizontal-scroll {
max-width: none;
}
}

.clear-both {
clear: both;
}

.buttons-float-left {
width: 150px;
float: left;
}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions doc/source/images/rllib/rllib-index-header.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions doc/source/images/rllib/rllib-stack.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -318,8 +318,9 @@ Papers
:maxdepth: -1
:caption: Ray RLlib

rllib.rst
rllib/index.rst
Copy link
Contributor Author

Choose a reason for hiding this comment

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

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.

Copy link
Contributor

Choose a reason for hiding this comment

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

good idea!

rllib-toc.rst
rllib/core-concepts.rst
rllib-training.rst
rllib-env.rst
rllib-models.rst
Expand Down
4 changes: 4 additions & 0 deletions doc/source/rllib-models.rst
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,8 @@ If you would like to provide your own model logic (instead of using RLlib's buil
can sub-class either ``TFModelV2`` (for TensorFlow) or ``TorchModelV2`` (for PyTorch) and then
register and specify your sub-class in the config as follows:

.. _tensorflow-models:

Custom TensorFlow Models
````````````````````````

Expand Down Expand Up @@ -240,6 +242,8 @@ More examples and explanations on how to implement custom Tuple/Dict processing
(also check out `this test case here <https://github.com/ray-project/ray/blob/master/rllib/tests/test_nested_observation_spaces.py>`__),
custom RNNs, custom model APIs (on top of default models) follow further below.

.. _torch-models:

Custom PyTorch Models
`````````````````````

Expand Down
2 changes: 2 additions & 0 deletions doc/source/rllib-training.rst
Original file line number Diff line number Diff line change
Expand Up @@ -608,6 +608,8 @@ Custom metrics can be accessed and visualized like any other training result:

.. image:: custom_metric.png

.. _exploration-api:

Customizing Exploration Behavior
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
Loading