Skip to content

[RLlib] Cleanup examples folder #10: Add custom_rl_module.py example script and matching RLModule example class (tiny CNN)..#45774

Merged
sven1977 merged 14 commits intoray-project:masterfrom
sven1977:cleanup_examples_folder_10_custom_rl_module.py
Jun 7, 2024
Merged

[RLlib] Cleanup examples folder #10: Add custom_rl_module.py example script and matching RLModule example class (tiny CNN)..#45774
sven1977 merged 14 commits intoray-project:masterfrom
sven1977:cleanup_examples_folder_10_custom_rl_module.py

Conversation

@sven1977
Copy link
Copy Markdown
Contributor

@sven1977 sven1977 commented Jun 6, 2024

Cleanup examples folder #10: Add custom_rl_module.py example script and matching RLModule example class (tiny CNN)..

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 added 7 commits May 15, 2024 20:49
Signed-off-by: sven1977 <svenmika1977@gmail.com>
Signed-off-by: sven1977 <svenmika1977@gmail.com>
…nup_examples_folder_10_custom_rl_module.py
…nup_examples_folder_10_custom_rl_module.py

Signed-off-by: sven1977 <svenmika1977@gmail.com>
Signed-off-by: sven1977 <svenmika1977@gmail.com>
…nup_examples_folder_10_custom_rl_module.py
Signed-off-by: sven1977 <svenmika1977@gmail.com>
…with RLlib default ones.

Signed-off-by: sven1977 <svenmika1977@gmail.com>
Copy link
Copy Markdown
Contributor

@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 default implementation is to return TorchCategorical for Discrete action
# spaces and TorchDiagGaussian for Box action spaces. For all other spaces,
# raise a NotImplementedError
if isinstance(self.config.action_space, gym.spaces.Discrete):
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Why not using TorchMultiCategorical and TorchMultiDistribution - things that get assembled inside of the Catalog?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Not sure either, tbh. I just wanted to get the most simple setup automated. I feel like users that just want to "hack together an RLModule" should not be concerned about picking the categorical distr for their CartPole action space :)

Yes, we should extend this method to even more decent defaults, I think.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Let's continue brainstorming how to simplify the general RLModule experience for the user ...

try:
module_spec: SingleAgentRLModuleSpec = self.config.rl_module_spec
module_spec.observation_space = self._env_to_module.observation_space
# TODO (simon): The `gym.Wrapper` for `gym.vector.VectorEnv` should
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Great that this is gone now.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yeah, it didn't seem to be a problem anymore (e.g. for PPO Pendulum, everything looks completely fine w/o any weird space errors on the Box actions). So I removed this comment.

@sven1977 sven1977 enabled auto-merge (squash) June 6, 2024 15:55
@github-actions github-actions bot added the go add ONLY when ready to merge, run all tests label Jun 6, 2024
sven1977 added 4 commits June 6, 2024 20:55
…nup_examples_folder_10_custom_rl_module.py
…nup_examples_folder_10_custom_rl_module.py
Signed-off-by: sven1977 <svenmika1977@gmail.com>
Signed-off-by: sven1977 <svenmika1977@gmail.com>
@github-actions github-actions bot disabled auto-merge June 7, 2024 07:00
sven1977 added 2 commits June 7, 2024 13:01
Signed-off-by: sven1977 <svenmika1977@gmail.com>
…nup_examples_folder_10_custom_rl_module.py
@sven1977 sven1977 merged commit ef54ee5 into ray-project:master Jun 7, 2024
@sven1977 sven1977 deleted the cleanup_examples_folder_10_custom_rl_module.py branch June 7, 2024 12:30
richardsliu pushed a commit to richardsliu/ray that referenced this pull request Jun 12, 2024
….py` example script and matching RLModule example class (tiny CNN).. (ray-project#45774)

Signed-off-by: Richard Liu <ricliu@google.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

go add ONLY when ready to merge, run all tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants