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 policies type annotations #1735

Merged
merged 1 commit into from
Nov 6, 2023
Merged

Fix policies type annotations #1735

merged 1 commit into from
Nov 6, 2023

Conversation

araffin
Copy link
Member

@araffin araffin commented Nov 6, 2023

Description

closes #1679

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

Copy link
Collaborator

@ernestum ernestum left a comment

Choose a reason for hiding this comment

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

LGTM and thangs for the change. This looks like a valuable addition!
Only thing I did not understand is why we need so many type ignores?

@araffin
Copy link
Member Author

araffin commented Nov 6, 2023

I did not understand is why we need so many type ignores?

for policies, a lot of them are due to "List or tuple expected as variadic arguments" when doing reshape, and I'm not sure if there is an easy way to solve that.
For the rest, it's mostly because we re-use variable names (obs start being a tensor and then is converted to numpy array).

This is meant to be a first pass (I hope to improve things in the future, notably with TypeVar)

@araffin araffin merged commit d671402 into master Nov 6, 2023
4 checks passed
@araffin araffin deleted the fix/policy-type-hint branch November 6, 2023 17:35
friedeggs pushed a commit to friedeggs/stable-baselines3 that referenced this pull request Jul 22, 2024
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.

[Bug]: incorrect type signature that take in dictionary observations
2 participants