Skip to content

Turns physics modules into optional dependencies.#5112

Merged
surfnerd merged 4 commits into
mainfrom
develop-physics-optional-dep
Mar 22, 2021
Merged

Turns physics modules into optional dependencies.#5112
surfnerd merged 4 commits into
mainfrom
develop-physics-optional-dep

Conversation

@surfnerd

@surfnerd surfnerd commented Mar 14, 2021 •
edited
Loading

Copy link
Copy Markdown
Contributor

Proposed change(s)

  • Make physics and physics2d optional deps.
  • Update yamato tests to run coverage tests separately from the package tests. This allows us to fail quickly if coverage is not up to par with our goals.

Useful links (Github issues, JIRA tickets, ML-Agents forum threads etc.)

#5104 (Make both physics modules optional dependencies (com.unity.modules.physics and com.unity.modules.physics2d))
MLA-1850

Screen Shot 2021-03-15 at 8 21 24 PM

Types of change(s)

  • Code refactor

Checklist

  • Added tests that prove my fix is effective or that my feature works

Other comments

@surfnerd surfnerd requested a review from chriselion March 14, 2021 21:20
@surfnerd surfnerd force-pushed the develop-physics-optional-dep branch from 5994dff to a27e9b1 Compare March 15, 2021 16:28
chriselion
chriselion reviewed Mar 15, 2021
View reviewed changes
Comment thread com.unity.ml-agents/Editor/RayPerceptionSensorComponentBaseEditor.cs Outdated
@delete-merged-branch delete-merged-branch Bot deleted the branch main March 15, 2021 23:13
@surfnerd surfnerd force-pushed the develop-physics-optional-dep branch from a27e9b1 to f17d9c9 Compare March 15, 2021 23:43
@surfnerd surfnerd changed the base branch from develop-analytics-optional-dep to main March 15, 2021 23:45
@surfnerd surfnerd self-assigned this Mar 16, 2021
@surfnerd surfnerd force-pushed the develop-physics-optional-dep branch from e6f24a8 to f9e99da Compare March 16, 2021 05:13
chriselion
chriselion reviewed Mar 17, 2021
View reviewed changes
Comment thread .yamato/com.unity.ml-agents-coverage.yml Outdated
chriselion
chriselion reviewed Mar 17, 2021
View reviewed changes
Comment thread .yamato/com.unity.ml-agents-coverage.yml Outdated
chriselion
chriselion reviewed Mar 17, 2021
View reviewed changes
Comment thread .yamato/com.unity.ml-agents-optional-dep-tests.yml Outdated
chriselion
chriselion reviewed Mar 17, 2021
View reviewed changes
Comment thread .yamato/com.unity.ml-agents-test.yml Outdated
chriselion
chriselion reviewed Mar 17, 2021
View reviewed changes
Comment thread com.unity.ml-agents/Editor/RayPerceptionSensorComponentBaseEditor.cs
chriselion
chriselion reviewed Mar 17, 2021
View reviewed changes
Comment thread com.unity.ml-agents/Runtime/Academy.cs Outdated
chriselion
chriselion reviewed Mar 17, 2021
View reviewed changes
Comment thread com.unity.ml-agents/Runtime/Analytics/AnalyticsUtils.cs Outdated
chriselion
chriselion reviewed Mar 17, 2021
View reviewed changes
Comment thread com.unity.ml-agents/Runtime/Sensors/RayPerceptionSensor.cs Outdated
chriselion
chriselion reviewed Mar 17, 2021
View reviewed changes
Comment thread com.unity.ml-agents/Runtime/Sensors/RayPerceptionSensorComponentBase.cs
surfnerd
surfnerd commented Mar 17, 2021
View reviewed changes
Comment thread .yamato/com.unity.ml-agents-optional-dep-tests.yml
NOT pull_request.draft AND
(pull_request.changes.any match "com.unity.ml-agents/**" OR
pull_request.changes.any match ".yamato/com.unity.ml-agents-test.yml")
optional_deps:

@surfnerd surfnerd Mar 17, 2021

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yml to test the package with different project setups to ensure all tests pass with each optional dependency removed.

