Update v2-staging from main (March 15)

.github/workflows/pre-commit.yml

@@ -19,7 +19,6 @@ jobs:
     - uses: actions/setup-dotnet@v1
       with:
         dotnet-version: '3.1.x'
-    - run: dotnet tool install -g dotnet-format --version 4.1.131201
     - uses: pre-commit/action@v2.0.0
 
   markdown-link-check:

.github/workflows/pytest.yml

@@ -19,7 +19,16 @@ jobs:
         TEST_ENFORCE_BUFFER_KEY_TYPES: 1
     strategy:
       matrix:
-        python-version: [3.6.x, 3.7.x, 3.8.x]
+        python-version: [3.6.x, 3.7.x, 3.8.x, 3.9.x]
+        include:
+          - python-version: 3.6.x
+            pip_constraints: test_constraints_min_version.txt
+          - python-version: 3.7.x
+            pip_constraints: test_constraints_mid_version.txt
+          - python-version: 3.8.x
+            pip_constraints: test_constraints_mid_version.txt
+          - python-version: 3.9.x
+            pip_constraints: test_constraints_max_version.txt
     steps:
     - uses: actions/checkout@v2
     - name: Set up Python
@@ -32,7 +41,7 @@ jobs:
         # This path is specific to Ubuntu
         path: ~/.cache/pip
         # Look to see if there is a cache hit for the corresponding requirements file
-        key: ${{ runner.os }}-pip-${{ hashFiles('ml-agents/setup.py', 'ml-agents-envs/setup.py', 'gym-unity/setup.py', 'test_requirements.txt') }}
+        key: ${{ runner.os }}-pip-${{ hashFiles('ml-agents/setup.py', 'ml-agents-envs/setup.py', 'gym-unity/setup.py', 'test_requirements.txt', matrix.pip_constraints) }}
         restore-keys: |
           ${{ runner.os }}-pip-
           ${{ runner.os }}-
@@ -42,11 +51,11 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         python -m pip install --upgrade setuptools
-        python -m pip install --progress-bar=off -e ./ml-agents-envs
-        python -m pip install --progress-bar=off -e ./ml-agents
-        python -m pip install --progress-bar=off -r test_requirements.txt
-        python -m pip install --progress-bar=off -e ./gym-unity
-        python -m pip install --progress-bar=off -e ./ml-agents-plugin-examples
+        python -m pip install --progress-bar=off -e ./ml-agents-envs -c ${{ matrix.pip_constraints }}
+        python -m pip install --progress-bar=off -e ./ml-agents -c ${{ matrix.pip_constraints }}
+        python -m pip install --progress-bar=off -r test_requirements.txt -c ${{ matrix.pip_constraints }}
+        python -m pip install --progress-bar=off -e ./gym-unity -c ${{ matrix.pip_constraints }}
+        python -m pip install --progress-bar=off -e ./ml-agents-plugin-examples -c ${{ matrix.pip_constraints }}
     - name: Save python dependencies
       run: |
         pip freeze > pip_versions-${{ matrix.python-version }}.txt

.pre-commit-config.yaml

@@ -83,6 +83,12 @@ repos:
     types: [markdown]
     exclude: ".*localized.*"
 
+- repo: https://github.com/dotnet/format
+  rev: "7e343070a0355c86f72bdee226b5e19ffcbac931"  # TODO - update to a tagged version when one that includes the hook is ready.
+  hooks:
+  - id: dotnet-format
+    args: [--folder, --include]
+
 # "Local" hooks, see https://pre-commit.com/#repository-local-hooks
 -   repo: local
     hooks:
@@ -119,4 +125,3 @@ repos:
         name: validate release links
         language: script
         entry: utils/validate_release_links.py
-

.yamato/com.unity.ml-agents-optional-dep-tests.yml

