Repository navigation
[Doc] Document composite spec shapes for batched envs - #4473
Open
YeonwooSung wants to merge 1 commit into
Open
YeonwooSung wants to merge 1 commit into
YeonwooSung wants to merge 1 commit into
Conversation
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/rl/4473
Note: Links to docs will display an error until the docs builds have been completed. ❗ 1 Active SEVsThere are 1 currently active SEVs. If your PR is affected, please view them below:
|
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Document the composite vs leaf spec-shape rule for unbatched and batched environments.
Issue #1896 asked how to set
observation_spec/action_specwhen observations have a feature shape such as[8, 8, 13]or an image. The env tutorial explainedbatch_sizebut not that the composite carries the env batch (empty if unbatched) and each leaf is that batch plus the feature. Maintainer wording on the issue is now in the tutorial and spec docs:[], image leaf[3, 64, 64].ParallelEnvwithNworkers, orbatch_size=[N]): every spec has a leading[N, *]; composite[N], image leaf[N, 3, 64, 64].The examples construct specs a custom env would assign (
GymEnv/ParallelEnv/Composite); they do not add a new env class.Code example
Motivation and Context
Why is this change required? What problem does it solve?
If it fixes an open issue, please link to the issue here.
You can use the syntax
close #15213if this solves the issue #15213close #1896
Types of changes
What types of changes does your code introduce? Remove all that do not apply:
Checklist