diff --git a/README.md b/README.md index 2e23195beb..3986a898d2 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # Unity ML-Agents Toolkit -[![docs badge](https://img.shields.io/badge/docs-reference-blue.svg)](https://github.com/Unity-Technologies/ml-agents/tree/release_1_docs/docs/) +[![docs badge](https://img.shields.io/badge/docs-reference-blue.svg)](https://github.com/Unity-Technologies/ml-agents/tree/release_2_docs/docs/) [![license badge](https://img.shields.io/badge/license-Apache--2.0-green.svg)](LICENSE) @@ -48,8 +48,8 @@ descriptions of all these features. ## Releases & Documentation -**Our latest, stable release is `Release 1`. Click -[here](https://github.com/Unity-Technologies/ml-agents/tree/release_1/docs/Readme.md) +**Our latest, stable release is `Release 2`. Click +[here](https://github.com/Unity-Technologies/ml-agents/tree/release_2_docs/docs/Readme.md) to get started with the latest release of ML-Agents.** The table below lists all our releases, including our `master` branch which is @@ -67,16 +67,14 @@ under active development and may be unstable. A few helpful guidelines: | **Version** | **Release Date** | **Source** | **Documentation** | **Download** | |:-------:|:------:|:-------------:|:-------:|:------------:| | **master (unstable)** | -- | [source](https://github.com/Unity-Technologies/ml-agents/tree/master) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/master/docs/Readme.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/master.zip) | -| **Release 1** | **April 30, 2020** | **[source](https://github.com/Unity-Technologies/ml-agents/tree/release_1)** | **[docs](https://github.com/Unity-Technologies/ml-agents/tree/release_1/docs/Readme.md)** | **[download](https://github.com/Unity-Technologies/ml-agents/archive/release_1.zip)** | +| **Release 2** | **May 20, 2020** | **[source](https://github.com/Unity-Technologies/ml-agents/tree/release_2)** | **[docs](https://github.com/Unity-Technologies/ml-agents/tree/release_2/docs/Readme.md)** | **[download](https://github.com/Unity-Technologies/ml-agents/archive/release_2.zip)** | +| **Release 1** | April 30, 2020 | [source](https://github.com/Unity-Technologies/ml-agents/tree/release_1) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/release_1/docs/Readme.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/release_1.zip) | | **0.15.1** | March 30, 2020 | [source](https://github.com/Unity-Technologies/ml-agents/tree/0.15.1) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/0.15.1/docs/Readme.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/0.15.1.zip) | | **0.15.0** | March 18, 2020 | [source](https://github.com/Unity-Technologies/ml-agents/tree/0.15.0) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/0.15.0/docs/Readme.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/0.15.0.zip) | | **0.14.1** | February 26, 2020 | [source](https://github.com/Unity-Technologies/ml-agents/tree/0.14.1) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/0.14.1/docs/Readme.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/0.14.1.zip) | | **0.14.0** | February 13, 2020 | [source](https://github.com/Unity-Technologies/ml-agents/tree/0.14.0) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/0.14.0/docs/Readme.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/0.14.0.zip) | | **0.13.1** | January 21, 2020 | [source](https://github.com/Unity-Technologies/ml-agents/tree/0.13.1) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/0.13.1/docs/Readme.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/0.13.1.zip) | | **0.13.0** | January 8, 2020 | [source](https://github.com/Unity-Technologies/ml-agents/tree/0.13.0) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/0.13.0/docs/Readme.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/0.13.0.zip) | -| **0.12.1** | December 11, 2019 | [source](https://github.com/Unity-Technologies/ml-agents/tree/0.12.1) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/0.12.1/docs/Readme.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/0.12.1.zip) | -| **0.12.0** | December 2, 2019 | [source](https://github.com/Unity-Technologies/ml-agents/tree/0.12.0) | [docs](https://github.com/Unity-Technologies/ml-agents/tree/0.12.0/docs/Readme.md) | [download](https://github.com/Unity-Technologies/ml-agents/archive/0.12.0.zip) | - ## Citation If you are a researcher interested in a discussion of Unity as an AI platform, diff --git a/com.unity.ml-agents/CHANGELOG.md b/com.unity.ml-agents/CHANGELOG.md index aedad0a8ff..8c4f465952 100755 --- a/com.unity.ml-agents/CHANGELOG.md +++ b/com.unity.ml-agents/CHANGELOG.md @@ -27,14 +27,30 @@ and this project adheres to - Unity Player logs are now written out to the results directory. (#3877) - Run configuration YAML files are written out to the results directory at the end of the run. (#3815) ### Bug Fixes -- An issue was fixed where using `--initialize-from` would resume from the past step count. (#3962) #### com.unity.ml-agents (C#) #### ml-agents / ml-agents-envs / gym-unity (Python) -## [1.0.0-preview] - 2020-04-30 -### Major Changes +## [1.0.2-preview] - 2020-05-20 +### Bug Fixes +#### com.unity.ml-agents (C#) +- Fix missing .meta file + + +## [1.0.1-preview] - 2020-05-19 +### Bug Fixes +#### com.unity.ml-agents (C#) +- A bug that would cause the editor to go into a loop when a prefab was selected was fixed. (#3949) +- BrainParameters.ToProto() no longer throws an exception if none of the fields have been set. (#3930) +- The Barracuda dependency was upgraded to 0.7.1-preview. (#3977) +#### ml-agents / ml-agents-envs / gym-unity (Python) +- An issue was fixed where using `--initialize-from` would resume from the past step count. (#3962) +- The gym wrapper error for the wrong number of agents now fires more consistently, and more details + were added to the error message when the input dimension is wrong. (#3963) + +## [1.0.0-preview] - 2020-04-30 +### Major Changes #### com.unity.ml-agents (C#) - The `MLAgents` C# namespace was renamed to `Unity.MLAgents`, and other nested diff --git a/com.unity.ml-agents/Documentation~/com.unity.ml-agents.md b/com.unity.ml-agents/Documentation~/com.unity.ml-agents.md index 4188ec0fcd..7528ac8e98 100755 --- a/com.unity.ml-agents/Documentation~/com.unity.ml-agents.md +++ b/com.unity.ml-agents/Documentation~/com.unity.ml-agents.md @@ -114,7 +114,7 @@ a number of ways to [connect with us] including our [ML-Agents Forum]. [unity ML-Agents Toolkit]: https://github.com/Unity-Technologies/ml-agents [unity inference engine]: https://docs.unity3d.com/Packages/com.unity.barracuda@latest/index.html [package manager documentation]: https://docs.unity3d.com/Manual/upm-ui-install.html -[installation instructions]: https://github.com/Unity-Technologies/ml-agents/blob/release_1_docs/docs/Installation.md +[installation instructions]: https://github.com/Unity-Technologies/ml-agents/blob/release_2_docs/docs/Installation.md [github repository]: https://github.com/Unity-Technologies/ml-agents [python package]: https://github.com/Unity-Technologies/ml-agents [execution order of event functions]: https://docs.unity3d.com/Manual/ExecutionOrder.html diff --git a/com.unity.ml-agents/Runtime/Academy.cs b/com.unity.ml-agents/Runtime/Academy.cs index e682a55ee0..7a90b11b61 100644 --- a/com.unity.ml-agents/Runtime/Academy.cs +++ b/com.unity.ml-agents/Runtime/Academy.cs @@ -19,7 +19,7 @@ * API. For more information on each of these entities, in addition to how to * set-up a learning environment and train the behavior of characters in a * Unity scene, please browse our documentation pages on GitHub: - * https://github.com/Unity-Technologies/ml-agents/tree/release_1_docs/docs/ + * https://github.com/Unity-Technologies/ml-agents/tree/release_2_docs/docs/ */ namespace Unity.MLAgents @@ -51,7 +51,7 @@ void FixedUpdate() /// fall back to inference or heuristic decisions. (You can also set agents to always use /// inference or heuristics.) /// - [HelpURL("https://github.com/Unity-Technologies/ml-agents/tree/release_1_docs/" + + [HelpURL("https://github.com/Unity-Technologies/ml-agents/tree/release_2_docs/" + "docs/Learning-Environment-Design.md")] public class Academy : IDisposable { @@ -68,7 +68,7 @@ public class Academy : IDisposable /// Unity package version of com.unity.ml-agents. /// This must match the version string in package.json and is checked in a unit test. /// - internal const string k_PackageVersion = "1.0.0-preview"; + internal const string k_PackageVersion = "1.0.2-preview"; const int k_EditorTrainingPort = 5004; diff --git a/com.unity.ml-agents/Runtime/Agent.cs b/com.unity.ml-agents/Runtime/Agent.cs index 501e9c589b..815a7bd917 100644 --- a/com.unity.ml-agents/Runtime/Agent.cs +++ b/com.unity.ml-agents/Runtime/Agent.cs @@ -145,13 +145,13 @@ internal struct AgentAction /// [OnDisable()]: https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnDisable.html] /// [OnBeforeSerialize()]: https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnBeforeSerialize.html /// [OnAfterSerialize()]: https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnAfterSerialize.html - /// [Agents]: https://github.com/Unity-Technologies/ml-agents/blob/release_1_docs/docs/Learning-Environment-Design-Agents.md - /// [Reinforcement Learning in Unity]: https://github.com/Unity-Technologies/ml-agents/blob/release_1_docs/docs/Learning-Environment-Design.md + /// [Agents]: https://github.com/Unity-Technologies/ml-agents/blob/release_2_docs/docs/Learning-Environment-Design-Agents.md + /// [Reinforcement Learning in Unity]: https://github.com/Unity-Technologies/ml-agents/blob/release_2_docs/docs/Learning-Environment-Design.md /// [Unity ML-Agents Toolkit]: https://github.com/Unity-Technologies/ml-agents - /// [Unity ML-Agents Toolkit manual]: https://github.com/Unity-Technologies/ml-agents/blob/release_1_docs/docs/Readme.md + /// [Unity ML-Agents Toolkit manual]: https://github.com/Unity-Technologies/ml-agents/blob/release_2_docs/docs/Readme.md /// /// - [HelpURL("https://github.com/Unity-Technologies/ml-agents/blob/release_1_docs/" + + [HelpURL("https://github.com/Unity-Technologies/ml-agents/blob/release_2_docs/" + "docs/Learning-Environment-Design-Agents.md")] [Serializable] [RequireComponent(typeof(BehaviorParameters))] @@ -603,8 +603,8 @@ public int CompletedEpisodes /// for information about mixing reward signals from curiosity and Generative Adversarial /// Imitation Learning (GAIL) with rewards supplied through this method. /// - /// [Agents - Rewards]: https://github.com/Unity-Technologies/ml-agents/blob/release_1_docs/docs/Learning-Environment-Design-Agents.md#rewards - /// [Reward Signals]: https://github.com/Unity-Technologies/ml-agents/blob/release_1_docs/docs/ML-Agents-Overview.md#a-quick-note-on-reward-signals + /// [Agents - Rewards]: https://github.com/Unity-Technologies/ml-agents/blob/release_2_docs/docs/Learning-Environment-Design-Agents.md#rewards + /// [Reward Signals]: https://github.com/Unity-Technologies/ml-agents/blob/release_2_docs/docs/ML-Agents-Overview.md#a-quick-note-on-reward-signals /// /// The new value of the reward. public void SetReward(float reward) @@ -633,8 +633,8 @@ public void SetReward(float reward) /// for information about mixing reward signals from curiosity and Generative Adversarial /// Imitation Learning (GAIL) with rewards supplied through this method. /// - /// [Agents - Rewards]: https://github.com/Unity-Technologies/ml-agents/blob/release_1_docs/docs/Learning-Environment-Design-Agents.md#rewards - /// [Reward Signals]: https://github.com/Unity-Technologies/ml-agents/blob/release_1_docs/docs/ML-Agents-Overview.md#a-quick-note-on-reward-signals + /// [Agents - Rewards]: https://github.com/Unity-Technologies/ml-agents/blob/release_2_docs/docs/Learning-Environment-Design-Agents.md#rewards + /// [Reward Signals]: https://github.com/Unity-Technologies/ml-agents/blob/release_2_docs/docs/ML-Agents-Overview.md#a-quick-note-on-reward-signals /// /// Incremental reward value. public void AddReward(float increment) @@ -786,8 +786,8 @@ public virtual void Initialize() {} /// implementing a simple heuristic function can aid in debugging agent actions and interactions /// with its environment. /// - /// [Demonstration Recorder]: https://github.com/Unity-Technologies/ml-agents/blob/release_1_docs/docs/Learning-Environment-Design-Agents.md#recording-demonstrations - /// [Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_1_docs/docs/Learning-Environment-Design-Agents.md#actions + /// [Demonstration Recorder]: https://github.com/Unity-Technologies/ml-agents/blob/release_2_docs/docs/Learning-Environment-Design-Agents.md#recording-demonstrations + /// [Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_2_docs/docs/Learning-Environment-Design-Agents.md#actions /// [GameObject]: https://docs.unity3d.com/Manual/GameObjects.html /// /// @@ -989,7 +989,7 @@ void ResetSensors() /// For more information about observations, see [Observations and Sensors]. /// /// [GameObject]: https://docs.unity3d.com/Manual/GameObjects.html - /// [Observations and Sensors]: https://github.com/Unity-Technologies/ml-agents/blob/release_1_docs/docs/Learning-Environment-Design-Agents.md#observations-and-sensors + /// [Observations and Sensors]: https://github.com/Unity-Technologies/ml-agents/blob/release_2_docs/docs/Learning-Environment-Design-Agents.md#observations-and-sensors /// public virtual void CollectObservations(VectorSensor sensor) { @@ -1020,7 +1020,7 @@ public ReadOnlyCollection GetObservations() /// /// See [Agents - Actions] for more information on masking actions. /// - /// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_1_docs/docs/Learning-Environment-Design-Agents.md#actions + /// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_2_docs/docs/Learning-Environment-Design-Agents.md#actions /// /// public virtual void CollectDiscreteActionMasks(DiscreteActionMasker actionMasker) @@ -1090,7 +1090,7 @@ public virtual void CollectDiscreteActionMasks(DiscreteActionMasker actionMasker /// /// For more information about implementing agent actions see [Agents - Actions]. /// - /// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_1_docs/docs/Learning-Environment-Design-Agents.md#actions + /// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_2_docs/docs/Learning-Environment-Design-Agents.md#actions /// /// /// An array containing the action vector. The length of the array is specified diff --git a/com.unity.ml-agents/Runtime/Demonstrations/DemonstrationRecorder.cs b/com.unity.ml-agents/Runtime/Demonstrations/DemonstrationRecorder.cs index e7deca57af..d75c821c86 100644 --- a/com.unity.ml-agents/Runtime/Demonstrations/DemonstrationRecorder.cs +++ b/com.unity.ml-agents/Runtime/Demonstrations/DemonstrationRecorder.cs @@ -19,7 +19,7 @@ namespace Unity.MLAgents.Demonstrations /// See [Imitation Learning - Recording Demonstrations] for more information. /// /// [GameObject]: https://docs.unity3d.com/Manual/GameObjects.html - /// [Imitation Learning - Recording Demonstrations]: https://github.com/Unity-Technologies/ml-agents/blob/release_1_docs/docs//Learning-Environment-Design-Agents.md#recording-demonstrations + /// [Imitation Learning - Recording Demonstrations]: https://github.com/Unity-Technologies/ml-agents/blob/release_2_docs/docs//Learning-Environment-Design-Agents.md#recording-demonstrations /// [RequireComponent(typeof(Agent))] [AddComponentMenu("ML Agents/Demonstration Recorder", (int)MenuGroup.Default)] diff --git a/com.unity.ml-agents/Runtime/DiscreteActionMasker.cs b/com.unity.ml-agents/Runtime/DiscreteActionMasker.cs index 58643b2571..5fe8d5c35b 100644 --- a/com.unity.ml-agents/Runtime/DiscreteActionMasker.cs +++ b/com.unity.ml-agents/Runtime/DiscreteActionMasker.cs @@ -40,7 +40,7 @@ internal DiscreteActionMasker(BrainParameters brainParameters) /// /// See [Agents - Actions] for more information on masking actions. /// - /// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_1_docs/docs/Learning-Environment-Design-Agents.md#actions + /// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_2_docs/docs/Learning-Environment-Design-Agents.md#actions /// /// The branch for which the actions will be masked. /// The indices of the masked actions. diff --git a/com.unity.ml-agents/Runtime/Sensors/SensorShapeValidator.cs b/com.unity.ml-agents/Runtime/Sensors/SensorShapeValidator.cs index e7959ecd02..2da5e534a4 100644 --- a/com.unity.ml-agents/Runtime/Sensors/SensorShapeValidator.cs +++ b/com.unity.ml-agents/Runtime/Sensors/SensorShapeValidator.cs @@ -34,7 +34,7 @@ public void ValidateSensors(List sensors) Debug.Assert(cachedShape.Length == sensorShape.Length, "Sensor dimensions must match."); for (var j = 0; j < Mathf.Min(cachedShape.Length, sensorShape.Length); j++) { - Debug.Assert(cachedShape[j] == sensorShape[j], "Sensor sizes much match."); + Debug.Assert(cachedShape[j] == sensorShape[j], "Sensor sizes must match."); } } } diff --git a/com.unity.ml-agents/Tests/Editor/Communicator/GrpcExtensionsTests.cs.meta b/com.unity.ml-agents/Tests/Editor/Communicator/GrpcExtensionsTests.cs.meta index 73dd8b25ac..411f1cd45e 100644 --- a/com.unity.ml-agents/Tests/Editor/Communicator/GrpcExtensionsTests.cs.meta +++ b/com.unity.ml-agents/Tests/Editor/Communicator/GrpcExtensionsTests.cs.meta @@ -1,5 +1,5 @@ fileFormatVersion: 2 -guid: e5e4df2934c014aa3b835b9eb9ad20b3 +guid: 7aa28d0e370064c18bb8a913417ad21d MonoImporter: externalObjects: {} serializedVersion: 2 diff --git a/com.unity.ml-agents/Tests/Editor/Sensor/SensorShapeValidatorTests.cs b/com.unity.ml-agents/Tests/Editor/Sensor/SensorShapeValidatorTests.cs index 3aa88fbf6d..09f738570b 100644 --- a/com.unity.ml-agents/Tests/Editor/Sensor/SensorShapeValidatorTests.cs +++ b/com.unity.ml-agents/Tests/Editor/Sensor/SensorShapeValidatorTests.cs @@ -112,13 +112,13 @@ public void TestSizeMismatch() validator.ValidateSensors(sensorList1); var sensorList2 = new List() { new DummySensor(1), new DummySensor(2, 3), new DummySensor(4, 5, 7) }; - LogAssert.Expect(LogType.Assert, "Sensor sizes much match."); + LogAssert.Expect(LogType.Assert, "Sensor sizes must match."); validator.ValidateSensors(sensorList2); // Add the sensors in the other order validator = new SensorShapeValidator(); validator.ValidateSensors(sensorList2); - LogAssert.Expect(LogType.Assert, "Sensor sizes much match."); + LogAssert.Expect(LogType.Assert, "Sensor sizes must match."); validator.ValidateSensors(sensorList1); } @@ -132,7 +132,7 @@ public void TestEverythingMismatch() var sensorList2 = new List() { new DummySensor(1), new DummySensor(9) }; LogAssert.Expect(LogType.Assert, "Number of Sensors must match. 3 != 2"); LogAssert.Expect(LogType.Assert, "Sensor dimensions must match."); - LogAssert.Expect(LogType.Assert, "Sensor sizes much match."); + LogAssert.Expect(LogType.Assert, "Sensor sizes must match."); validator.ValidateSensors(sensorList2); // Add the sensors in the other order @@ -140,7 +140,7 @@ public void TestEverythingMismatch() validator.ValidateSensors(sensorList2); LogAssert.Expect(LogType.Assert, "Number of Sensors must match. 2 != 3"); LogAssert.Expect(LogType.Assert, "Sensor dimensions must match."); - LogAssert.Expect(LogType.Assert, "Sensor sizes much match."); + LogAssert.Expect(LogType.Assert, "Sensor sizes must match."); validator.ValidateSensors(sensorList1); } } diff --git a/com.unity.ml-agents/package.json b/com.unity.ml-agents/package.json index 35a01ac4e1..93ac4efb8f 100755 --- a/com.unity.ml-agents/package.json +++ b/com.unity.ml-agents/package.json @@ -1,10 +1,10 @@ { "name": "com.unity.ml-agents", "displayName": "ML Agents", - "version": "1.0.0-preview", + "version": "1.0.2-preview", "unity": "2018.4", "description": "Use state-of-the-art machine learning to create intelligent character behaviors in any Unity environment (games, robotics, film, etc.).", "dependencies": { - "com.unity.barracuda": "0.7.0-preview" + "com.unity.barracuda": "0.7.1-preview" } -} +} \ No newline at end of file diff --git a/docs/Installation-Anaconda-Windows.md b/docs/Installation-Anaconda-Windows.md index 0611b86cc9..3c3585a101 100644 --- a/docs/Installation-Anaconda-Windows.md +++ b/docs/Installation-Anaconda-Windows.md @@ -123,10 +123,10 @@ commands in an Anaconda Prompt _(if you open a new prompt, be sure to activate the ml-agents Conda environment by typing `activate ml-agents`)_: ```sh -git clone --branch release_1 https://github.com/Unity-Technologies/ml-agents.git +git clone --branch release_2 https://github.com/Unity-Technologies/ml-agents.git ``` -The `--branch release_1` option will switch to the tag of the latest stable +The `--branch release_2` option will switch to the tag of the latest stable release. Omitting that will get the `master` branch which is potentially unstable. diff --git a/docs/Installation.md b/docs/Installation.md index a8b618b688..6b81642ba3 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -53,10 +53,10 @@ example environments and training configurations to experiment with them (some of our tutorials / guides assume you have access to our example environments). ```sh -git clone --branch release_1 https://github.com/Unity-Technologies/ml-agents.git +git clone --branch release_2 https://github.com/Unity-Technologies/ml-agents.git ``` -The `--branch release_1` option will switch to the tag of the latest stable +The `--branch release_2` option will switch to the tag of the latest stable release. Omitting that will get the `master` branch which is potentially unstable. @@ -64,7 +64,7 @@ unstable. You will need to clone the repository if you plan to modify or extend the ML-Agents Toolkit for your purposes. If you plan to contribute those changes -back, make sure to clone the `master` branch (by omitting `--branch release_1` +back, make sure to clone the `master` branch (by omitting `--branch release_2` from the command above). See our [Contributions Guidelines](../com.unity.ml-agents/CONTRIBUTING.md) for more information on contributing to the ML-Agents Toolkit. diff --git a/docs/Training-ML-Agents.md b/docs/Training-ML-Agents.md index c956467cd9..ed6b99352c 100644 --- a/docs/Training-ML-Agents.md +++ b/docs/Training-ML-Agents.md @@ -206,7 +206,9 @@ behaviors: normalize: false num_layers: 2 time_horizon: 64 + summary_freq: 10000 vis_encoder_type: simple + init_path: null # PPO-specific configs beta: 5.0e-3 @@ -228,7 +230,6 @@ behaviors: batch_size: 512 num_epoch: 3 samples_per_update: 0 - init_path: reward_signals: # environment reward @@ -241,7 +242,7 @@ behaviors: strength: 0.02 gamma: 0.99 encoding_size: 256 - learning_rate: 3e-4 + learning_rate: 3.0e-4 # GAIL gail: @@ -249,7 +250,7 @@ behaviors: gamma: 0.99 encoding_size: 128 demo_path: Project/Assets/ML-Agents/Examples/Pyramids/Demos/ExpertPyramid.demo - learning_rate: 3e-4 + learning_rate: 3.0e-4 use_actions: false use_vail: false diff --git a/docs/Training-on-Amazon-Web-Service.md b/docs/Training-on-Amazon-Web-Service.md index 4bce3e6090..38dd4c0a31 100644 --- a/docs/Training-on-Amazon-Web-Service.md +++ b/docs/Training-on-Amazon-Web-Service.md @@ -69,7 +69,7 @@ After launching your EC2 instance using the ami and ssh into it: 2. Clone the ML-Agents repo and install the required Python packages ```sh - git clone --branch release_1 https://github.com/Unity-Technologies/ml-agents.git + git clone --branch release_2 https://github.com/Unity-Technologies/ml-agents.git cd ml-agents/ml-agents/ pip3 install -e . ``` diff --git a/utils/make_readme_table.py b/utils/make_readme_table.py index 6a1d6b46ec..46b36a65d4 100644 --- a/utils/make_readme_table.py +++ b/utils/make_readme_table.py @@ -62,6 +62,7 @@ def display_name(self) -> str: ReleaseInfo.from_simple_tag("0.15.0", "March 18, 2020"), ReleaseInfo.from_simple_tag("0.15.1", "March 30, 2020"), ReleaseInfo("release_1", "1.0.0", "0.16.0", "April 30, 2020"), + ReleaseInfo("release_2", "1.0.2", "0.16.1", "May 20, 2020"), ] MAX_DAYS = 150 # do not print releases older than this many days diff --git a/utils/validate_versions.py b/utils/validate_versions.py index 6d41ea33fa..700949a382 100755 --- a/utils/validate_versions.py +++ b/utils/validate_versions.py @@ -117,6 +117,30 @@ def set_academy_version_string(new_version): f.writelines(lines) +def print_release_tag_commands( + python_version: str, csharp_version: str, release_tag: str +): + python_tag = f"python-packages_{python_version}" + csharp_tag = f"com.unity.ml-agents_{csharp_version}" + docs_tag = f"{release_tag}_docs" + print( + f""" +### +Use these commands to create the tags after the release: +### +git checkout {release_tag} +git tag -f latest_release +git push -f origin latest_release +git tag -f {docs_tag} +git push -f origin {docs_tag} +git tag {python_tag} +git push -f origin {python_tag} +git tag {csharp_tag} +git push -f origin {csharp_tag} +""" + ) + + if __name__ == "__main__": parser = argparse.ArgumentParser() parser.add_argument("--python-version", default=None) @@ -131,6 +155,10 @@ def set_academy_version_string(new_version): if args.csharp_version: print(f"Updating C# package to version {args.csharp_version}") set_version(args.python_version, args.csharp_version, args.release_tag) + if args.release_tag is not None: + print_release_tag_commands( + args.python_version, args.csharp_version, args.release_tag + ) else: ok = check_versions() return_code = 0 if ok else 1