@@ -0,0 +1,37 @@
+OptionalDependencyTestsLinux:
+  name : LinuxOptionalDependenciesTests
+  agent:
+    type: Unity::VM
+    image: package-ci/ubuntu:stable
+    flavor: b1.medium
+  commands: 
+    - |
+      curl -L https://artifactory.prd.it.unity3d.com/artifactory/api/gpg/key/public | sudo apt-key add -
+      sudo sh -c "echo 'deb https://artifactory.prd.it.unity3d.com/artifactory/unity-apt-local bionic main' > /etc/apt/sources.list.d/unity.list"
+      sudo apt update
+      sudo apt install -y unity-config 
+      npm install upm-ci-utils@stable -g --registry https://artifactory.prd.cds.internal.unity3d.com/artifactory/api/npm/upm-npm
+      unity-config settings editor-path ./.Editor
+      unity-config project create opt-deps-test
+      unity-config project add dependency com.unity.ml-agents/
+      unity-config project add testable com.unity.ml-agents
+      unity-config project add dependency com.unity.modules.imageconversion@1.0.0
+      unity-config project add dependency com.unity.modules.jsonserialize@1.0.0
+      unity-config project add dependency com.unity.modules.physics@1.0.0
+      unity-config project add dependency com.unity.modules.physics2d@1.0.0
+      upm-ci project test -u 2019.4 --type project-tests --project-path opt-deps-test --package-filter com.unity.ml-agents 
+  artifacts:
+    logs:
+      paths:
+        - "upm-ci~/test-results/**/*"
+  dependencies:
+    - .yamato/com.unity.ml-agents-pack.yml#pack
+  triggers:
+    cancel_old_ci: true
+    expression: |
+      (pull_request.target eq "main" OR
+      pull_request.target match "release.+") AND
+      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")
+

.yamato/com.unity.ml-agents-pack.yml

@@ -5,8 +5,12 @@ pack:
     image: package-ci/ubuntu:stable
     flavor: b1.small
   commands:
-    - npm install upm-ci-utils@stable -g --registry https://artifactory.prd.cds.internal.unity3d.com/artifactory/api/npm/upm-npm
-    - upm-ci project pack --project-path Project
+    - |
+      python3 -m pip install unity-downloader-cli --index-url https://artifactory.prd.it.unity3d.com/artifactory/api/pypi/pypi/simple --upgrade
+      unity-downloader-cli -u 2018.4 -c editor --wait --fast
+      ./.Editor/Unity -projectPath Project -batchMode -executeMethod Unity.MLAgents.SampleExporter.ExportCuratedSamples -logFile -
+      npm install upm-ci-utils@stable -g --registry https://artifactory.prd.cds.internal.unity3d.com/artifactory/api/npm/upm-npm
+      upm-ci project pack --project-path Project
   artifacts:
     packages:
       paths:

.yamato/com.unity.ml-agents-test.yml

@@ -150,3 +150,4 @@ test_{{ package.name }}_{{ platform.name }}_trunk:
     {% endfor %}
   {% endfor %}
 {% endfor %}
+

.yamato/python-ll-api-test.yml

@@ -18,7 +18,7 @@ test_linux_ll_api_{{ editor.version }}:
       python ml-agents/tests/yamato/scripts/run_llapi.py
       python ml-agents/tests/yamato/scripts/run_llapi.py --env=artifacts/testPlayer-Basic
       python ml-agents/tests/yamato/scripts/run_llapi.py --env=artifacts/testPlayer-WallJump
-      python ml-agents/tests/yamato/scripts/run_llapi.py --env=artifacts/testPlayer-Bouncer
+      python ml-agents/tests/yamato/scripts/run_llapi.py --env=artifacts/testPlayer-Match3
   dependencies:
     - .yamato/standalone-build-test.yml#test_linux_standalone_{{ editor.version }}
   triggers:

.yamato/standalone-build-test.yml

