Merge pull request #2648 from Unity-Technologies/release-0.10.0

Release 0.10.0

Author: Ervin T

.circleci/config.yml

@@ -1,19 +1,40 @@
-version: 2.0
-
-jobs:
-  build:
+version: 2.1
+executors:
+  python361:
     docker:
       - image: circleci/python:3.6.1
+  python373:
+    docker:
+      - image: circleci/python:3.7.3
+
+jobs:
+  build_python:
+    parameters:
+      executor:
+        type: executor
+      pyversion:
+        type: string
+        description: python version to being used (currently only affects caching).
+      pip_constraints:
+        type: string
+        description: Constraints file that is passed to "pip install". We constraint older versions of libraries for older python runtime, in order to help ensure compatibility.
+    executor: << parameters.executor >>
     working_directory: ~/repo
 
     steps:
       - checkout
 
+      - run:
+          # Combine all the python dependencies into one file so that we can use that for the cache checksum
+          name: Combine pip dependencies for caching
+          command: cat ml-agents/setup.py ml-agents-envs/setup.py gym-unity/setup.py test_requirements.txt << parameters.pip_constraints >> > python_deps.txt
+
       - restore_cache:
           keys:
-          - v1-dependencies-{{ checksum "ml-agents/setup.py" }}
+          # Parameterize the cache so that different python versions can get different versions of the packages
+          - v1-dependencies-py<< parameters.pyversion >>-{{ checksum "python_deps.txt" }}
           # fallback to using the latest cache if no exact match is found
-          - v1-dependencies-
+          - v1-dependencies-py<< parameters.pyversion >>-
 
       - run:
           name: Install Dependencies
@@ -22,22 +43,24 @@ jobs:
             . venv/bin/activate
             pip install --upgrade pip
             pip install --upgrade setuptools
-            cd ml-agents-envs && pip install -e .
-            cd ../ml-agents && pip install -e .
-            pip install pre-commit pytest-cov==2.6.1
-            cd ../gym-unity && pip install -e .
+            pip install --progress-bar=off -e ./ml-agents-envs -c << parameters.pip_constraints >>
+            pip install --progress-bar=off -e ./ml-agents -c << parameters.pip_constraints >>
+            pip install --progress-bar=off -r test_requirements.txt -c << parameters.pip_constraints >>
+            pip install --progress-bar=off -e ./gym-unity -c << parameters.pip_constraints >>
 
       - save_cache:
           paths:
             - ./venv
-          key: v1-dependencies-{{ checksum "ml-agents/setup.py" }}
+          key: v1-dependencies-py<< parameters.pyversion >>-{{ checksum "python_deps.txt" }}
 
       - run:
           name: Run Tests for ml-agents and gym_unity
+          # This also dumps the installed pip packages to a file, so we can see what versions are actually being used.
           command: |
             . venv/bin/activate
             mkdir test-reports
-            pytest --cov=mlagents --cov-report xml --junitxml=test-reports/junit.xml -p no:warnings
+            pip freeze > test-reports/pip_versions.txt
+            pytest --cov=ml-agents --cov=ml-agents-envs --cov=gym-unity --cov-report html --junitxml=test-reports/junit.xml -p no:warnings
 
       - run:
           name: Check Code Style using pre-commit
@@ -58,3 +81,59 @@ jobs:
       - store_artifacts:
           path: test-reports
           destination: test-reports
