Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[RLlib] Unify pattern of examples and learning tests. #45023

Merged
merged 36 commits into from
May 16, 2024
Merged

[RLlib] Unify pattern of examples and learning tests. #45023

merged 36 commits into from
May 16, 2024

Conversation

sven1977
Copy link
Contributor

@sven1977 sven1977 commented Apr 28, 2024 •
edited
Loading

Unify examples, tuned_examples (learning tests), and release tests into a common pattern of execution.

  • Config files should become python executable scripts.
  • All these scripts/config files should have a common command line arg schema, supporting common arguments such as --wandb-key, --num-env-runners, --num-gpus, --env, etc..
  • All these scripts/config should be runnable as tests, meaning they should all define a) one or more stopping criteria, and b) (optionsl) a passing criterium. If b) is not provided, RLlib will automatically try to find a good passing criterium in the stopping criterium (try eval/episode_reward_mean first, then try episode_reward_mean)
  • Cleanup all BUILD learning_tests and tag old API stack ones as such. Remove the "_envrunner" suffix from the new API stack tuned_examples, b/c new stack should become more and more the norm.
  • Move a single release test (pong_ppo) into this new format as well (for testing purposes).

Why are these changes needed?

Related issue number

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
    • I've added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

@sven1977
wip
06a1b93 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
wip
4d7e75e 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977 sven1977 marked this pull request as ready for review April 28, 2024 18:09
@sven1977
wip
6f23a60 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into unif…
02a07cc 
…y_pattern_of_examples_and_learning_tests
@sven1977
wip
2372430 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
wip
5a7e7b3 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into unif…
6a3a089 
…y_pattern_of_examples_and_learning_tests
@sven1977
wip
69339dd 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
fixes
58d3265 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977 sven1977 added rllib RLlib related issues rllib-newstack labels May 2, 2024
@sven1977
fixes
2fad65e 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into unif…
6a2d73d 
…y_pattern_of_examples_and_learning_tests
simonsays1980
simonsays1980 approved these changes May 3, 2024
View reviewed changes
Copy link
Collaborator

@simonsays1980 simonsays1980 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. The great thing about it is we can finally test all tuned examples without alw<s putting a tune.Tuner in :)

@sven1977
fixes
8416167 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into unif…
7303f14 
…y_pattern_of_examples_and_learning_tests
@sven1977
wip
e734f2f 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977 sven1977 requested a review from a team as a code owner May 3, 2024 13:29
aslonnie
aslonnie approved these changes May 3, 2024
View reviewed changes
Copy link
Collaborator

@aslonnie aslonnie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

approval for docs change.

simonsays1980
simonsays1980 approved these changes May 8, 2024
View reviewed changes
Copy link
Collaborator

@simonsays1980 simonsays1980 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

rllib/tuned_examples/ppo/multi_agent_pendulum_ppo.py Outdated
parser = add_rllib_example_script_args()
# Use `parser` to add your own custom command line options to this script
# and (if needed) use their values toset up `config` below.
args = parser.parse_args()

register_env("multi_agent_pendulum", lambda _: MultiAgentPendulum({"num_agents": 2}))
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sven1977 I think we must use here the "num_agents": args.num_agents?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into unif…
90f87bf 
…y_pattern_of_examples_and_learning_tests

Signed-off-by: sven1977 <svenmika1977@gmail.com>

# Conflicts:
#	rllib/BUILD
@sven1977
fixes
8df141e 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into unif…
86d5a5f 
…y_pattern_of_examples_and_learning_tests
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into unif…
37d26de 
…y_pattern_of_examples_and_learning_tests
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into unif…
51711d7 
…y_pattern_of_examples_and_learning_tests
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into unif…
b6bd054 
…y_pattern_of_examples_and_learning_tests
@sven1977
fixes
ffac4a1 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
fix
e8f8874 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into unif…
e3bb696 
…y_pattern_of_examples_and_learning_tests
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into unif…
1432493 
…y_pattern_of_examples_and_learning_tests

