Clarifying the documentation for custom env using images as observations #2085
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SB3 allows to use images as observations for custom environments. However, the current documentation is not 100% clear on the type of observation used. I believe that, especially since images' types are
np.uint8
, the clarity of the documentation can be enhanced by adding a minimal example, specifying that although the effective type seems to be discrete, images are handled throughspaces.Box
by SB3.Description
Minimal change in the custom env documentation guide.
Motivation and Context
See above. Mainly enhancing clarity of the documentation to work with custom environment defining images as input observations.
Types of changes
Checklist
make format
(required)make check-codestyle
andmake lint
(required)make pytest
andmake type
both pass. (required)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