From b26aeb2f37fbdc5011a902236916cabaebfb3553 Mon Sep 17 00:00:00 2001 From: Christopher Goy Date: Wed, 12 Feb 2020 12:14:04 -0800 Subject: [PATCH 1/9] Make a serialization upgrade path for maxStep and add tests. --- Project/Assets/ML-Agents/Tests.meta | 8 + .../ML-Agents/Tests/SerializationTest.cs | 43 +++ .../ML-Agents/Tests/SerializationTest.cs.meta | 11 + .../Assets/ML-Agents/Tests/SerializeAgent.cs | 12 + .../ML-Agents/Tests/SerializeAgent.cs.meta | 11 + .../ML-Agents/Tests/SerializeTestScene.unity | 335 ++++++++++++++++++ .../Tests/SerializeTestScene.unity.meta | 7 + Project/Assets/ML-Agents/Tests/Tests.asmdef | 16 + .../Assets/ML-Agents/Tests/Tests.asmdef.meta | 7 + .../ProjectSettings/EditorBuildSettings.asset | 5 +- com.unity.ml-agents/Runtime/Agent.cs | 50 ++- 11 files changed, 502 insertions(+), 3 deletions(-) create mode 100644 Project/Assets/ML-Agents/Tests.meta create mode 100644 Project/Assets/ML-Agents/Tests/SerializationTest.cs create mode 100644 Project/Assets/ML-Agents/Tests/SerializationTest.cs.meta create mode 100644 Project/Assets/ML-Agents/Tests/SerializeAgent.cs create mode 100644 Project/Assets/ML-Agents/Tests/SerializeAgent.cs.meta create mode 100644 Project/Assets/ML-Agents/Tests/SerializeTestScene.unity create mode 100644 Project/Assets/ML-Agents/Tests/SerializeTestScene.unity.meta create mode 100644 Project/Assets/ML-Agents/Tests/Tests.asmdef create mode 100644 Project/Assets/ML-Agents/Tests/Tests.asmdef.meta diff --git a/Project/Assets/ML-Agents/Tests.meta b/Project/Assets/ML-Agents/Tests.meta new file mode 100644 index 0000000000..cea91658c8 --- /dev/null +++ b/Project/Assets/ML-Agents/Tests.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: a3ca140b4ab3d4468aa121ec54842223 +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Project/Assets/ML-Agents/Tests/SerializationTest.cs b/Project/Assets/ML-Agents/Tests/SerializationTest.cs new file mode 100644 index 0000000000..56f4049754 --- /dev/null +++ b/Project/Assets/ML-Agents/Tests/SerializationTest.cs @@ -0,0 +1,43 @@ +using System.Collections; +using System.Collections.Generic; +using NUnit.Framework; +using UnityEngine; +using UnityEngine.SceneManagement; +using UnityEngine.TestTools; + +namespace Tests +{ + public class SerializationTest + { + + [SetUp] + public void Setup() + { + SceneManager.LoadScene("SerializeTestScene"); + } + + /// + /// Test that the serialized agent in the scene, which has its agent parameter value serialized, + /// properly deserializes it to Agent.maxStep. + /// + [Test] + public void SerializationTestSimplePasses() + { + // Use the Assert class to test conditions + var gameObjects = SceneManager.GetActiveScene().GetRootGameObjects(); + GameObject agent = null; + foreach (var go in gameObjects) + { + if (go.name == "Agent") + { + agent = go; + break; + } + } + Assert.NotNull(agent); + var agentComponent = agent.GetComponent(); + Assert.True(agentComponent.maxStep == 5000); + + } + } +} diff --git a/Project/Assets/ML-Agents/Tests/SerializationTest.cs.meta b/Project/Assets/ML-Agents/Tests/SerializationTest.cs.meta new file mode 100644 index 0000000000..4cbef6b2de --- /dev/null +++ b/Project/Assets/ML-Agents/Tests/SerializationTest.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: b5fdc828cbbf94a4d9422065d6743d81 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Project/Assets/ML-Agents/Tests/SerializeAgent.cs b/Project/Assets/ML-Agents/Tests/SerializeAgent.cs new file mode 100644 index 0000000000..a5eda42954 --- /dev/null +++ b/Project/Assets/ML-Agents/Tests/SerializeAgent.cs @@ -0,0 +1,12 @@ +using System.Collections; +using System.Collections.Generic; +using UnityEngine; +using MLAgents; + +public class SerializeAgent : Agent +{ + public override float[] Heuristic() + { + return new[] {0f}; + } +} diff --git a/Project/Assets/ML-Agents/Tests/SerializeAgent.cs.meta b/Project/Assets/ML-Agents/Tests/SerializeAgent.cs.meta new file mode 100644 index 0000000000..087fd6691c --- /dev/null +++ b/Project/Assets/ML-Agents/Tests/SerializeAgent.cs.meta @@ -0,0 +1,11 @@ +fileFormatVersion: 2 +guid: c3d607733e457478885f15ee89725709 +MonoImporter: + externalObjects: {} + serializedVersion: 2 + defaultReferences: [] + executionOrder: 0 + icon: {instanceID: 0} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Project/Assets/ML-Agents/Tests/SerializeTestScene.unity b/Project/Assets/ML-Agents/Tests/SerializeTestScene.unity new file mode 100644 index 0000000000..31ef9c534a --- /dev/null +++ b/Project/Assets/ML-Agents/Tests/SerializeTestScene.unity @@ -0,0 +1,335 @@ +%YAML 1.1 +%TAG !u! tag:unity3d.com,2011: +--- !u!29 &1 +OcclusionCullingSettings: + m_ObjectHideFlags: 0 + serializedVersion: 2 + m_OcclusionBakeSettings: + smallestOccluder: 5 + smallestHole: 0.25 + backfaceThreshold: 100 + m_SceneGUID: 00000000000000000000000000000000 + m_OcclusionCullingData: {fileID: 0} +--- !u!104 &2 +RenderSettings: + m_ObjectHideFlags: 0 + serializedVersion: 9 + m_Fog: 0 + m_FogColor: {r: 0.5, g: 0.5, b: 0.5, a: 1} + m_FogMode: 3 + m_FogDensity: 0.01 + m_LinearFogStart: 0 + m_LinearFogEnd: 300 + m_AmbientSkyColor: {r: 0.212, g: 0.227, b: 0.259, a: 1} + m_AmbientEquatorColor: {r: 0.114, g: 0.125, b: 0.133, a: 1} + m_AmbientGroundColor: {r: 0.047, g: 0.043, b: 0.035, a: 1} + m_AmbientIntensity: 1 + m_AmbientMode: 0 + m_SubtractiveShadowColor: {r: 0.42, g: 0.478, b: 0.627, a: 1} + m_SkyboxMaterial: {fileID: 10304, guid: 0000000000000000f000000000000000, type: 0} + m_HaloStrength: 0.5 + m_FlareStrength: 1 + m_FlareFadeSpeed: 3 + m_HaloTexture: {fileID: 0} + m_SpotCookie: {fileID: 10001, guid: 0000000000000000e000000000000000, type: 0} + m_DefaultReflectionMode: 0 + m_DefaultReflectionResolution: 128 + m_ReflectionBounces: 1 + m_ReflectionIntensity: 1 + m_CustomReflection: {fileID: 0} + m_Sun: {fileID: 0} + m_IndirectSpecularColor: {r: 0.44657898, g: 0.49641287, b: 0.5748173, a: 1} + m_UseRadianceAmbientProbe: 0 +--- !u!157 &3 +LightmapSettings: + m_ObjectHideFlags: 0 + serializedVersion: 11 + m_GIWorkflowMode: 0 + m_GISettings: + serializedVersion: 2 + m_BounceScale: 1 + m_IndirectOutputScale: 1 + m_AlbedoBoost: 1 + m_EnvironmentLightingMode: 0 + m_EnableBakedLightmaps: 1 + m_EnableRealtimeLightmaps: 1 + m_LightmapEditorSettings: + serializedVersion: 10 + m_Resolution: 2 + m_BakeResolution: 40 + m_AtlasSize: 1024 + m_AO: 0 + m_AOMaxDistance: 1 + m_CompAOExponent: 1 + m_CompAOExponentDirect: 0 + m_Padding: 2 + m_LightmapParameters: {fileID: 0} + m_LightmapsBakeMode: 1 + m_TextureCompression: 1 + m_FinalGather: 0 + m_FinalGatherFiltering: 1 + m_FinalGatherRayCount: 256 + m_ReflectionCompression: 2 + m_MixedBakeMode: 2 + m_BakeBackend: 1 + m_PVRSampling: 1 + m_PVRDirectSampleCount: 32 + m_PVRSampleCount: 500 + m_PVRBounces: 2 + m_PVRFilterTypeDirect: 0 + m_PVRFilterTypeIndirect: 0 + m_PVRFilterTypeAO: 0 + m_PVRFilteringMode: 1 + m_PVRCulling: 1 + m_PVRFilteringGaussRadiusDirect: 1 + m_PVRFilteringGaussRadiusIndirect: 5 + m_PVRFilteringGaussRadiusAO: 2 + m_PVRFilteringAtrousPositionSigmaDirect: 0.5 + m_PVRFilteringAtrousPositionSigmaIndirect: 2 + m_PVRFilteringAtrousPositionSigmaAO: 1 + m_ShowResolutionOverlay: 1 + m_LightingDataAsset: {fileID: 0} + m_UseShadowmask: 1 +--- !u!196 &4 +NavMeshSettings: + serializedVersion: 2 + m_ObjectHideFlags: 0 + m_BuildSettings: + serializedVersion: 2 + agentTypeID: 0 + agentRadius: 0.5 + agentHeight: 2 + agentSlope: 45 + agentClimb: 0.4 + ledgeDropHeight: 0 + maxJumpAcrossDistance: 0 + minRegionArea: 2 + manualCellSize: 0 + cellSize: 0.16666667 + manualTileSize: 0 + tileSize: 256 + accuratePlacement: 0 + debug: + m_Flags: 0 + m_NavMeshData: {fileID: 0} +--- !u!1 &106586301 +GameObject: + m_ObjectHideFlags: 0 + m_CorrespondingSourceObject: {fileID: 0} + m_PrefabInstance: {fileID: 0} + m_PrefabAsset: {fileID: 0} + serializedVersion: 6 + m_Component: + - component: {fileID: 106586304} + - component: {fileID: 106586303} + - component: {fileID: 106586302} + m_Layer: 0 + m_Name: Agent + m_TagString: Untagged + m_Icon: {fileID: 0} + m_NavMeshLayer: 0 + m_StaticEditorFlags: 0 + m_IsActive: 1 +--- !u!114 &106586302 +MonoBehaviour: + m_ObjectHideFlags: 0 + m_CorrespondingSourceObject: {fileID: 0} + m_PrefabInstance: {fileID: 0} + m_PrefabAsset: {fileID: 0} + m_GameObject: {fileID: 106586301} + m_Enabled: 1 + m_EditorHideFlags: 0 + m_Script: {fileID: 11500000, guid: c3d607733e457478885f15ee89725709, type: 3} + m_Name: + m_EditorClassIdentifier: + agentParameters: + maxStep: 5000 +--- !u!114 &106586303 +MonoBehaviour: + m_ObjectHideFlags: 0 + m_CorrespondingSourceObject: {fileID: 0} + m_PrefabInstance: {fileID: 0} + m_PrefabAsset: {fileID: 0} + m_GameObject: {fileID: 106586301} + m_Enabled: 1 + m_EditorHideFlags: 0 + m_Script: {fileID: 11500000, guid: 5d1c4e0b1822b495aa52bc52839ecb30, type: 3} + m_Name: + m_EditorClassIdentifier: + m_BrainParameters: + vectorObservationSize: 1 + numStackedVectorObservations: 1 + vectorActionSize: 01000000 + vectorActionDescriptions: [] + vectorActionSpaceType: 0 + m_Model: {fileID: 0} + m_InferenceDevice: 0 + m_BehaviorType: 0 + m_BehaviorName: My Behavior + m_TeamID: 0 + m_UseChildSensors: 1 +--- !u!4 &106586304 +Transform: + m_ObjectHideFlags: 0 + m_CorrespondingSourceObject: {fileID: 0} + m_PrefabInstance: {fileID: 0} + m_PrefabAsset: {fileID: 0} + m_GameObject: {fileID: 106586301} + m_LocalRotation: {x: 0, y: 0, z: 0, w: 1} + m_LocalPosition: {x: 0, y: 0, z: 0} + m_LocalScale: {x: 1, y: 1, z: 1} + m_Children: [] + m_Father: {fileID: 0} + m_RootOrder: 2 + m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0} +--- !u!1 &185701317 +GameObject: + m_ObjectHideFlags: 0 + m_CorrespondingSourceObject: {fileID: 0} + m_PrefabInstance: {fileID: 0} + m_PrefabAsset: {fileID: 0} + serializedVersion: 6 + m_Component: + - component: {fileID: 185701319} + - component: {fileID: 185701318} + m_Layer: 0 + m_Name: Directional Light + m_TagString: Untagged + m_Icon: {fileID: 0} + m_NavMeshLayer: 0 + m_StaticEditorFlags: 0 + m_IsActive: 1 +--- !u!108 &185701318 +Light: + m_ObjectHideFlags: 0 + m_CorrespondingSourceObject: {fileID: 0} + m_PrefabInstance: {fileID: 0} + m_PrefabAsset: {fileID: 0} + m_GameObject: {fileID: 185701317} + m_Enabled: 1 + serializedVersion: 8 + m_Type: 1 + m_Color: {r: 1, g: 0.95686275, b: 0.8392157, a: 1} + m_Intensity: 1 + m_Range: 10 + m_SpotAngle: 30 + m_CookieSize: 10 + m_Shadows: + m_Type: 2 + m_Resolution: -1 + m_CustomResolution: -1 + m_Strength: 1 + m_Bias: 0.05 + m_NormalBias: 0.4 + m_NearPlane: 0.2 + m_Cookie: {fileID: 0} + m_DrawHalo: 0 + m_Flare: {fileID: 0} + m_RenderMode: 0 + m_CullingMask: + serializedVersion: 2 + m_Bits: 4294967295 + m_Lightmapping: 4 + m_LightShadowCasterMode: 0 + m_AreaSize: {x: 1, y: 1} + m_BounceIntensity: 1 + m_ColorTemperature: 6570 + m_UseColorTemperature: 0 + m_ShadowRadius: 0 + m_ShadowAngle: 0 +--- !u!4 &185701319 +Transform: + m_ObjectHideFlags: 0 + m_CorrespondingSourceObject: {fileID: 0} + m_PrefabInstance: {fileID: 0} + m_PrefabAsset: {fileID: 0} + m_GameObject: {fileID: 185701317} + m_LocalRotation: {x: 0.40821788, y: -0.23456968, z: 0.10938163, w: 0.8754261} + m_LocalPosition: {x: 0, y: 3, z: 0} + m_LocalScale: {x: 1, y: 1, z: 1} + m_Children: [] + m_Father: {fileID: 0} + m_RootOrder: 1 + m_LocalEulerAnglesHint: {x: 50, y: -30, z: 0} +--- !u!1 &804630118 +GameObject: + m_ObjectHideFlags: 0 + m_CorrespondingSourceObject: {fileID: 0} + m_PrefabInstance: {fileID: 0} + m_PrefabAsset: {fileID: 0} + serializedVersion: 6 + m_Component: + - component: {fileID: 804630121} + - component: {fileID: 804630120} + - component: {fileID: 804630119} + m_Layer: 0 + m_Name: Main Camera + m_TagString: MainCamera + m_Icon: {fileID: 0} + m_NavMeshLayer: 0 + m_StaticEditorFlags: 0 + m_IsActive: 1 +--- !u!81 &804630119 +AudioListener: + m_ObjectHideFlags: 0 + m_CorrespondingSourceObject: {fileID: 0} + m_PrefabInstance: {fileID: 0} + m_PrefabAsset: {fileID: 0} + m_GameObject: {fileID: 804630118} + m_Enabled: 1 +--- !u!20 &804630120 +Camera: + m_ObjectHideFlags: 0 + m_CorrespondingSourceObject: {fileID: 0} + m_PrefabInstance: {fileID: 0} + m_PrefabAsset: {fileID: 0} + m_GameObject: {fileID: 804630118} + m_Enabled: 1 + serializedVersion: 2 + m_ClearFlags: 1 + m_BackGroundColor: {r: 0.19215687, g: 0.3019608, b: 0.4745098, a: 0} + m_projectionMatrixMode: 1 + m_SensorSize: {x: 36, y: 24} + m_LensShift: {x: 0, y: 0} + m_GateFitMode: 2 + m_FocalLength: 50 + m_NormalizedViewPortRect: + serializedVersion: 2 + x: 0 + y: 0 + width: 1 + height: 1 + near clip plane: 0.3 + far clip plane: 1000 + field of view: 60 + orthographic: 0 + orthographic size: 5 + m_Depth: -1 + m_CullingMask: + serializedVersion: 2 + m_Bits: 4294967295 + m_RenderingPath: -1 + m_TargetTexture: {fileID: 0} + m_TargetDisplay: 0 + m_TargetEye: 3 + m_HDR: 1 + m_AllowMSAA: 1 + m_AllowDynamicResolution: 0 + m_ForceIntoRT: 0 + m_OcclusionCulling: 1 + m_StereoConvergence: 10 + m_StereoSeparation: 0.022 +--- !u!4 &804630121 +Transform: + m_ObjectHideFlags: 0 + m_CorrespondingSourceObject: {fileID: 0} + m_PrefabInstance: {fileID: 0} + m_PrefabAsset: {fileID: 0} + m_GameObject: {fileID: 804630118} + m_LocalRotation: {x: 0, y: 0, z: 0, w: 1} + m_LocalPosition: {x: 0, y: 1, z: -10} + m_LocalScale: {x: 1, y: 1, z: 1} + m_Children: [] + m_Father: {fileID: 0} + m_RootOrder: 0 + m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0} diff --git a/Project/Assets/ML-Agents/Tests/SerializeTestScene.unity.meta b/Project/Assets/ML-Agents/Tests/SerializeTestScene.unity.meta new file mode 100644 index 0000000000..5b95bd43f8 --- /dev/null +++ b/Project/Assets/ML-Agents/Tests/SerializeTestScene.unity.meta @@ -0,0 +1,7 @@ +fileFormatVersion: 2 +guid: 60783bd849bd242eeb66243542762b23 +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Project/Assets/ML-Agents/Tests/Tests.asmdef b/Project/Assets/ML-Agents/Tests/Tests.asmdef new file mode 100644 index 0000000000..e918d04d3b --- /dev/null +++ b/Project/Assets/ML-Agents/Tests/Tests.asmdef @@ -0,0 +1,16 @@ +{ + "name": "Tests", + "references": [ + "Unity.ML-Agents" + ], + "optionalUnityReferences": [ + "TestAssemblies" + ], + "includePlatforms": [], + "excludePlatforms": [], + "allowUnsafeCode": false, + "overrideReferences": false, + "precompiledReferences": [], + "autoReferenced": true, + "defineConstraints": [] +} \ No newline at end of file diff --git a/Project/Assets/ML-Agents/Tests/Tests.asmdef.meta b/Project/Assets/ML-Agents/Tests/Tests.asmdef.meta new file mode 100644 index 0000000000..14ee4e9ceb --- /dev/null +++ b/Project/Assets/ML-Agents/Tests/Tests.asmdef.meta @@ -0,0 +1,7 @@ +fileFormatVersion: 2 +guid: 721e0c090039045bb963f33c81d699a7 +AssemblyDefinitionImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Project/ProjectSettings/EditorBuildSettings.asset b/Project/ProjectSettings/EditorBuildSettings.asset index 0147887ef4..925369de74 100644 --- a/Project/ProjectSettings/EditorBuildSettings.asset +++ b/Project/ProjectSettings/EditorBuildSettings.asset @@ -4,5 +4,8 @@ EditorBuildSettings: m_ObjectHideFlags: 0 serializedVersion: 2 - m_Scenes: [] + m_Scenes: + - enabled: 1 + path: Assets/ML-Agents/Tests/SerializeTestScene.unity + guid: 60783bd849bd242eeb66243542762b23 m_configObjects: {} diff --git a/com.unity.ml-agents/Runtime/Agent.cs b/com.unity.ml-agents/Runtime/Agent.cs index 7c9b4b0405..43eb327baf 100644 --- a/com.unity.ml-agents/Runtime/Agent.cs +++ b/com.unity.ml-agents/Runtime/Agent.cs @@ -2,6 +2,7 @@ using System.Collections.Generic; using UnityEngine; using Barracuda; +using UnityEditor; using UnityEngine.Serialization; namespace MLAgents @@ -105,11 +106,26 @@ internal struct AgentAction "docs/Learning-Environment-Design-Agents.md")] [Serializable] [RequireComponent(typeof(BehaviorParameters))] - public abstract class Agent : MonoBehaviour + public abstract class Agent : MonoBehaviour, ISerializationCallbackReceiver { IPolicy m_Brain; BehaviorParameters m_PolicyFactory; + /// This code is here to make the upgrade path for users using maxStep + /// easier. We will hook into the Serialization code and make sure that + /// agentParameters.maxStep and this.maxStep are in sync. + [Serializable] + internal struct AgentParameters + { + public int maxStep; + } + + [SerializeField] [HideInInspector] + internal AgentParameters agentParameters; + [SerializeField] [HideInInspector] + internal bool hasUpgradedFromAgentParameters; + bool m_MarkDirtFromUpgrade; + /// /// The maximum number of steps the agent takes before being done. /// @@ -186,6 +202,37 @@ void OnEnable() LazyInitialize(); } + + public void OnBeforeSerialize() + { + if (maxStep != agentParameters.maxStep && !hasUpgradedFromAgentParameters) + { + maxStep = agentParameters.maxStep; + m_MarkDirtFromUpgrade = true; + } + } + + public void OnAfterDeserialize() + { + if (maxStep != agentParameters.maxStep && !hasUpgradedFromAgentParameters) + { + Debug.Log("Upgrading from agentParameters.maxStep to this.maxStep. Please save your project to keep these changes"); + maxStep = agentParameters.maxStep; + hasUpgradedFromAgentParameters = true; + m_MarkDirtFromUpgrade = true; + } + } + +#if UNITY_EDITOR + void Awake() + { + if (m_MarkDirtFromUpgrade) + { + EditorUtility.SetDirty(this); + } + } +#endif + /// Helper method for the event, created to /// facilitate testing. public void LazyInitialize() @@ -214,7 +261,6 @@ public void LazyInitialize() ResetData(); InitializeAgent(); InitializeSensors(); - } /// Monobehavior function that is called when the attached GameObject From 7f39cfbee0c6ca62ef7f72ca55431fff1b0333c8 Mon Sep 17 00:00:00 2001 From: Christopher Goy Date: Wed, 12 Feb 2020 13:08:27 -0800 Subject: [PATCH 2/9] Move runtime tests to the package. --- Project/ProjectSettings/EditorBuildSettings.asset | 2 +- com.unity.ml-agents/Tests/Runtime.meta | 8 ++++++++ .../Tests/Runtime}/SerializationTest.cs | 0 .../Tests/Runtime}/SerializationTest.cs.meta | 0 .../Tests/Runtime}/SerializeAgent.cs | 0 .../Tests/Runtime}/SerializeAgent.cs.meta | 0 .../Tests/Runtime}/SerializeTestScene.unity | 0 .../Tests/Runtime}/SerializeTestScene.unity.meta | 0 .../Tests/Runtime/Unity.ML-Agents.Runtime.Tests.asmdef | 2 +- .../Runtime/Unity.ML-Agents.Runtime.Tests.asmdef.meta | 0 10 files changed, 10 insertions(+), 2 deletions(-) create mode 100644 com.unity.ml-agents/Tests/Runtime.meta rename {Project/Assets/ML-Agents/Tests => com.unity.ml-agents/Tests/Runtime}/SerializationTest.cs (100%) rename {Project/Assets/ML-Agents/Tests => com.unity.ml-agents/Tests/Runtime}/SerializationTest.cs.meta (100%) rename {Project/Assets/ML-Agents/Tests => com.unity.ml-agents/Tests/Runtime}/SerializeAgent.cs (100%) rename {Project/Assets/ML-Agents/Tests => com.unity.ml-agents/Tests/Runtime}/SerializeAgent.cs.meta (100%) rename {Project/Assets/ML-Agents/Tests => com.unity.ml-agents/Tests/Runtime}/SerializeTestScene.unity (100%) rename {Project/Assets/ML-Agents/Tests => com.unity.ml-agents/Tests/Runtime}/SerializeTestScene.unity.meta (100%) rename Project/Assets/ML-Agents/Tests/Tests.asmdef => com.unity.ml-agents/Tests/Runtime/Unity.ML-Agents.Runtime.Tests.asmdef (87%) rename Project/Assets/ML-Agents/Tests/Tests.asmdef.meta => com.unity.ml-agents/Tests/Runtime/Unity.ML-Agents.Runtime.Tests.asmdef.meta (100%) diff --git a/Project/ProjectSettings/EditorBuildSettings.asset b/Project/ProjectSettings/EditorBuildSettings.asset index 925369de74..0ceab313b5 100644 --- a/Project/ProjectSettings/EditorBuildSettings.asset +++ b/Project/ProjectSettings/EditorBuildSettings.asset @@ -6,6 +6,6 @@ EditorBuildSettings: serializedVersion: 2 m_Scenes: - enabled: 1 - path: Assets/ML-Agents/Tests/SerializeTestScene.unity + path: Packages/com.unity.ml-agents/tests/runtime/serializetestscene.unity guid: 60783bd849bd242eeb66243542762b23 m_configObjects: {} diff --git a/com.unity.ml-agents/Tests/Runtime.meta b/com.unity.ml-agents/Tests/Runtime.meta new file mode 100644 index 0000000000..1260b3a158 --- /dev/null +++ b/com.unity.ml-agents/Tests/Runtime.meta @@ -0,0 +1,8 @@ +fileFormatVersion: 2 +guid: fec0f6b603d3046f086e09ea2a44ed1f +folderAsset: yes +DefaultImporter: + externalObjects: {} + userData: + assetBundleName: + assetBundleVariant: diff --git a/Project/Assets/ML-Agents/Tests/SerializationTest.cs b/com.unity.ml-agents/Tests/Runtime/SerializationTest.cs similarity index 100% rename from Project/Assets/ML-Agents/Tests/SerializationTest.cs rename to com.unity.ml-agents/Tests/Runtime/SerializationTest.cs diff --git a/Project/Assets/ML-Agents/Tests/SerializationTest.cs.meta b/com.unity.ml-agents/Tests/Runtime/SerializationTest.cs.meta similarity index 100% rename from Project/Assets/ML-Agents/Tests/SerializationTest.cs.meta rename to com.unity.ml-agents/Tests/Runtime/SerializationTest.cs.meta diff --git a/Project/Assets/ML-Agents/Tests/SerializeAgent.cs b/com.unity.ml-agents/Tests/Runtime/SerializeAgent.cs similarity index 100% rename from Project/Assets/ML-Agents/Tests/SerializeAgent.cs rename to com.unity.ml-agents/Tests/Runtime/SerializeAgent.cs diff --git a/Project/Assets/ML-Agents/Tests/SerializeAgent.cs.meta b/com.unity.ml-agents/Tests/Runtime/SerializeAgent.cs.meta similarity index 100% rename from Project/Assets/ML-Agents/Tests/SerializeAgent.cs.meta rename to com.unity.ml-agents/Tests/Runtime/SerializeAgent.cs.meta diff --git a/Project/Assets/ML-Agents/Tests/SerializeTestScene.unity b/com.unity.ml-agents/Tests/Runtime/SerializeTestScene.unity similarity index 100% rename from Project/Assets/ML-Agents/Tests/SerializeTestScene.unity rename to com.unity.ml-agents/Tests/Runtime/SerializeTestScene.unity diff --git a/Project/Assets/ML-Agents/Tests/SerializeTestScene.unity.meta b/com.unity.ml-agents/Tests/Runtime/SerializeTestScene.unity.meta similarity index 100% rename from Project/Assets/ML-Agents/Tests/SerializeTestScene.unity.meta rename to com.unity.ml-agents/Tests/Runtime/SerializeTestScene.unity.meta diff --git a/Project/Assets/ML-Agents/Tests/Tests.asmdef b/com.unity.ml-agents/Tests/Runtime/Unity.ML-Agents.Runtime.Tests.asmdef similarity index 87% rename from Project/Assets/ML-Agents/Tests/Tests.asmdef rename to com.unity.ml-agents/Tests/Runtime/Unity.ML-Agents.Runtime.Tests.asmdef index e918d04d3b..2c394fe410 100644 --- a/Project/Assets/ML-Agents/Tests/Tests.asmdef +++ b/com.unity.ml-agents/Tests/Runtime/Unity.ML-Agents.Runtime.Tests.asmdef @@ -1,5 +1,5 @@ { - "name": "Tests", + "name": "Unity.ML-Agents.Runtime.Tests", "references": [ "Unity.ML-Agents" ], diff --git a/Project/Assets/ML-Agents/Tests/Tests.asmdef.meta b/com.unity.ml-agents/Tests/Runtime/Unity.ML-Agents.Runtime.Tests.asmdef.meta similarity index 100% rename from Project/Assets/ML-Agents/Tests/Tests.asmdef.meta rename to com.unity.ml-agents/Tests/Runtime/Unity.ML-Agents.Runtime.Tests.asmdef.meta From 2af660eff905229f84cdfb5eccb04fe065233a5a Mon Sep 17 00:00:00 2001 From: Christopher Goy Date: Wed, 12 Feb 2020 13:26:47 -0800 Subject: [PATCH 3/9] Wait for scene to be loaded. --- Project/Assets/ML-Agents/Tests.meta | 8 -------- Project/ProjectSettings/EditorBuildSettings.asset | 2 +- .../Tests/Runtime/SerializationTest.cs | 12 +++++++++--- 3 files changed, 10 insertions(+), 12 deletions(-) delete mode 100644 Project/Assets/ML-Agents/Tests.meta diff --git a/Project/Assets/ML-Agents/Tests.meta b/Project/Assets/ML-Agents/Tests.meta deleted file mode 100644 index cea91658c8..0000000000 --- a/Project/Assets/ML-Agents/Tests.meta +++ /dev/null @@ -1,8 +0,0 @@ -fileFormatVersion: 2 -guid: a3ca140b4ab3d4468aa121ec54842223 -folderAsset: yes -DefaultImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/Project/ProjectSettings/EditorBuildSettings.asset b/Project/ProjectSettings/EditorBuildSettings.asset index 0ceab313b5..f2f30aa527 100644 --- a/Project/ProjectSettings/EditorBuildSettings.asset +++ b/Project/ProjectSettings/EditorBuildSettings.asset @@ -6,6 +6,6 @@ EditorBuildSettings: serializedVersion: 2 m_Scenes: - enabled: 1 - path: Packages/com.unity.ml-agents/tests/runtime/serializetestscene.unity + path: Packages/com.unity.ml-agents/Tests/Runtime/SerializeTestScene.unity guid: 60783bd849bd242eeb66243542762b23 m_configObjects: {} diff --git a/com.unity.ml-agents/Tests/Runtime/SerializationTest.cs b/com.unity.ml-agents/Tests/Runtime/SerializationTest.cs index 56f4049754..1a62f7c440 100644 --- a/com.unity.ml-agents/Tests/Runtime/SerializationTest.cs +++ b/com.unity.ml-agents/Tests/Runtime/SerializationTest.cs @@ -7,6 +7,7 @@ namespace Tests { + [TestFixture] public class SerializationTest { @@ -15,16 +16,21 @@ public void Setup() { SceneManager.LoadScene("SerializeTestScene"); } - + /// /// Test that the serialized agent in the scene, which has its agent parameter value serialized, /// properly deserializes it to Agent.maxStep. /// - [Test] - public void SerializationTestSimplePasses() + [UnityTest] + public IEnumerator SerializationTestSimplePasses() { // Use the Assert class to test conditions var gameObjects = SceneManager.GetActiveScene().GetRootGameObjects(); + if (SceneManager.GetActiveScene().name != "SerializeTestScene") + { + yield return null; + } + GameObject agent = null; foreach (var go in gameObjects) { From 9ab1f5982c388c97ebaddb66edb99fcc58129cca Mon Sep 17 00:00:00 2001 From: Christopher Goy Date: Wed, 12 Feb 2020 15:14:49 -0800 Subject: [PATCH 4/9] Remove log and dirty markers. --- com.unity.ml-agents/Runtime/Agent.cs | 14 -------------- 1 file changed, 14 deletions(-) diff --git a/com.unity.ml-agents/Runtime/Agent.cs b/com.unity.ml-agents/Runtime/Agent.cs index 43eb327baf..3bc09ff4a2 100644 --- a/com.unity.ml-agents/Runtime/Agent.cs +++ b/com.unity.ml-agents/Runtime/Agent.cs @@ -124,7 +124,6 @@ [SerializeField] [HideInInspector] internal AgentParameters agentParameters; [SerializeField] [HideInInspector] internal bool hasUpgradedFromAgentParameters; - bool m_MarkDirtFromUpgrade; /// /// The maximum number of steps the agent takes before being done. @@ -208,7 +207,6 @@ public void OnBeforeSerialize() if (maxStep != agentParameters.maxStep && !hasUpgradedFromAgentParameters) { maxStep = agentParameters.maxStep; - m_MarkDirtFromUpgrade = true; } } @@ -216,23 +214,11 @@ public void OnAfterDeserialize() { if (maxStep != agentParameters.maxStep && !hasUpgradedFromAgentParameters) { - Debug.Log("Upgrading from agentParameters.maxStep to this.maxStep. Please save your project to keep these changes"); maxStep = agentParameters.maxStep; hasUpgradedFromAgentParameters = true; - m_MarkDirtFromUpgrade = true; } } -#if UNITY_EDITOR - void Awake() - { - if (m_MarkDirtFromUpgrade) - { - EditorUtility.SetDirty(this); - } - } -#endif - /// Helper method for the event, created to /// facilitate testing. public void LazyInitialize() From 76d9da3b6afa4c2896e04dd34866e2e297a5ed4d Mon Sep 17 00:00:00 2001 From: Christopher Goy Date: Wed, 12 Feb 2020 15:52:45 -0800 Subject: [PATCH 5/9] Check if maxstep was 0 before upgrading. --- com.unity.ml-agents/Runtime/Agent.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/com.unity.ml-agents/Runtime/Agent.cs b/com.unity.ml-agents/Runtime/Agent.cs index 3bc09ff4a2..ec78ddb9ab 100644 --- a/com.unity.ml-agents/Runtime/Agent.cs +++ b/com.unity.ml-agents/Runtime/Agent.cs @@ -204,7 +204,7 @@ void OnEnable() public void OnBeforeSerialize() { - if (maxStep != agentParameters.maxStep && !hasUpgradedFromAgentParameters) + if (maxStep == 0 && maxStep != agentParameters.maxStep && !hasUpgradedFromAgentParameters) { maxStep = agentParameters.maxStep; } @@ -212,7 +212,7 @@ public void OnBeforeSerialize() public void OnAfterDeserialize() { - if (maxStep != agentParameters.maxStep && !hasUpgradedFromAgentParameters) + if (maxStep == 0 && maxStep != agentParameters.maxStep && !hasUpgradedFromAgentParameters) { maxStep = agentParameters.maxStep; hasUpgradedFromAgentParameters = true; From 0643f1a325d2e88d55a99c5697025c14061de0f9 Mon Sep 17 00:00:00 2001 From: Christopher Goy Date: Wed, 12 Feb 2020 15:53:56 -0800 Subject: [PATCH 6/9] Always set the upgrade flag in serialization callbacks. --- com.unity.ml-agents/Runtime/Agent.cs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/com.unity.ml-agents/Runtime/Agent.cs b/com.unity.ml-agents/Runtime/Agent.cs index ec78ddb9ab..b85f88031a 100644 --- a/com.unity.ml-agents/Runtime/Agent.cs +++ b/com.unity.ml-agents/Runtime/Agent.cs @@ -207,7 +207,9 @@ public void OnBeforeSerialize() if (maxStep == 0 && maxStep != agentParameters.maxStep && !hasUpgradedFromAgentParameters) { maxStep = agentParameters.maxStep; + } + hasUpgradedFromAgentParameters = true; } public void OnAfterDeserialize() @@ -215,8 +217,8 @@ public void OnAfterDeserialize() if (maxStep == 0 && maxStep != agentParameters.maxStep && !hasUpgradedFromAgentParameters) { maxStep = agentParameters.maxStep; - hasUpgradedFromAgentParameters = true; } + hasUpgradedFromAgentParameters = true; } /// Helper method for the event, created to From dff252611200add3f40e89bd1253b9084428f589 Mon Sep 17 00:00:00 2001 From: Christopher Goy Date: Thu, 13 Feb 2020 09:23:39 -0800 Subject: [PATCH 7/9] add a cube for good measure. --- .../Tests/Runtime/SerializeTestScene.unity | 96 ++++++++++++++++++- 1 file changed, 95 insertions(+), 1 deletion(-) diff --git a/com.unity.ml-agents/Tests/Runtime/SerializeTestScene.unity b/com.unity.ml-agents/Tests/Runtime/SerializeTestScene.unity index 31ef9c534a..954c52ce66 100644 --- a/com.unity.ml-agents/Tests/Runtime/SerializeTestScene.unity +++ b/com.unity.ml-agents/Tests/Runtime/SerializeTestScene.unity @@ -144,6 +144,8 @@ MonoBehaviour: m_EditorClassIdentifier: agentParameters: maxStep: 5000 + hasUpgradedFromAgentParameters: 1 + maxStep: 5000 --- !u!114 &106586303 MonoBehaviour: m_ObjectHideFlags: 0 @@ -178,7 +180,8 @@ Transform: m_LocalRotation: {x: 0, y: 0, z: 0, w: 1} m_LocalPosition: {x: 0, y: 0, z: 0} m_LocalScale: {x: 1, y: 1, z: 1} - m_Children: [] + m_Children: + - {fileID: 1471486645} m_Father: {fileID: 0} m_RootOrder: 2 m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0} @@ -333,3 +336,94 @@ Transform: m_Father: {fileID: 0} m_RootOrder: 0 m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0} +--- !u!1 &1471486644 +GameObject: + m_ObjectHideFlags: 0 + m_CorrespondingSourceObject: {fileID: 0} + m_PrefabInstance: {fileID: 0} + m_PrefabAsset: {fileID: 0} + serializedVersion: 6 + m_Component: + - component: {fileID: 1471486645} + - component: {fileID: 1471486648} + - component: {fileID: 1471486647} + - component: {fileID: 1471486646} + m_Layer: 0 + m_Name: Cube + m_TagString: Untagged + m_Icon: {fileID: 0} + m_NavMeshLayer: 0 + m_StaticEditorFlags: 0 + m_IsActive: 1 +--- !u!4 &1471486645 +Transform: + m_ObjectHideFlags: 0 + m_CorrespondingSourceObject: {fileID: 0} + m_PrefabInstance: {fileID: 0} + m_PrefabAsset: {fileID: 0} + m_GameObject: {fileID: 1471486644} + m_LocalRotation: {x: 0, y: 0, z: 0, w: 1} + m_LocalPosition: {x: 0, y: 0, z: 0} + m_LocalScale: {x: 1, y: 1, z: 1} + m_Children: [] + m_Father: {fileID: 106586304} + m_RootOrder: 0 + m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0} +--- !u!65 &1471486646 +BoxCollider: + m_ObjectHideFlags: 0 + m_CorrespondingSourceObject: {fileID: 0} + m_PrefabInstance: {fileID: 0} + m_PrefabAsset: {fileID: 0} + m_GameObject: {fileID: 1471486644} + m_Material: {fileID: 0} + m_IsTrigger: 0 + m_Enabled: 1 + serializedVersion: 2 + m_Size: {x: 1, y: 1, z: 1} + m_Center: {x: 0, y: 0, z: 0} +--- !u!23 &1471486647 +MeshRenderer: + m_ObjectHideFlags: 0 + m_CorrespondingSourceObject: {fileID: 0} + m_PrefabInstance: {fileID: 0} + m_PrefabAsset: {fileID: 0} + m_GameObject: {fileID: 1471486644} + m_Enabled: 1 + m_CastShadows: 1 + m_ReceiveShadows: 1 + m_DynamicOccludee: 1 + m_MotionVectors: 1 + m_LightProbeUsage: 1 + m_ReflectionProbeUsage: 1 + m_RenderingLayerMask: 1 + m_RendererPriority: 0 + m_Materials: + - {fileID: 10303, guid: 0000000000000000f000000000000000, type: 0} + m_StaticBatchInfo: + firstSubMesh: 0 + subMeshCount: 0 + m_StaticBatchRoot: {fileID: 0} + m_ProbeAnchor: {fileID: 0} + m_LightProbeVolumeOverride: {fileID: 0} + m_ScaleInLightmap: 1 + m_PreserveUVs: 0 + m_IgnoreNormalsForChartDetection: 0 + m_ImportantGI: 0 + m_StitchLightmapSeams: 0 + m_SelectedEditorRenderState: 3 + m_MinimumChartSize: 4 + m_AutoUVMaxDistance: 0.5 + m_AutoUVMaxAngle: 89 + m_LightmapParameters: {fileID: 0} + m_SortingLayerID: 0 + m_SortingLayer: 0 + m_SortingOrder: 0 +--- !u!33 &1471486648 +MeshFilter: + m_ObjectHideFlags: 0 + m_CorrespondingSourceObject: {fileID: 0} + m_PrefabInstance: {fileID: 0} + m_PrefabAsset: {fileID: 0} + m_GameObject: {fileID: 1471486644} + m_Mesh: {fileID: 10202, guid: 0000000000000000e000000000000000, type: 0} From b8f967bb0e35fe168860e175eaf03ce9b98c06ce Mon Sep 17 00:00:00 2001 From: Christopher Goy Date: Thu, 13 Feb 2020 10:01:21 -0800 Subject: [PATCH 8/9] Use virtualized package path for scene. --- com.unity.ml-agents/Tests/Runtime/SerializationTest.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/com.unity.ml-agents/Tests/Runtime/SerializationTest.cs b/com.unity.ml-agents/Tests/Runtime/SerializationTest.cs index 1a62f7c440..c5c6e1338d 100644 --- a/com.unity.ml-agents/Tests/Runtime/SerializationTest.cs +++ b/com.unity.ml-agents/Tests/Runtime/SerializationTest.cs @@ -14,7 +14,7 @@ public class SerializationTest [SetUp] public void Setup() { - SceneManager.LoadScene("SerializeTestScene"); + SceneManager.LoadScene("Packages/com.unity.ml-agents/Tests/Runtime/SerializeTestScene"); } /// From ce8c8a5912a9891a6ade0bc0abbe42729701c1ee Mon Sep 17 00:00:00 2001 From: Christopher Goy Date: Thu, 13 Feb 2020 12:03:02 -0800 Subject: [PATCH 9/9] Comment out test since the framework we need to modify the build settings is only for 2019.2 and later. --- .../Tests/Runtime/SerializationTest.cs | 100 +++++++++--------- 1 file changed, 51 insertions(+), 49 deletions(-) diff --git a/com.unity.ml-agents/Tests/Runtime/SerializationTest.cs b/com.unity.ml-agents/Tests/Runtime/SerializationTest.cs index c5c6e1338d..0ce156adf5 100644 --- a/com.unity.ml-agents/Tests/Runtime/SerializationTest.cs +++ b/com.unity.ml-agents/Tests/Runtime/SerializationTest.cs @@ -1,49 +1,51 @@ -using System.Collections; -using System.Collections.Generic; -using NUnit.Framework; -using UnityEngine; -using UnityEngine.SceneManagement; -using UnityEngine.TestTools; - -namespace Tests -{ - [TestFixture] - public class SerializationTest - { - - [SetUp] - public void Setup() - { - SceneManager.LoadScene("Packages/com.unity.ml-agents/Tests/Runtime/SerializeTestScene"); - } - - /// - /// Test that the serialized agent in the scene, which has its agent parameter value serialized, - /// properly deserializes it to Agent.maxStep. - /// - [UnityTest] - public IEnumerator SerializationTestSimplePasses() - { - // Use the Assert class to test conditions - var gameObjects = SceneManager.GetActiveScene().GetRootGameObjects(); - if (SceneManager.GetActiveScene().name != "SerializeTestScene") - { - yield return null; - } - - GameObject agent = null; - foreach (var go in gameObjects) - { - if (go.name == "Agent") - { - agent = go; - break; - } - } - Assert.NotNull(agent); - var agentComponent = agent.GetComponent(); - Assert.True(agentComponent.maxStep == 5000); - - } - } -} +// using System.Collections; +// using NUnit.Framework; +// #if UNITY_EDITOR +// using UnityEditor.SceneManagement; +// using UnityEngine.TestTools; +// #endif +// using UnityEngine; +// using UnityEngine.SceneManagement; +// +// namespace Tests +// { +// [TestFixture] +// public class SerializationTest +// { +// +// [SetUp] +// public void Setup() +// { +// SceneManager.LoadScene("Packages/com.unity.ml-agents/Tests/Runtime/SerializeTestScene"); +// } +// +// /// +// /// Test that the serialized agent in the scene, which has its agent parameter value serialized, +// /// properly deserializes it to Agent.maxStep. +// /// +// [UnityTest] +// public IEnumerator SerializationTestSimplePasses() +// { +// // Use the Assert class to test conditions +// var gameObjects = SceneManager.GetActiveScene().GetRootGameObjects(); +// if (SceneManager.GetActiveScene().name != "SerializeTestScene") +// { +// yield return null; +// } +// +// GameObject agent = null; +// foreach (var go in gameObjects) +// { +// if (go.name == "Agent") +// { +// agent = go; +// break; +// } +// } +// Assert.NotNull(agent); +// var agentComponent = agent.GetComponent(); +// Assert.True(agentComponent.maxStep == 5000); +// +// } +// } +// }