-
Notifications
You must be signed in to change notification settings - Fork 5.3k
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] Cleanup examples folder 13: Add READMEs to folder and all sub-folders. #45382
base: master
Are you sure you want to change the base?
[RLlib] Cleanup examples folder 13: Add READMEs to folder and all sub-folders. #45382
Conversation
…rithm_config_dissolve_resources_method
…nup_examples_folder_11_fractional_gpus
…p_examples_folder_11_fractional_gpus
…p_examples_folder_11_fractional_gpus # Conflicts: # rllib/utils/test_utils.py
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.
Just some style nits and a few typos.
|
||
num_gpus = 0 | ||
num_env_runners = 2 | ||
In curriculum learning, the environment can be set by the user to different difficulties |
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.
In curriculum learning, the environment can be set by the user to different difficulties | |
In curriculum learning, you can set the environment to different difficulties |
num_gpus = 0 | ||
num_env_runners = 2 | ||
In curriculum learning, the environment can be set by the user to different difficulties | ||
throughout the training process. This allows the algorithm to learn how to solve |
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.
throughout the training process. This allows the algorithm to learn how to solve | |
throughout the training process. This setting allows the algorithm to learn how to solve |
num_env_runners = 2 | ||
In curriculum learning, the environment can be set by the user to different difficulties | ||
throughout the training process. This allows the algorithm to learn how to solve | ||
the actual (final) problem incrementally, by interacting with and exploring in more and |
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.
the actual (final) problem incrementally, by interacting with and exploring in more and | |
the actual and final problem incrementally, by interacting with and exploring in more and |
throughout the training process. This allows the algorithm to learn how to solve | ||
the actual (final) problem incrementally, by interacting with and exploring in more and | ||
more difficult phases. | ||
Normally, such a curriculum starts with setting the environment to an easy difficulty and |
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.
Normally, such a curriculum starts with setting the environment to an easy difficulty and | |
Normally, such a curriculum starts with setting the environment to an easy level and |
the actual (final) problem incrementally, by interacting with and exploring in more and | ||
more difficult phases. | ||
Normally, such a curriculum starts with setting the environment to an easy difficulty and | ||
then - as training progresses - transitions more and more toward a harder-to-solve difficulty. |
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.
then - as training progresses - transitions more and more toward a harder-to-solve difficulty. | |
then - as training progresses - transitions more toward a harder-to-solve difficulty. |
`num_gpus_per_worker` to 0 (they may be set to 1 by default for your | ||
particular RL algorithm).""" | ||
machine does not have any GPUs, you should set the config keys | ||
`num_gpus_per_learner` and `num_gpus_per_env_runner` to 0 (they may be set to |
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.
`num_gpus_per_learner` and `num_gpus_per_env_runner` to 0 (they may be set to | |
`num_gpus_per_learner` and `num_gpus_per_env_runner` to 0. They may be set to |
particular RL algorithm).""" | ||
machine does not have any GPUs, you should set the config keys | ||
`num_gpus_per_learner` and `num_gpus_per_env_runner` to 0 (they may be set to | ||
1 by default for your particular RL algorithm).""" |
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.
1 by default for your particular RL algorithm).""" | |
1 by default for your particular RL algorithm.""" |
particular RL algorithm).""" | ||
machine does not have any GPUs, you should set the config keys | ||
`num_gpus_per_learner` and `num_gpus_per_env_runner` to 0 (they may be set to | ||
1 by default for your particular RL algorithm).""" | ||
|
||
ERR_MSG_INVALID_ENV_DESCRIPTOR = """The env string you provided ('{}') is: | ||
a) Not a supported/installed environment. |
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.
a) Not a supported/installed environment. | |
a) Not a supported or installed environment. |
@@ -1346,6 +1347,11 @@ def run_rllib_example_script_experiment( | |||
tune_callbacks: A list of Tune callbacks to configure with the tune.Tuner. | |||
In case `args.wandb_key` is provided, will append a WandB logger to this |
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.
In case `args.wandb_key` is provided, will append a WandB logger to this | |
In case `args.wandb_key` is provided, appends a WandB logger to this |
keep_config: Set this to True, if you don't want this utility to change the | ||
given `base_config` in any way and leave it as-is. This is helpful | ||
for example script that want to demonstrate how to set those settings | ||
that are usually taken care of automatically in this function (e.g. |
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.
that are usually taken care of automatically in this function (e.g. | |
that are usually taken care of automatically in this function (e.g., |
Cleanup examples folder 13: Add READMEs to folder and all sub-folders.
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.