@@ -15,7 +15,7 @@ test_linux_standalone_{{ editor.version }}:
     - unity-downloader-cli -u {{ editor.version }} -c editor --wait --fast
     - python3 -u -m ml-agents.tests.yamato.standalone_build_tests --build-target=linux
     - python3 -u -m ml-agents.tests.yamato.standalone_build_tests --build-target=linux --scene=Assets/ML-Agents/Examples/Basic/Scenes/Basic.unity
-    - python3 -u -m ml-agents.tests.yamato.standalone_build_tests --build-target=linux --scene=Assets/ML-Agents/Examples/Bouncer/Scenes/Bouncer.unity
+    - python3 -u -m ml-agents.tests.yamato.standalone_build_tests --build-target=linux --scene=Assets/ML-Agents/Examples/Match3/Scenes/Match3.unity
     - python3 -u -m ml-agents.tests.yamato.standalone_build_tests --build-target=linux --scene=Assets/ML-Agents/Examples/WallJump/Scenes/WallJump.unity
     - python3 -u -m ml-agents.tests.yamato.standalone_build_tests --build-target=linux --scene=Assets/ML-Agents/TestScenes/TestCompressedGrid/TestGridCompressed.unity
     - python3 -u -m ml-agents.tests.yamato.standalone_build_tests --build-target=linux --scene=Assets/ML-Agents/TestScenes/TestCompressedTexture/TestTextureCompressed.unity

DevProject/Packages/packages-lock.json

