[Doc] Document multi-agent _step TensorDict layout - #4232
Open
YeonwooSung wants to merge 3 commits into
Open
Conversation
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/rl/4232
Note: Links to docs will display an error until the docs builds have been completed. ❌ 3 New FailuresAs of commit 853299d with merge base 1d3de3d ( NEW FAILURES - The following jobs have failed:
This comment was automatically generated by Dr. CI and updates every 15 minutes. |
Clarify that collectors and replay buffers preserve nested keys without plural-key arguments, and direct users to group policies and per-group loss key configuration.
Construct the placeholder reset observations on self.device so the documented environment satisfies EnvBase placement guarantees when callers pass device=.
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
Extends
docs/source/reference/envs_multiagent.rstwith a Multiple agent groups section so a nativeEnvBase._step()is documented beyond the single"agents"group used by VMAS.The new section:
_step()must write for several groups ("red"/"blue", or"agents"/"adversaries"): per-group nested tensordicts with a stacked agent dimension.TwoTeamEnv(EnvBase)sketch (not a PettingZoo wrapper) that reads(group, "action")and returns observations, rewards, and shared done flags without a"next"wrapper.The existing VMAS single-group example is kept as the simple case. The intro now treats
"agents"as one group name, not a required key.Motivation and Context
close #2425
The current multi-agent env page only documented the single
"agents"group. Matteo Bettini agreed it needed a more general multi-group description; a later comment pointed at the competitive DDPG tutorial rollout as the pattern.Types of changes
Checklist