-
Notifications
You must be signed in to change notification settings - Fork 5.8k
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][Docs] Added RLModule user-guide to the docs #33909
[RLlib][Docs] Added RLModule user-guide to the docs #33909
Conversation
Signed-off-by: Kourosh Hakhamaneshi <[email protected]>
@avnishn In the beginning of the doc I allude to your migration guide. So that need to get merged in for this make sense. Your doc will be cross linked to this one. |
@ArturNiederfahrenhorst In the end of this doc I allude to the catalog user-guide (in the extension of existing RLModules section). You need to write your use-guide and then we will link it here. |
/ray/doc/source/rllib/rllib-rlmodule.rst:403: WARNING: Inline interpreted text or phrase reference start-string without end-string. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
publishing for now
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
leaving additional comments from offline convor
Co-authored-by: angelinalg <[email protected]> Signed-off-by: kourosh hakhamaneshi <[email protected]>
Co-authored-by: angelinalg <[email protected]> Signed-off-by: kourosh hakhamaneshi <[email protected]>
Co-authored-by: angelinalg <[email protected]> Signed-off-by: kourosh hakhamaneshi <[email protected]>
Signed-off-by: Kourosh Hakhamaneshi <[email protected]>
…nto doc-24-rlmodule-guide
Signed-off-by: Kourosh Hakhamaneshi <[email protected]>
Co-authored-by: angelinalg <[email protected]> Signed-off-by: kourosh hakhamaneshi <[email protected]>
Co-authored-by: angelinalg <[email protected]> Signed-off-by: kourosh hakhamaneshi <[email protected]>
Co-authored-by: angelinalg <[email protected]> Signed-off-by: kourosh hakhamaneshi <[email protected]>
Co-authored-by: angelinalg <[email protected]> Signed-off-by: kourosh hakhamaneshi <[email protected]>
Co-authored-by: angelinalg <[email protected]> Signed-off-by: kourosh hakhamaneshi <[email protected]>
Co-authored-by: angelinalg <[email protected]> Signed-off-by: kourosh hakhamaneshi <[email protected]>
Co-authored-by: angelinalg <[email protected]> Signed-off-by: kourosh hakhamaneshi <[email protected]>
Co-authored-by: angelinalg <[email protected]> Signed-off-by: kourosh hakhamaneshi <[email protected]>
Co-authored-by: angelinalg <[email protected]> Signed-off-by: kourosh hakhamaneshi <[email protected]>
Co-authored-by: angelinalg <[email protected]> Signed-off-by: kourosh hakhamaneshi <[email protected]>
Signed-off-by: Kourosh Hakhamaneshi <[email protected]>
…nto doc-24-rlmodule-guide
Hey, we should be testing codeblocks in CI and not using code-blocks. Can you fix? You can take a look at Tune for an example of what to do. |
doc/source/rllib/rllib-rlmodule.rst
Outdated
|
||
Enable RLModules by setting the ``_enable_rl_module_api`` flag to ``True`` in the configuration object. | ||
|
||
.. code-block:: python |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
like Richard mentioned, let's make all these literalinclude
statements. Otherwise these code blocks risk being outdated quickly. RLlib already has a doc_code
folder for that purpose. Alternatively, use an example or test folder in rllib
, but make sure it's all tested. Thanks!
Signed-off-by: Kourosh Hakhamaneshi <[email protected]>
Signed-off-by: Kourosh Hakhamaneshi <[email protected]>
Signed-off-by: Kourosh Hakhamaneshi <[email protected]>
Signed-off-by: Kourosh Hakhamaneshi <[email protected]>
Signed-off-by: Kourosh Hakhamaneshi <[email protected]> Signed-off-by: elliottower <[email protected]>
Signed-off-by: Kourosh Hakhamaneshi <[email protected]> Signed-off-by: Jack He <[email protected]>
Why are these changes needed?
Related issue number
Checks
git commit -s
) in this PR.scripts/format.sh
to lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/
under thecorresponding
.rst
file.