[RLlib] Cleanup examples folder 13: Add READMEs to folder and all sub-folders. #45382
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…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
sven1977
requested review from
avnishn,
ArturNiederfahrenhorst,
maxpumperla,
kouroshHakha,
simonsays1980 and
a team
as code owners
sven1977
added
rllib
angelinalg
approved these changes
May 20, 2024
|
|
||
| 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.
Suggested change
| 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.
Suggested change
| 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.
Suggested change
| 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.
Suggested change
| 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.
Suggested change
| 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.
Suggested change
| `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.
Suggested change
| 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.
Suggested change
| 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.
Suggested change
| 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.
Suggested change
| that are usually taken care of automatically in this function (e.g. | |
| that are usually taken care of automatically in this function (e.g., |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.shto lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/under thecorresponding
.rstfile.