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.

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 #16: Add missing docstrings to 2 connector example scripts. #45864

Conversation

sven1977
Copy link
Contributor

@sven1977 sven1977 commented Jun 11, 2024

Cleanup examples folder #16: Add missing docstrings to 2 connector example scripts.

  • mean/std filter and frame-stacking.
  • Other major improvements of these 2 scripts.

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 :(

Signed-off-by: sven1977 <[email protected]>
Signed-off-by: sven1977 <[email protected]>
Signed-off-by: sven1977 <[email protected]>
@sven1977 sven1977 added the tests-ok The tagger certifies test failures are unrelated and assumes personal liability. label Jun 11, 2024
@sven1977 sven1977 removed their assignment Jun 11, 2024
Signed-off-by: sven1977 <[email protected]>
Signed-off-by: sven1977 <[email protected]>
Signed-off-by: sven1977 <[email protected]>
Signed-off-by: sven1977 <[email protected]>
…nup_examples_folder_16_docstrings_for_connector_examples
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

# Define env-to-module-connector pipeline for the new stack.
def _env_to_module_pipeline(env):
return [
AddObservationsFromEpisodesToBatch(),
Copy link
Collaborator

Choose a reason for hiding this comment

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

Are the rest of the connectors now default?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

All off-the-shelf connectors now directly operate on the episodes now (except for framestacking for performance reasons):

  • read last obs from episode
  • alter that last obs
  • directly write it back into the episode via episode.set_observations.

This way, RLlib's default pieces (which come after the user defined ones) only see the already altered episode and thus properly extract the observations from those and put them into the RLModule batch.

This way, things work more uniformly. Reading the last obs from an episode and writing it back is super fast, b/c we are still operating on simple lists in the EnvRunner (not numpy'ized yet).

Signed-off-by: sven1977 <[email protected]>
Signed-off-by: sven1977 <[email protected]>
Signed-off-by: sven1977 <[email protected]>
@sven1977 sven1977 enabled auto-merge (squash) June 13, 2024 07:51
@github-actions github-actions bot added the go add ONLY when ready to merge, run all tests label Jun 13, 2024
@sven1977 sven1977 merged commit f49557f into ray-project:master Jun 13, 2024
8 checks passed
@sven1977 sven1977 deleted the cleanup_examples_folder_16_docstrings_for_connector_examples branch June 25, 2024 10:00
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 tests-ok The tagger certifies test failures are unrelated and assumes personal liability.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants