-
Notifications
You must be signed in to change notification settings - Fork 6k
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] Docs do-over (new API stack): Add new AlgorithmConfig
rst page and redo package_ref
page for algo configs.
#49464
[RLlib; docs] Docs do-over (new API stack): Add new AlgorithmConfig
rst page and redo package_ref
page for algo configs.
#49464
Conversation
…_redo_algorithm_configurations
…_redo_key_concepts # Conflicts: # doc/source/rllib/rllib-rlmodule.rst
…_redo_algorithm_configurations
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. A small nit.
config.env = "CartPole-v1" # <- don't set attributes directly | ||
|
||
# CORRECT! | ||
config.environment(env="CartPole-v1") # call the proper 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.
Great example!
Rollout length | ||
~~~~~~~~~~~~~~ | ||
|
||
Set the number of timesteps each :py:class:`~ray.rllib.env.env_runner.EnvRunner` steps through each of its env copies |
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.
We should mention here that the rollout length has a relation to the train batch size b/c this can raise errors.
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.
done
… rst page and redo `package_ref` page for algo configs. (ray-project#49464)
… rst page and redo `package_ref` page for algo configs. (ray-project#49464) Signed-off-by: Roshan Kathawate <roshankathawate@gmail.com>
Docs do-over (new API stack):
AlgorithmConfig
rst page.package_ref
page for algo configs.AlgorithmConfig.is_multi_agent
from method to property (to unify class' behavior).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.