-
Notifications
You must be signed in to change notification settings - Fork 6.1k
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
[Doc] Clean up remaining RLlib broken links #46102
[Doc] Clean up remaining RLlib broken links #46102
Conversation
Signed-off-by: pdmurray <peynmurray@gmail.com>
@@ -42,7 +42,7 @@ are represented by slightly different maps that the agent has to navigate. | |||
:end-before: __END_curriculum_learning_example_env_options__ | |||
|
|||
Then, define the central piece controlling the curriculum, which is a custom callbacks class | |||
overriding the :py:meth:`~ray.rllib.algorithms.callbacks.Callbacks.on_train_result`. | |||
overriding the :py:meth:`~ray.rllib.algorithms.callbacks.DefaultCallbacks.on_train_result`. |
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.
Oh wow, thanks for catching this! This wrong link must have been in there forever.
Example of how to override the :py:meth:`~ray.rllib.algorithms.algorithm.training_step` method of the | ||
:py:class:`~ray.rllib.algorithms.algorithm.Algorithm` class to train two different policies in parallel | ||
(also using multi-agent API). | ||
Example of how to override the :py:meth:`~ray.rllib.algorithms.algorithm.Algorithm.training_step` method |
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.
nice!
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.
LGTM! Thanks for these important fixes @peytondmurray ! :)
Why are these changes needed?
This PR cleans up the last remaining broken links in the RLlib documentation.
Related issue number
Partially completes #39658.
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.