Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Clarify the use of Gym wrappers with make_vec_env #2079

Merged
merged 2 commits into from
Feb 7, 2025

Conversation

pstahlhofen
Copy link
Contributor

@pstahlhofen pstahlhofen commented Feb 4, 2025

Description

I added a note to the documentation, notifying the user of the possibility to wrap sub-environments using make_vec_env. (See #2075 )

Motivation and Context

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

closes #2075

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

pstahlhofen and others added 2 commits February 4, 2025 10:42
possibility of wrapping sub-environments with `make_vec_env` (See DLR-RM#2075 )
Copy link
Member

@araffin araffin left a comment

Choose a reason for hiding this comment

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

LGTM, thanks =)

@araffin araffin changed the title Improved documentation on Vectorized Environments Clarify the use of Gym wrappers with make_vec_env Feb 7, 2025
@araffin araffin merged commit c5c29a3 into DLR-RM:master Feb 7, 2025
4 checks passed
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature Request] RescaleAction wrapper for SB3 VecEnv
2 participants