surfnerd
surfnerd commented Mar 17, 2021
View reviewed changes
Comment thread com.unity.ml-agents.extensions/package.json
"dependencies": {
"com.unity.ml-agents": "1.9.0-preview"
"com.unity.ml-agents": "1.9.0-preview",
"com.unity.modules.physics": "1.0.0"

@surfnerd surfnerd Mar 17, 2021

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add this for physics sensors in extensions.

surfnerd
surfnerd commented Mar 17, 2021
View reviewed changes
Comment thread com.unity.ml-agents/Runtime/Analytics/InferenceAnalytics.cs Outdated
surfnerd
surfnerd commented Mar 17, 2021
View reviewed changes
Comment thread com.unity.ml-agents/Runtime/Analytics/TrainingAnalytics.cs
surfnerd
surfnerd commented Mar 17, 2021
View reviewed changes
Comment thread com.unity.ml-agents/Runtime/Communicator/GrpcExtensions.cs Outdated
surfnerd
surfnerd commented Mar 17, 2021
View reviewed changes
Comment thread com.unity.ml-agents/Runtime/Policies/BarracudaPolicy.cs Outdated
surfnerd
surfnerd commented Mar 17, 2021
View reviewed changes
Comment thread com.unity.ml-agents/Runtime/Policies/HeuristicPolicy.cs Outdated
surfnerd
surfnerd commented Mar 17, 2021
View reviewed changes
Comment thread com.unity.ml-agents/Runtime/Policies/RemotePolicy.cs Outdated
surfnerd
surfnerd commented Mar 17, 2021
View reviewed changes
Comment thread com.unity.ml-agents/Runtime/SideChannels/TrainingAnalyticsSideChannel.cs Outdated
@surfnerd surfnerd force-pushed the develop-physics-optional-dep branch from cb06ec5 to b4e832f Compare March 19, 2021 18:45
@surfnerd surfnerd enabled auto-merge (squash) March 19, 2021 20:07
chriselion
chriselion reviewed Mar 19, 2021
View reviewed changes
Comment thread .yamato/com.unity.ml-agents-test.yml Outdated
chriselion
chriselion reviewed Mar 19, 2021
View reviewed changes
Comment thread .yamato/com.unity.ml-agents-test.yml Outdated
chriselion
chriselion reviewed Mar 19, 2021
View reviewed changes
Comment thread com.unity.ml-agents/Runtime/Sensors/RayPerceptionSensorComponent2D.cs Outdated
@surfnerd surfnerd force-pushed the develop-physics-optional-dep branch 2 times, most recently from 78db448 to ff2184e Compare March 22, 2021 17:44
@surfnerd surfnerd force-pushed the develop-physics-optional-dep branch from 03ffbbf to acb9987 Compare March 22, 2021 20:11
@surfnerd surfnerd disabled auto-merge March 22, 2021 20:29
@surfnerd surfnerd enabled auto-merge (squash) March 22, 2021 21:45
chriselion
chriselion reviewed Mar 22, 2021
View reviewed changes
Comment thread .yamato/com.unity.ml-agents-test.yml
testProject: DevProject
enableNoDefaultPackages: !!bool true
- version: 2019.4
enableCodeCoverage: !!bool true

@chriselion chriselion Mar 22, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can remove enableCodeCoverage now, right?

chriselion
chriselion reviewed Mar 22, 2021
View reviewed changes
Comment thread com.unity.ml-agents/Runtime/Sensors/RayPerceptionSensorComponent2D.cs
{
// Set to the 2D defaults (just in case they ever diverge).
RayLayerMask = Physics2D.DefaultRaycastLayers;
RayLayerMask = -5;

@chriselion chriselion Mar 22, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't need this anymore, now that we're always using k_PhysicsDefaultLayers in the base class. (sorry, github wouldn't let me do a multi-line suggestion).

chriselion
chriselion approved these changes Mar 22, 2021
View reviewed changes

@chriselion chriselion left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two small nits, looks good otherwise.

@surfnerd surfnerd merged commit b25dc5a into main Mar 22, 2021
@delete-merged-branch delete-merged-branch Bot deleted the develop-physics-optional-dep branch March 22, 2021 22:10
@surfnerd surfnerd mentioned this pull request Mar 22, 2021
Merged
@surfnerd surfnerd mentioned this pull request Apr 7, 2021
Closed
@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Mar 23, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@dongruoping dongruoping Awaiting requested review from dongruoping

@vincentpierre vincentpierre Awaiting requested review from vincentpierre

1 more reviewer

@chriselion chriselion chriselion approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@surfnerd surfnerd

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@surfnerd @chriselion