Add custom package settings #5027

dongruoping · 2021-03-03T20:59:55Z

Proposed change(s)

Add customizable ML-Agents settings in project settings.
Users can create asset for their own projects.

Settings are accessible in editor and player build.
Multiple settings assets are allowed (displayed in drop-down list).

Currently only contains Connect to Trainer and Editor Training Port. More can be added later.

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

Types of change(s)

Checklist

Added tests that prove my fix is effective or that my feature works
Updated the changelog (if applicable)
Updated the documentation (if applicable)
Updated the migration guide (if applicable)

Other comments

com.unity.ml-agents/Editor/MLAgentsSettingsBuildProvider.cs

com.unity.ml-agents/Editor/MLAgentsSettingsProvider.cs

vincentpierre · 2021-03-12T17:11:39Z

com.unity.ml-agents/Editor/MLAgentsSettingsBuildProvider.cs

@@ -0,0 +1,74 @@
+using System.Linq;


This might be a dumb question, but why do we have a BuildSettingsProvider if none of the settings are used in a build? (They are all Editor only settings?)

they are used in builds, if you don't want to train or even try to connect to a trainer in a game that's being shipped you'd want to know that in your build.

They are used in builds. If you don't want to train or even try to connect to a trainer in a game that's being shipped, you'd want to know that in your build.

You mean the use case it to remove the command line argument listeners on the build? Because a build will not try to listen to a trainer unless a specific command line argument is passed.

Good question. Originally I made a player training port but that doesn't seem to make much sense so I removed that.
But I still think there's chance that we'll add settings that is used in player (analytics? academy stepping?)

vincentpierre · 2021-03-12T17:13:26Z

com.unity.ml-agents/Editor/MLAgentsSettingsBuildProvider.cs

