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

Fix type annotations of buffers #1700

Merged
merged 8 commits into from
Sep 28, 2023
Merged

Fix type annotations of buffers #1700

merged 8 commits into from
Sep 28, 2023

Conversation

araffin
Copy link
Member

@araffin araffin commented Sep 27, 2023

Description

Fixes replay buffer type annotation, starting to fade out pytype too (the idea would be to have mypy only at the end, faster and stricter).

closes #112 too

Motivation and Context

  • I have raised an issue to propose this change (required for new features and bug fixes)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (update in the documentation)

Checklist

  • I've read the CONTRIBUTION guide (required)
  • I have updated the changelog accordingly (required).
  • My change requires a change to the documentation.
  • I have updated the tests accordingly (required for a bug fix or a new feature).
  • I have updated the documentation accordingly.
  • I have opened an associated PR on the SB3-Contrib repository (if necessary)
  • I have opened an associated PR on the RL-Zoo3 repository (if necessary)
  • I have reformatted the code using make format (required)
  • I have checked the codestyle using make check-codestyle and make lint (required)
  • I have ensured make pytest and make type both pass. (required)
  • I have checked that the documentation builds using make doc (required)

Note: You can run most of the checks using make commit-checks.

Note: we are using a maximum length of 127 characters per line

@araffin araffin marked this pull request as ready for review September 27, 2023 10:39
@qgallouedec
Copy link
Collaborator

I'll look into this tomorrow :)

@qgallouedec
Copy link
Collaborator

qgallouedec commented Sep 28, 2023

The ideal for buffers would be to use a generic annotation, but for the sake of simplicity, I think it's better to keep it this way.

@araffin
Copy link
Member Author

araffin commented Sep 28, 2023

The ideal for buffers would be to use a generic annotation, but for the sake of simplicity, I think it's better to keep it this way.

I actually tried but reverted back.... there was no simple way to tell mypy that the type in would be the same out with all the inheritance.
We would need some inheritance à la rust, where you inherit features and not a complete class...

@araffin araffin merged commit c6c660e into master Sep 28, 2023
4 checks passed
@araffin araffin deleted the fix/type-hint-buffer branch September 28, 2023 16:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Optimization] Replay Buffers shouldn't use copy when using np.array
2 participants