Skip to content
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

Jump to bottom

Editing the GridSensor documentation for 2D use case #5396

Merged
merged 2 commits into from
May 26, 2021
Merged

Editing the GridSensor documentation for 2D use case #5396

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a5970ec
Editing the GridSensor documentation for 2D use case
vincentpierre May 26, 2021
9ca6450
changing chagelog
vincentpierre May 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions com.unity.ml-agents/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ and this project adheres to
- Added a fully connected visual encoder for environments with very small image inputs. (#5351)
### Bug Fixes
- RigidBodySensorComponent now displays a warning if it's used in a way that won't generate useful observations. (#5387)
- Update the documentation with a note saying that `GridSensor` does not work in 2D environments. (#5396)


## [2.0.0-exp.1] - 2021-04-22
Expand Down
4 changes: 4 additions & 0 deletions docs/Learning-Environment-Design-Agents.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -570,13 +570,17 @@ See the doc on
[extending grid Sensors](https://github.com/Unity-Technologies/ml-agents/blob/release_17/com.unity.ml-agents.extensions/Documentation~/CustomGridSensors.md)
for more details on custom grid sensors.

__Note__: The `GridSensor` only works in 3D environments and will not behave
properly in 2D environments.

#### Grid Observation Summary & Best Practices

- Attach `GridSensorComponent` to use.
- This observation type is best used when there is relevant non-visual spatial information that
can be best captured in 2D representations.
- Use as small grid size and as few tags as necessary to solve the problem in order to improve
learning stability and agent performance.
- Do not use `GridSensor` in a 2D game.

### Variable Length Observations

Expand Down