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] Add ObservationPreprocessor (ConnectorV2) and cleanup ConnectorV2 docstrings. #47077

Merged
merged 1 commit into from
Aug 12, 2024

Conversation

sven1977
Copy link
Contributor

@sven1977 sven1977 commented Aug 12, 2024

Add ObservationPreprocessor (ConnectorV2) and cleanup ConnectorV2 docstrings.

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 <svenmika1977@gmail.com>
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.

output_data = connector(
rl_module=None, # This particular connector works without an RLModule.
data=single_agent_data,
episodes=[], # This particular connector works without a list of episodes.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we put comments always in between code and not after it? Imo this makes it better readable and easier for formatting. What do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point, especially here, where it's a long comment! Will change ...

Sometimes, I feel it's ok to put a few-word comment right after the line, if it fits.



@PublicAPI(stability="alpha")
class ObservationPreprocessor(ConnectorV2, abc.ABC):
Copy link
Collaborator

Choose a reason for hiding this comment

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

Awesome!

@sven1977 sven1977 enabled auto-merge (squash) August 12, 2024 16:00
@github-actions github-actions bot added the go add ONLY when ready to merge, run all tests label Aug 12, 2024
@sven1977 sven1977 merged commit c603541 into ray-project:master Aug 12, 2024
6 checks passed
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