Skip to content

Update visual stacking doc #5391

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
May 25, 2021
Merged

Update visual stacking doc #5391

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e4211ca
update sensor stacking doc
May 25, 2021
814cebc
Update docs/Learning-Environment-Design-Agents.md
May 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/Learning-Environment-Design-Agents.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,9 +370,6 @@ The steps for enabling stacking depends on how you generate observations:
Generally, this should happen in the `CreateSensor()` method of your
`SensorComponent`.

Note that stacking currently only supports for vector observations; stacking
for visual observations is not supported.

#### Vector Observation Summary & Best Practices

- Vector Observations should include all variables relevant for allowing the
Expand Down Expand Up @@ -432,6 +429,10 @@ have a unique name so that they can be sorted deterministically (the name must
be unique for that Agent, but multiple Agents can have a Sensor Component with
the same name).

Visual observations also support stacking, by specifying `Observation Stacks`
to a value greater than 1. The visual observations from the last `stackSize-1`
steps will be stacked on the last dimension (channel dimension).

When using `RenderTexture` visual observations, a handy feature for debugging is
adding a `Canvas`, then adding a `Raw Image` with it's texture set to the
Agent's `RenderTexture`. This will render the agent observation on the game
Expand Down