+        private static void ClearPlayerSettingsDirtyFlag()
+        {
+#if UNITY_2019_OR_NEWER
+            var settings = Resources.FindObjectsOfTypeAll<PlayerSettings>();


PlayerSettings? I thought this would be an MLAgentsSettings.

We're injecting our settings into the preload assets in PlayerSettings and these method is to detect/clear the dirty flag of PlayerSettings before/after we put in our settings. So PlayerSettings here is correct.

com.unity.ml-agents/Runtime/MLAgentsManager.cs

vincentpierre · 2021-03-12T17:23:37Z

com.unity.ml-agents/Runtime/MLAgentsManager.cs

+#else
+        internal static void InitializeInPlayer()
+        {
+            s_Settings = Resources.FindObjectsOfTypeAll<MLAgentsSettings>().FirstOrDefault() ?? ScriptableObject.CreateInstance<MLAgentsSettings>();


Suggested change

s_Settings = Resources.FindObjectsOfTypeAll<MLAgentsSettings>().FirstOrDefault() ?? ScriptableObject.CreateInstance<MLAgentsSettings>();

Settings = Resources.FindObjectsOfTypeAll<MLAgentsSettings>().FirstOrDefault() ?? ScriptableObject.CreateInstance<MLAgentsSettings>();

?

good catch. The callback in Settings setter is for refreshing in the editor so should not really matter though.

Can you explain in comments why we have both Settings and s_Settings?

added comments on the getter/setter

com.unity.ml-agents/Editor/MLAgentsSettingsProvider.cs

chriselion · 2021-03-15T22:47:25Z

com.unity.ml-agents/Runtime/MLAgentsSettings.cs

+    class MLAgentsSettings : ScriptableObject
+    {
+        [SerializeField]
+        private bool m_ConnectTrainer = true;


There were other settings that we talked about adding later - should we group/nest these now so that we don't have to go through hoops to move them around in the future?

I can group them into Training Port or Trainer Settings.

@chriselion by group/nest these do you mean nesting them in the code (like a subclass in MLAgentsSettings) or just grouping in editor?

Either way - I think using a subclass in MLAgentsSettings makes the grouping in the editor more automatic.

I guess if we always need to manually layout the fields in MLAgentsSettingsProvider.OnGUI, it's less important. But it might let us just add the "top level" settings (like TrainerSettings) and not have to worry about new fields when we add them.

com.unity.ml-agents/Editor/MLAgentsSettingsProvider.cs

chriselion

Can you add some user-facing documentation on how to enable these, and how to have different settings for training/inference?

docs/Package-Settings.md

surfnerd

I think it looks good. I'd like to see some Edit mode test coverage on these files. After that we can

chriselion

(Pending other feedback)

…echnologies/ml-agents into develop-package-settings

dongruoping · 2021-03-18T17:27:33Z

Tests added. I placed it under DevProject to have a place to create settings asset on the fly during tests.
The reason is that I found it hard to write meaningful tests without actually interact with asset and I can’t use something like MockFileSystem since the asset APIs require things placed under Asset/.
To reserve a place that I can create assets that won't conflict with existing files I put the tests in a separate folder in DevProject.

dongruoping · 2021-03-18T17:28:35Z

2018 tests are failing and are expected since I removed the 2019_OR_NEWER flags.
Do we plan to remove them?

surfnerd

dongruoping added 8 commits March 2, 2021 12:33

add settings provider. support changing settings in editor

adcb61c

fix static bug in provider

a1b9fce

add preload asset to player build

f63be9d

add player port and update academy

87e3a11

remove player port and add bool option of whether connect to trainer

4771f68

tmp commit

f6d6003

add manager. allow multiple settings asset.

28e561a

cleanup

19193f4

dongruoping marked this pull request as ready for review March 12, 2021 01:06

dongruoping changed the title ~~Add custom project settings~~ Add custom package settings Mar 12, 2021

dongruoping requested review from chriselion and surfnerd March 12, 2021 01:07

dongruoping commented Mar 12, 2021

View reviewed changes

com.unity.ml-agents/Editor/MLAgentsSettingsBuildProvider.cs Show resolved Hide resolved

dongruoping requested a review from vincentpierre March 12, 2021 01:44

vincentpierre reviewed Mar 12, 2021

View reviewed changes

com.unity.ml-agents/Editor/MLAgentsSettingsProvider.cs Show resolved Hide resolved

fix initialization

5fe5365

vincentpierre reviewed Mar 12, 2021

View reviewed changes

surfnerd reviewed Mar 15, 2021

View reviewed changes

com.unity.ml-agents/Editor/MLAgentsSettingsProvider.cs Show resolved Hide resolved

surfnerd reviewed Mar 15, 2021

View reviewed changes

com.unity.ml-agents/Editor/MLAgentsSettingsProvider.cs Outdated Show resolved Hide resolved

chriselion reviewed Mar 15, 2021

View reviewed changes

com.unity.ml-agents/Editor/MLAgentsSettingsProvider.cs Show resolved Hide resolved

chriselion reviewed Mar 15, 2021

View reviewed changes

dongruoping added 6 commits March 16, 2021 12:59

rename manager to MLAgentsSettingsManager

d04a5d4

more rename manager to MLAgentsSettingsManager

6effd7b

address comments

38cbadb

group settings

df9aaed

revert asset changes

525a5d4

remove unity version flags

87ed122

dongruoping changed the base branch from main to v2-staging March 16, 2021 22:02

revert asset changes

3a2a46b

dongruoping added 4 commits March 16, 2021 16:27

add docs

1857a44

fix file name

2a4c25d

changelog

73339fa

Merge branch 'v2-staging' into develop-package-settings

5deba49

surfnerd reviewed Mar 17, 2021

View reviewed changes

docs/Package-Settings.md Outdated Show resolved Hide resolved

surfnerd reviewed Mar 17, 2021

View reviewed changes

docs/Package-Settings.md Outdated Show resolved Hide resolved

surfnerd suggested changes Mar 17, 2021

View reviewed changes

chriselion approved these changes Mar 17, 2021

View reviewed changes

dongruoping added 3 commits March 18, 2021 00:32

add tests

e1da84f

Merge branch 'develop-package-settings' of https://github.com/Unity-T…

430e253

…echnologies/ml-agents into develop-package-settings

address comments

53d59fe

dongruoping added 2 commits March 18, 2021 11:13

bring back unity version flags

52b2297

fix academy stepper tests

4a2a5b6

surfnerd closed this Mar 18, 2021

surfnerd deleted the branch v2-staging March 18, 2021 21:37

surfnerd reopened this Mar 18, 2021

surfnerd approved these changes Mar 18, 2021

View reviewed changes

dongruoping merged commit 3762dd2 into v2-staging Mar 18, 2021

delete-merged-branch bot deleted the develop-package-settings branch March 18, 2021 22:14

surfnerd pushed a commit that referenced this pull request Mar 18, 2021

Add custom package settings (#5027)

9ea9dcc

github-actions bot locked as resolved and limited conversation to collaborators Mar 19, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add custom package settings #5027

Add custom package settings #5027

dongruoping commented Mar 3, 2021 •

edited by surfnerd

Loading

vincentpierre Mar 12, 2021

surfnerd Mar 12, 2021

surfnerd Mar 12, 2021

vincentpierre Mar 12, 2021

dongruoping Mar 12, 2021

vincentpierre Mar 12, 2021

dongruoping Mar 12, 2021

vincentpierre Mar 12, 2021

dongruoping Mar 12, 2021

chriselion Mar 15, 2021

dongruoping Mar 16, 2021

chriselion Mar 15, 2021

dongruoping Mar 16, 2021 •

edited

Loading

dongruoping Mar 16, 2021

chriselion Mar 17, 2021

chriselion Mar 17, 2021

chriselion left a comment

surfnerd left a comment

chriselion left a comment

dongruoping commented Mar 18, 2021

dongruoping commented Mar 18, 2021 •

edited

Loading

surfnerd left a comment

	s_Settings = Resources.FindObjectsOfTypeAll<MLAgentsSettings>().FirstOrDefault() ?? ScriptableObject.CreateInstance<MLAgentsSettings>();
	Settings = Resources.FindObjectsOfTypeAll<MLAgentsSettings>().FirstOrDefault() ?? ScriptableObject.CreateInstance<MLAgentsSettings>();

Add custom package settings #5027

Add custom package settings #5027

Conversation

dongruoping commented Mar 3, 2021 • edited by surfnerd Loading

Proposed change(s)

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

Types of change(s)

Checklist

Other comments

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dongruoping Mar 16, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chriselion left a comment

Choose a reason for hiding this comment

surfnerd left a comment

Choose a reason for hiding this comment

chriselion left a comment

Choose a reason for hiding this comment

dongruoping commented Mar 18, 2021

dongruoping commented Mar 18, 2021 • edited Loading

surfnerd left a comment

Choose a reason for hiding this comment

dongruoping commented Mar 3, 2021 •

edited by surfnerd

Loading

dongruoping Mar 16, 2021 •

edited

Loading

dongruoping commented Mar 18, 2021 •

edited

Loading