Signed-off-by: sven1977 <svenmika1977@gmail.com>

# Conflicts:
#	rllib/tuned_examples/dqn/cartpole_dqn.py
#	rllib/tuned_examples/ppo/cartpole-ppo-fake-gpus.yaml
#	rllib/tuned_examples/ppo/cartpole-ppo-grid-search-example.yaml
#	rllib/tuned_examples/ppo/cartpole-ppo-hyperband.yaml
#	rllib/tuned_examples/ppo/cartpole_ppo.py
#	rllib/tuned_examples/ppo/cartpole_truncated_ppo.py
#	rllib/tuned_examples/ppo/multi_agent_pendulum_ppo.py
#	rllib/tuned_examples/ppo/pendulum_ppo.py
#	rllib/tuned_examples/ppo/recomm-sys001-ppo.yaml
#	rllib/tuned_examples/sac/pendulum_sac.py
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into unif…
cd5fb61 
…y_pattern_of_examples_and_learning_tests
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into unif…
0241b6e 
…y_pattern_of_examples_and_learning_tests

Signed-off-by: sven1977 <svenmika1977@gmail.com>

# Conflicts:
#	rllib/tuned_examples/dqn/cartpole_dqn.py
#	rllib/tuned_examples/ppo/cartpole-ppo-fake-gpus.yaml
#	rllib/tuned_examples/ppo/cartpole-ppo-grid-search-example.yaml
#	rllib/tuned_examples/ppo/cartpole-ppo-hyperband.yaml
#	rllib/tuned_examples/ppo/cartpole_ppo.py
#	rllib/tuned_examples/ppo/cartpole_truncated_ppo.py
#	rllib/tuned_examples/ppo/multi_agent_pendulum_ppo.py
#	rllib/tuned_examples/ppo/pendulum_ppo.py
#	rllib/tuned_examples/ppo/recomm-sys001-ppo.yaml
#	rllib/tuned_examples/sac/pendulum_sac.py
@sven1977
wip
0c94ed4 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
wip
78d9c81 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
wip
6144115 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
wip
1cec156 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977 sven1977 enabled auto-merge (squash) May 16, 2024 02:29
@github-actions github-actions bot added the go add ONLY when ready to merge, run all tests label May 16, 2024
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into unif…
37ba669 
…y_pattern_of_examples_and_learning_tests
@sven1977
test buildkite no file size limit for error stack printouts
b2d4196 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@github-actions github-actions bot disabled auto-merge May 16, 2024 14:59
@sven1977
fixes
f610c90 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
Merge branch 'master' of https://github.com/ray-project/ray into unif…
a073cb9 
…y_pattern_of_examples_and_learning_tests

Signed-off-by: sven1977 <svenmika1977@gmail.com>

# Conflicts:
#	rllib/env/env_runner_group.py
#	rllib/utils/test_utils.py
@sven1977
fix
427a393 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977
fix
5ac423a 
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@sven1977 sven1977 enabled auto-merge (squash) May 16, 2024 21:51
@sven1977 sven1977 merged commit 2329466 into ray-project:master May 16, 2024
7 checks passed
@sven1977 sven1977 deleted the unify_pattern_of_examples_and_learning_tests branch May 17, 2024 03:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aslonnie aslonnie aslonnie approved these changes

@simonsays1980 simonsays1980 simonsays1980 approved these changes

@avnishn avnishn Awaiting requested review from avnishn

@ArturNiederfahrenhorst ArturNiederfahrenhorst Awaiting requested review from ArturNiederfahrenhorst

@maxpumperla maxpumperla Awaiting requested review from maxpumperla maxpumperla is a code owner

@kouroshHakha kouroshHakha Awaiting requested review from kouroshHakha

Assignees

@simonsays1980 simonsays1980

Labels
go add ONLY when ready to merge, run all tests rllib RLlib related issues rllib-newstack
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@sven1977 @simonsays1980 @aslonnie