Skip to content

Commit 39da84f

Browse files
Editing the GridSensor documentation for 2D use case (#5396)
* Editing the GridSensor documentation for 2D use case * changing chagelog
1 parent c1ae3e0 commit 39da84f

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

com.unity.ml-agents/CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ and this project adheres to
1717
### Bug Fixes
1818
- The calculation of the target entropy of SAC with continuous actions was incorrect and has been fixed. (#5372)
1919
- RigidBodySensorComponent now displays a warning if it's used in a way that won't generate useful observations. (#5387)
20+
- Update the documentation with a note saying that `GridSensor` does not work in 2D environments. (#5396)
2021

2122

2223
## [2.0.0-exp.1] - 2021-04-22

docs/Learning-Environment-Design-Agents.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -570,13 +570,17 @@ See the doc on
570570
[extending grid Sensors](https://github.com/Unity-Technologies/ml-agents/blob/release_17/com.unity.ml-agents.extensions/Documentation~/CustomGridSensors.md)
571571
for more details on custom grid sensors.
572572

573+
__Note__: The `GridSensor` only works in 3D environments and will not behave
574+
properly in 2D environments.
575+
573576
#### Grid Observation Summary & Best Practices
574577

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

581585
### Variable Length Observations
582586

0 commit comments

Comments
 (0)