Skip to content

Commit 5ae4f6b

Browse files
author
Chris Elion
authored
Migration guide for RayPerceptionSensor+scale (#3344)
* Migration guide for RayPerceptionSensor+scale Followup from #3334 * whitespace
1 parent 30a8926 commit 5ae4f6b

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/Migrating.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ The versions can be found in
2828
* The `GetValueEstimate()` method on the Agent has been removed.
2929
* The `UpdateValueAction()` method on the Agent has been removed.
3030
* The deprecated `RayPerception3D` and `RayPerception3D` classes were removed, and the `legacyHitFractionBehavior` argument was removed from `RayPerceptionSensor.PerceiveStatic()`.
31+
* RayPerceptionSensor was inconsistent in how it handle scale on the Agent's transform. It now scales the ray length and sphere size for casting as the transform's scale changes.
3132

3233
### Steps to Migrate
3334
* If your Agent implemented `AgentOnDone` and did not have the checkbox `Reset On Done` checked in the inspector, you must call the code that was in `AgentOnDone` manually.
@@ -44,6 +45,7 @@ The versions can be found in
4445
* Multiply `max_steps` and `summary_steps` in your `trainer_config.yaml` by the number of Agents in the scene.
4546
* Combine curriculum configs into a single file. See [the WallJump curricula](../config/curricula/wall_jump.yaml) for an example of the new curriculum config format.
4647
A tool like https://www.json2yaml.com may be useful to help with the conversion.
48+
* If you have a model trained which uses RayPerceptionSensor and has non-1.0 scale in the Agent's transform, it must be retrained.
4749

4850

4951
## Migrating from ML-Agents toolkit v0.12.0 to v0.13.0

0 commit comments

Comments
 (0)