+
+      - store_artifacts:
+          path: htmlcov
+          destination: htmlcov
+
+
+  markdown_link_check:
+    docker:
+      - image: circleci/node:12.6.0
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      - restore_cache:
+          keys:
+          - v1-node-dependencies-{{ checksum ".pre-commit-config.yaml" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-node-dependencies-
+
+      - run:
+          name: Install Dependencies
+          command: |
+            sudo apt-get install python3-venv
+            python3 -m venv venv
+            . venv/bin/activate
+            pip install pre-commit
+      - run: sudo npm install -g markdown-link-check
+
+      - save_cache:
+          paths:
+            - ./venv
+          key: v1-node-dependencies-{{ checksum ".pre-commit-config.yaml" }}
+
+      - run:
+          name: Run markdown-link-check via precommit
+          command: |
+            . venv/bin/activate
+            pre-commit run --hook-stage manual markdown-link-check --all-files
+
+workflows:
+  workflow:
+    jobs:
+      - build_python:
+          name: python_3.6.1
+          executor: python361
+          pyversion: 3.6.1
+          # Test python 3.6 with the oldest supported versions
+          pip_constraints: test_constraints_min_version.txt
+      - build_python:
+          name: python_3.7.3
+          executor: python373
+          pyversion: 3.7.3
+          # Test python 3.7 with the newest supported versions
+          pip_constraints: test_constraints_max_version.txt
+      - markdown_link_check

.gitignore

@@ -102,3 +102,5 @@ venv/
 
 # Code coverage report
 .coverage
+coverage.xml
+/htmlcov/

.pre-commit-config.yaml

@@ -15,8 +15,7 @@ repos:
         files: "ml-agents-envs/.*"
         # Exclude protobuf files and don't follow them when imported
         exclude: ".*_pb2.py"
-        # TODO get disallow-incomplete-defs working
-        args: [--ignore-missing-imports, --follow-imports=silent]
+        args: [--ignore-missing-imports, --disallow-incomplete-defs]
     -   id: mypy
         name: mypy-gym-unity
         files: "gym-unity/.*"
@@ -37,3 +36,18 @@ repos:
                 .*_pb2.py|
                 .*_pb2_grpc.py
             )$
+# "Local" hooks, see https://pre-commit.com/#repository-local-hooks
+-   repo: local
+    hooks:
+    -   id: markdown-link-check
+        name: markdown-link-check
+        # markdown-link-check doesn't support multiple files on the commandline, so this hacks around that.
+        # Note that you must install the package separately via npm. For example:
+        #  brew install npm; npm install -g markdown-link-check
+        entry: bash -xc 'echo "$@" | xargs -n1 -t markdown-link-check -c markdown-link-check.config.json' --
+        language: system
+        types: [markdown]
+        # Don't check localized files since their target might not be localized.
+        exclude: ".*localized.*"
+        # Only run manually, e.g. pre-commit run --hook-stage manual markdown-link-check
+        stages: [manual]

README.md

@@ -25,6 +25,7 @@ developer communities.
 
 * Unity environment control from Python
 * 10+ sample Unity environments
+* Two deep reinforcement learning algorithms, [Proximal Policy Optimization](docs/Training-PPO.md) (PPO) and [Soft Actor-Critic](docs/Training-SAC.md) (SAC)
 * Support for multiple environment configurations and training scenarios
 * Train memory-enhanced agents using deep reinforcement learning
 * Easily definable Curriculum Learning and Generalization scenarios

UnitySDK/Assets/ML-Agents/Editor/AgentEditor.cs

@@ -1,4 +1,4 @@
-using UnityEngine;
+using UnityEngine;
 using UnityEditor;
 
 namespace MLAgents
@@ -11,39 +11,38 @@ This code is meant to modify the behavior of the inspector on Brain Components.
     [CanEditMultipleObjects]
     public class AgentEditor : Editor
     {
-
         public override void OnInspectorGUI()
         {
-            SerializedObject serializedAgent = serializedObject;
+            var serializedAgent = serializedObject;
             serializedAgent.Update();
 
-            SerializedProperty brain = serializedAgent.FindProperty("brain");
-            SerializedProperty actionsPerDecision = serializedAgent.FindProperty(
+            var brain = serializedAgent.FindProperty("brain");
+            var actionsPerDecision = serializedAgent.FindProperty(
                 "agentParameters.numberOfActionsBetweenDecisions");
-            SerializedProperty maxSteps = serializedAgent.FindProperty(
+            var maxSteps = serializedAgent.FindProperty(
                 "agentParameters.maxStep");
-            SerializedProperty isResetOnDone = serializedAgent.FindProperty(
+            var isResetOnDone = serializedAgent.FindProperty(
                 "agentParameters.resetOnDone");
-            SerializedProperty isODD = serializedAgent.FindProperty(
+            var isOdd = serializedAgent.FindProperty(
                 "agentParameters.onDemandDecision");
-            SerializedProperty cameras = serializedAgent.FindProperty(
+            var cameras = serializedAgent.FindProperty(
                 "agentParameters.agentCameras");
-            SerializedProperty renderTextures = serializedAgent.FindProperty(
+            var renderTextures = serializedAgent.FindProperty(
                 "agentParameters.agentRenderTextures");
 
             EditorGUILayout.PropertyField(brain);
 
             if (cameras.arraySize > 0 && renderTextures.arraySize > 0)
             {
-                EditorGUILayout.HelpBox("Brain visual observations created by first getting all cameras then all render textures.", MessageType.Info);    
+                EditorGUILayout.HelpBox("Brain visual observations created by first getting all cameras then all render textures.", MessageType.Info);
             }
-            
+
             EditorGUILayout.LabelField("Agent Cameras");
-            for (int i = 0; i < cameras.arraySize; i++)
+            for (var i = 0; i < cameras.arraySize; i++)
             {
                 EditorGUILayout.PropertyField(
                     cameras.GetArrayElementAtIndex(i),
-                    new GUIContent("Camera " + (i + 1).ToString() + ": "));
+                    new GUIContent("Camera " + (i + 1) + ": "));
             }
 
             EditorGUILayout.BeginHorizontal();
@@ -58,13 +57,13 @@ public override void OnInspectorGUI()
             }
 
             EditorGUILayout.EndHorizontal();
-            
+
             EditorGUILayout.LabelField("Agent RenderTextures");
-            for (int i = 0; i < renderTextures.arraySize; i++)
+            for (var i = 0; i < renderTextures.arraySize; i++)
             {
                 EditorGUILayout.PropertyField(
                     renderTextures.GetArrayElementAtIndex(i),
-                    new GUIContent("RenderTexture " + (i + 1).ToString() + ": "));
+                    new GUIContent("RenderTexture " + (i + 1) + ": "));
             }
 
             EditorGUILayout.BeginHorizontal();
@@ -91,11 +90,11 @@ public override void OnInspectorGUI()
                     "Reset On Done",
                     "If checked, the agent will reset on done. Else, AgentOnDone() will be called."));
             EditorGUILayout.PropertyField(
-                isODD,
+                isOdd,
                 new GUIContent(
                     "On Demand Decisions",
                     "If checked, you must manually request decisions."));
-            if (!isODD.boolValue)
+            if (!isOdd.boolValue)
             {
                 EditorGUILayout.PropertyField(
                     actionsPerDecision,

UnitySDK/Assets/ML-Agents/Editor/BrainEditor.cs

@@ -1,4 +1,4 @@
-using UnityEngine;
+using UnityEngine;
 using UnityEditor;
 
 
@@ -11,10 +11,10 @@ namespace MLAgents
     /// </summary>
     [CustomEditor(typeof(Brain))]
     public class BrainEditor : Editor
-    {        
+    {
         public override void OnInspectorGUI()
         {
-            var brain = (Brain) target;
+            var brain = (Brain)target;
             var brainToCopy = EditorGUILayout.ObjectField(
                 "Copy Brain Parameters from : ", null, typeof(Brain), false) as Brain;
             if (brainToCopy != null)
@@ -25,10 +25,10 @@ public override void OnInspectorGUI()
                 return;
             }
             var serializedBrain = serializedObject;
-            serializedBrain.Update(); 
+            serializedBrain.Update();
             EditorGUILayout.PropertyField(serializedBrain.FindProperty("brainParameters"), true);
             serializedBrain.ApplyModifiedProperties();
-            
+
             // Draws a horizontal thick line
             EditorGUILayout.LabelField("", GUI.skin.horizontalSlider);
         }