@@ -31,7 +31,7 @@
       "url": "https://artifactory.prd.cds.internal.unity3d.com/artifactory/api/npm/upm-candidates"
     },
     "com.unity.barracuda": {
-      "version": "1.3.0-preview",
+      "version": "1.3.1-preview",
       "depth": 1,
       "source": "registry",
       "dependencies": {
@@ -108,7 +108,7 @@
       "depth": 0,
       "source": "local",
       "dependencies": {
-        "com.unity.barracuda": "1.3.0-preview",
+        "com.unity.barracuda": "1.3.1-preview",
         "com.unity.modules.imageconversion": "1.0.0",
         "com.unity.modules.jsonserialize": "1.0.0",
         "com.unity.modules.physics": "1.0.0",
@@ -121,7 +121,7 @@
       "depth": 0,
       "source": "local",
       "dependencies": {
-        "com.unity.ml-agents": "1.7.2-preview"
+        "com.unity.ml-agents": "1.8.0-preview"
       }
     },
     "com.unity.multiplayer-hlapi": {

Project/Assets/ML-Agents/Editor/Tests/SampleExporter.cs

@@ -0,0 +1,125 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using Newtonsoft.Json;
+using UnityEditor;
+using UnityEngine;
+
+namespace Unity.MLAgents
+{
+    public class SampleExporter
+    {
+        const string k_MLAgentsSampleFile = "mlagents-sample.json";
+        const string k_PackageSampleFile = ".sample.json";
+        const string k_MLAgentsDir = "ML-Agents";
+        const string k_MLAgentsExamplesDir = "Examples";
+        const string k_MLAgentsPackageName = "com.unity.ml-agents";
+        const string k_MLAgentsSamplesDirName = "Samples";
+        const string k_MLAgentsScriptsDirName = "Scripts";
+
+        struct MLAgentsSampleJson
+        {
+#pragma warning disable 649
+            public string displayName;
+            public string description;
+            // ReSharper disable once CollectionNeverUpdated.Local
+            public List<string> scenes;
+#pragma warning restore 649
+        }
+
+        struct PackageSampleJson
+        {
+            public string displayName;
+            public string description;
+        }
+
+        public static void ExportCuratedSamples()
+        {
+            var oldBurst = EditorPrefs.GetBool("BurstCompilation");
+            EditorPrefs.SetBool("BurstCompilation", false);
+            try
+            {
+                // Path to Project/Assets
+                var assetsDir = Application.dataPath;
+                var repoRoot = Directory.GetParent(Directory.GetParent(assetsDir).FullName).FullName;
+
+                // Top level of where to store the samples
+                var samplesDir = Path.Combine(
+                    repoRoot,
+                    k_MLAgentsPackageName,
+                    k_MLAgentsSamplesDirName);
+
+                if (!Directory.Exists(samplesDir))
+                {
+                    Directory.CreateDirectory(samplesDir);
+                }
+
+                // Path to the examples dir in the project
+                var examplesDir = Path.Combine(Application.dataPath, k_MLAgentsDir, k_MLAgentsExamplesDir);
+                foreach (var exampleDirectory in Directory.GetDirectories(examplesDir))
+                {
+                    var mlAgentsSamplePath = Path.Combine(exampleDirectory, k_MLAgentsSampleFile);
+                    if (File.Exists(mlAgentsSamplePath))
+                    {
+                        var sampleJson = JsonConvert.DeserializeObject<MLAgentsSampleJson>(File.ReadAllText(mlAgentsSamplePath));
+                        Debug.Log(JsonConvert.SerializeObject(sampleJson));
+                        foreach (var scene in sampleJson.scenes)
+                        {
+                            var scenePath = Path.Combine(exampleDirectory, scene);
+                            if (File.Exists(scenePath))
+                            {
+                                // Create a Sample Directory
+                                var currentSampleDir = Directory.CreateDirectory(Path.Combine(samplesDir,
+                                    Path.GetFileNameWithoutExtension(scenePath)));
+
+
+                                var scriptsPath = Path.Combine(exampleDirectory, k_MLAgentsScriptsDirName);
+                                Debug.Log($"Scene Path: {scenePath}");
+                                var assets = new List<string> { scenePath.Substring(scenePath.IndexOf("Assets")) };
+                                if (!Directory.Exists(Path.Combine(scriptsPath)))
+                                {
+                                    scriptsPath = exampleDirectory;
+                                }
+
+                                scriptsPath = scriptsPath.Substring(scriptsPath.IndexOf("Assets"));
+                                foreach (var guid in AssetDatabase.FindAssets("t:Script", new[] { scriptsPath }))
+                                {
+                                    var path = AssetDatabase.GUIDToAssetPath(guid);
+                                    assets.Add(path);
+                                    Debug.Log($"Adding Asset: {path}");
+                                }
+
+                                var packageFilePath = Path.GetFileNameWithoutExtension(scenePath) + ".unitypackage";
+                                AssetDatabase.ExportPackage(assets.ToArray(),
+                                    Path.Combine(Application.dataPath, packageFilePath),
+                                    ExportPackageOptions.IncludeDependencies | ExportPackageOptions.Recurse);
+
+                                // Move the .unitypackage into the samples folder.
+                                var packageFileFullPath = Path.Combine(Application.dataPath, packageFilePath);
+
+                                var packageInSamplePath = Path.Combine(currentSampleDir.FullName, packageFilePath);
+                                Debug.Log($"Moving {packageFileFullPath} to {packageInSamplePath}");
+                                File.Move(packageFileFullPath, packageInSamplePath);
+
+                                // write the .sample.json file to the sample directory
+                                File.WriteAllText(Path.Combine(currentSampleDir.FullName, k_PackageSampleFile),
+                                    JsonConvert.SerializeObject(new PackageSampleJson
+                                    {
+                                        description = sampleJson.description,
+                                        displayName = sampleJson.displayName
+                                    }));
+                            }
+                        }
+                    }
+                }
+            }
+            catch (Exception e)
+            {
+                Debug.Log(e);
+                EditorApplication.Exit(1);
+            }
+            EditorPrefs.SetBool("BurstCompilation", oldBurst);
+            EditorApplication.Exit(0);
+        }
+    }
+}

Project/Assets/ML-Agents/Examples/3DBall/mlagents-sample.json

@@ -0,0 +1,7 @@
+{
+  "displayName": "3D Ball",
+  "description": "The 3D Ball sample is a simple environment that is a great for jumping into Ml-Agents to see how things work.",
+  "scenes": [
+      "Scenes/3DBall.unity"
+    ]
+}