diff --git a/README.md b/README.md index 418522c9db..ccadf619d6 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_12_docs/docs/) +[![docs badge](https://img.shields.io/badge/docs-reference-blue.svg)](https://github.com/Unity-Technologies/ml-agents/tree/release_13_docs/docs/) [![license badge](https://img.shields.io/badge/license-Apache--2.0-green.svg)](LICENSE) @@ -49,7 +49,7 @@ descriptions of all these features. ## Releases & Documentation **Our latest, stable release is `Release 12`. Click -[here](https://github.com/Unity-Technologies/ml-agents/tree/release_12_docs/docs/Readme.md) +[here](https://github.com/Unity-Technologies/ml-agents/tree/release_13_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 diff --git a/com.unity.ml-agents.extensions/Documentation~/Grid-Sensor.md b/com.unity.ml-agents.extensions/Documentation~/Grid-Sensor.md index b4774acf65..191a3d7835 100644 --- a/com.unity.ml-agents.extensions/Documentation~/Grid-Sensor.md +++ b/com.unity.ml-agents.extensions/Documentation~/Grid-Sensor.md @@ -36,7 +36,7 @@ These limitations provided the motivation towards the development of the Grid Se An image can be thought of as a matrix of a predefined width (W) and a height (H) and each pixel can be thought of as simply an array of length 3 (in the case of RGB), `[Red, Green, Blue]` holding the different channel information of the color (channel) intensities at that pixel location. Thus an image is just a 3 dimensional matrix of size WxHx3. A Grid Observation can be thought of as a generalization of this setup where in place of a pixel there is a "cell" which is an array of length N representing different channel intensities at that cell position. From a Convolutional Neural Network point of view, the introduction of multiple channels in an "image" isn't a new concept. One such example is using an RGB-Depth image which is used in several robotics applications. The distinction of Grid Observations is what the data within the channels represents. Instead of limiting the channels to color intensities, the channels within a cell of a Grid Observation generalize to any data that can be represented by a single number (float or int). -Before jumping into the details of the Grid Sensor, an important thing to note is the agent performance and qualitatively different behavior over raycasts. Unity MLAgent's comes with a suite of example environments. One in particular, the [Food Collector](https://github.com/Unity-Technologies/ml-agents/tree/release_12_docs/docs/Learning-Environment-Examples.md#food-collector), has been the focus of the Grid Sensor development. +Before jumping into the details of the Grid Sensor, an important thing to note is the agent performance and qualitatively different behavior over raycasts. Unity MLAgent's comes with a suite of example environments. One in particular, the [Food Collector](https://github.com/Unity-Technologies/ml-agents/tree/release_13_docs/docs/Learning-Environment-Examples.md#food-collector), has been the focus of the Grid Sensor development. The Food Collector environment can be described as: * Set-up: A multi-agent environment where agents compete to collect food. diff --git a/com.unity.ml-agents.extensions/Documentation~/Match3.md b/com.unity.ml-agents.extensions/Documentation~/Match3.md index cab0d7fd2b..297da21dee 100644 --- a/com.unity.ml-agents.extensions/Documentation~/Match3.md +++ b/com.unity.ml-agents.extensions/Documentation~/Match3.md @@ -10,7 +10,7 @@ Our aim is to enable Match-3 teams to leverage ML-Agents to create player agents This implementation includes: * C# implementation catered toward a Match-3 setup including concepts around encoding for moves based on [Human Like Playtesting with Deep Learning](https://www.researchgate.net/publication/328307928_Human-Like_Playtesting_with_Deep_Learning) -* An example Match-3 scene with ML-Agents implemented (located under /Project/Assets/ML-Agents/Examples/Match3). More information, on Match-3 example [here](https://github.com/Unity-Technologies/ml-agents/tree/release_12_docs/docs/docs/Learning-Environment-Examples.md#match-3). +* An example Match-3 scene with ML-Agents implemented (located under /Project/Assets/ML-Agents/Examples/Match3). More information, on Match-3 example [here](https://github.com/Unity-Technologies/ml-agents/tree/release_13_docs/docs/docs/Learning-Environment-Examples.md#match-3). ### Feedback If you are a Match-3 developer and are trying to leverage ML-Agents for this scenario, [we want to hear from you](https://forms.gle/TBsB9jc8WshgzViU9). Additionally, we are also looking for interested Match-3 teams to speak with us for 45 minutes. If you are interested, please indicate that in the [form](https://forms.gle/TBsB9jc8WshgzViU9). If selected, we will provide gift cards as a token of appreciation. diff --git a/com.unity.ml-agents.extensions/Documentation~/com.unity.ml-agents.extensions.md b/com.unity.ml-agents.extensions/Documentation~/com.unity.ml-agents.extensions.md index d732cbe5e4..5b03f9b7d6 100644 --- a/com.unity.ml-agents.extensions/Documentation~/com.unity.ml-agents.extensions.md +++ b/com.unity.ml-agents.extensions/Documentation~/com.unity.ml-agents.extensions.md @@ -28,14 +28,14 @@ The ML-Agents Extensions package is not currently available in the Package Manag recommended ways to install the package: ### Local Installation -[Clone the repository](https://github.com/Unity-Technologies/ml-agents/tree/release_12_docs/docs/Installation.md#clone-the-ml-agents-toolkit-repository-optional) and follow the -[Local Installation for Development](https://github.com/Unity-Technologies/ml-agents/tree/release_12_docs/docs/Installation.md#advanced-local-installation-for-development-1) +[Clone the repository](https://github.com/Unity-Technologies/ml-agents/tree/release_13_docs/docs/Installation.md#clone-the-ml-agents-toolkit-repository-optional) and follow the +[Local Installation for Development](https://github.com/Unity-Technologies/ml-agents/tree/release_13_docs/docs/Installation.md#advanced-local-installation-for-development-1) directions (substituting `com.unity.ml-agents.extensions` for the package name). ### Github via Package Manager In Unity 2019.4 or later, open the Package Manager, hit the "+" button, and select "Add package from git URL". -![Package Manager git URL](https://github.com/Unity-Technologies/ml-agents/tree/release_12_docs/docs/images/unity_package_manager_git_url.png) +![Package Manager git URL](https://github.com/Unity-Technologies/ml-agents/tree/release_13_docs/docs/images/unity_package_manager_git_url.png) In the dialog that appears, enter ``` git+https://github.com/Unity-Technologies/ml-agents.git?path=com.unity.ml-agents.extensions @@ -60,4 +60,4 @@ following versions of the Unity Editor: none ## Need Help? -The main [README](https://github.com/Unity-Technologies/ml-agents/tree/release_12_docs/README.md) contains links for contacting the team or getting support. +The main [README](https://github.com/Unity-Technologies/ml-agents/tree/release_13_docs/README.md) contains links for contacting the team or getting support. diff --git a/com.unity.ml-agents.extensions/package.json b/com.unity.ml-agents.extensions/package.json index a29cbf22d4..bdb8779aaa 100644 --- a/com.unity.ml-agents.extensions/package.json +++ b/com.unity.ml-agents.extensions/package.json @@ -5,6 +5,6 @@ "unity": "2018.4", "description": "A source-only package for new features based on ML-Agents", "dependencies": { - "com.unity.ml-agents": "1.7.2-preview" + "com.unity.ml-agents": "1.8.0-preview" } } diff --git a/com.unity.ml-agents/CHANGELOG.md b/com.unity.ml-agents/CHANGELOG.md index e97c9d3346..e9d61ce174 100755 --- a/com.unity.ml-agents/CHANGELOG.md +++ b/com.unity.ml-agents/CHANGELOG.md @@ -6,20 +6,6 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). -## [Unreleased] -### Major Changes -#### com.unity.ml-agents (C#) -#### ml-agents / ml-agents-envs / gym-unity (Python) - -### Minor Changes -#### com.unity.ml-agents / com.unity.ml-agents.extensions (C#) -#### ml-agents / ml-agents-envs / gym-unity (Python) - -### Bug Fixes -#### com.unity.ml-agents (C#) -#### ml-agents / ml-agents-envs / gym-unity (Python) - - ## [1.8.0-preview] - 2021-02-17 ### Major Changes #### com.unity.ml-agents (C#) diff --git a/com.unity.ml-agents/Documentation~/com.unity.ml-agents.md b/com.unity.ml-agents/Documentation~/com.unity.ml-agents.md old mode 100755 new mode 100644 index 859f7de273..ec9a8a5e4f --- a/com.unity.ml-agents/Documentation~/com.unity.ml-agents.md +++ b/com.unity.ml-agents/Documentation~/com.unity.ml-agents.md @@ -118,7 +118,7 @@ Please refer to "Information that is passively collected by Unity" in the [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_12_docs/docs/Installation.md +[installation instructions]: https://github.com/Unity-Technologies/ml-agents/blob/release_13_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 7d06da1df9..641ae5d105 100644 --- a/com.unity.ml-agents/Runtime/Academy.cs +++ b/com.unity.ml-agents/Runtime/Academy.cs @@ -20,7 +20,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_12_docs/docs/ + * https://github.com/Unity-Technologies/ml-agents/tree/release_13_docs/docs/ */ namespace Unity.MLAgents @@ -61,7 +61,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_12_docs/" + + [HelpURL("https://github.com/Unity-Technologies/ml-agents/tree/release_13_docs/" + "docs/Learning-Environment-Design.md")] public class Academy : IDisposable { @@ -103,7 +103,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.7.2-preview"; + internal const string k_PackageVersion = "1.8.0-preview"; const int k_EditorTrainingPort = 5004; diff --git a/com.unity.ml-agents/Runtime/Actuators/IActionReceiver.cs b/com.unity.ml-agents/Runtime/Actuators/IActionReceiver.cs index 7e8451d6b9..07af9e8458 100644 --- a/com.unity.ml-agents/Runtime/Actuators/IActionReceiver.cs +++ b/com.unity.ml-agents/Runtime/Actuators/IActionReceiver.cs @@ -218,7 +218,7 @@ public interface IActionReceiver /// /// See [Agents - Actions] for more information on masking actions. /// - /// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_12_docs/docs/Learning-Environment-Design-Agents.md#actions + /// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_13_docs/docs/Learning-Environment-Design-Agents.md#actions /// /// void WriteDiscreteActionMask(IDiscreteActionMask actionMask); diff --git a/com.unity.ml-agents/Runtime/Actuators/IDiscreteActionMask.cs b/com.unity.ml-agents/Runtime/Actuators/IDiscreteActionMask.cs index 6e6fdb35a7..8e661f8187 100644 --- a/com.unity.ml-agents/Runtime/Actuators/IDiscreteActionMask.cs +++ b/com.unity.ml-agents/Runtime/Actuators/IDiscreteActionMask.cs @@ -17,7 +17,7 @@ public interface IDiscreteActionMask /// /// See [Agents - Actions] for more information on masking actions. /// - /// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_12_docs/docs/Learning-Environment-Design-Agents.md#actions + /// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_13_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/Agent.cs b/com.unity.ml-agents/Runtime/Agent.cs index e1a4191b84..c4e69502b7 100644 --- a/com.unity.ml-agents/Runtime/Agent.cs +++ b/com.unity.ml-agents/Runtime/Agent.cs @@ -156,13 +156,13 @@ public void CopyActions(ActionBuffers actionBuffers) /// [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_12_docs/docs/Learning-Environment-Design-Agents.md - /// [Reinforcement Learning in Unity]: https://github.com/Unity-Technologies/ml-agents/blob/release_12_docs/docs/Learning-Environment-Design.md + /// [Agents]: https://github.com/Unity-Technologies/ml-agents/blob/release_13_docs/docs/Learning-Environment-Design-Agents.md + /// [Reinforcement Learning in Unity]: https://github.com/Unity-Technologies/ml-agents/blob/release_13_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_12_docs/docs/Readme.md + /// [Unity ML-Agents Toolkit manual]: https://github.com/Unity-Technologies/ml-agents/blob/release_13_docs/docs/Readme.md /// /// - [HelpURL("https://github.com/Unity-Technologies/ml-agents/blob/release_12_docs/" + + [HelpURL("https://github.com/Unity-Technologies/ml-agents/blob/release_13_docs/" + "docs/Learning-Environment-Design-Agents.md")] [Serializable] [RequireComponent(typeof(BehaviorParameters))] @@ -655,8 +655,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_12_docs/docs/Learning-Environment-Design-Agents.md#rewards - /// [Reward Signals]: https://github.com/Unity-Technologies/ml-agents/blob/release_12_docs/docs/ML-Agents-Overview.md#a-quick-note-on-reward-signals + /// [Agents - Rewards]: https://github.com/Unity-Technologies/ml-agents/blob/release_13_docs/docs/Learning-Environment-Design-Agents.md#rewards + /// [Reward Signals]: https://github.com/Unity-Technologies/ml-agents/blob/release_13_docs/docs/ML-Agents-Overview.md#a-quick-note-on-reward-signals /// /// The new value of the reward. public void SetReward(float reward) @@ -685,8 +685,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_12_docs/docs/Learning-Environment-Design-Agents.md#rewards - /// [Reward Signals]: https://github.com/Unity-Technologies/ml-agents/blob/release_12_docs/docs/ML-Agents-Overview.md#a-quick-note-on-reward-signals + /// [Agents - Rewards]: https://github.com/Unity-Technologies/ml-agents/blob/release_13_docs/docs/Learning-Environment-Design-Agents.md#rewards + /// [Reward Signals]: https://github.com/Unity-Technologies/ml-agents/blob/release_13_docs/docs/ML-Agents-Overview.md#a-quick-note-on-reward-signals /// /// Incremental reward value. public void AddReward(float increment) @@ -864,8 +864,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_12_docs/docs/Learning-Environment-Design-Agents.md#recording-demonstrations - /// [Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_12_docs/docs/Learning-Environment-Design-Agents.md#actions + /// [Demonstration Recorder]: https://github.com/Unity-Technologies/ml-agents/blob/release_13_docs/docs/Learning-Environment-Design-Agents.md#recording-demonstrations + /// [Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_13_docs/docs/Learning-Environment-Design-Agents.md#actions /// [GameObject]: https://docs.unity3d.com/Manual/GameObjects.html /// /// @@ -1122,7 +1122,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_12_docs/docs/Learning-Environment-Design-Agents.md#observations-and-sensors + /// [Observations and Sensors]: https://github.com/Unity-Technologies/ml-agents/blob/release_13_docs/docs/Learning-Environment-Design-Agents.md#observations-and-sensors /// public virtual void CollectObservations(VectorSensor sensor) { @@ -1153,7 +1153,7 @@ public ReadOnlyCollection GetObservations() /// /// See [Agents - Actions] for more information on masking actions. /// - /// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_12_docs/docs/Learning-Environment-Design-Agents.md#actions + /// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_13_docs/docs/Learning-Environment-Design-Agents.md#actions /// /// public virtual void WriteDiscreteActionMask(IDiscreteActionMask actionMask) @@ -1229,7 +1229,7 @@ public virtual void WriteDiscreteActionMask(IDiscreteActionMask actionMask) /// /// For more information about implementing agent actions see [Agents - Actions]. /// - /// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_12_docs/docs/Learning-Environment-Design-Agents.md#actions + /// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_13_docs/docs/Learning-Environment-Design-Agents.md#actions /// /// /// Struct containing the buffers of actions to be executed at this step. diff --git a/com.unity.ml-agents/Runtime/Demonstrations/DemonstrationRecorder.cs b/com.unity.ml-agents/Runtime/Demonstrations/DemonstrationRecorder.cs index a9a1c20fdb..57892acf84 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_12_docs/docs//Learning-Environment-Design-Agents.md#recording-demonstrations + /// [Imitation Learning - Recording Demonstrations]: https://github.com/Unity-Technologies/ml-agents/blob/release_13_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 f38929ea42..38a612d10a 100644 --- a/com.unity.ml-agents/Runtime/DiscreteActionMasker.cs +++ b/com.unity.ml-agents/Runtime/DiscreteActionMasker.cs @@ -32,7 +32,7 @@ internal DiscreteActionMasker(IDiscreteActionMask actionMask) /// /// See [Agents - Actions] for more information on masking actions. /// - /// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_12_docs/docs/Learning-Environment-Design-Agents.md#actions + /// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_13_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/package.json b/com.unity.ml-agents/package.json index 630a2d2632..4f9c4c7d83 100755 --- a/com.unity.ml-agents/package.json +++ b/com.unity.ml-agents/package.json @@ -1,7 +1,7 @@ { "name": "com.unity.ml-agents", "displayName": "ML Agents", - "version": "1.7.2-preview", + "version": "1.8.0-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": { diff --git a/docs/Installation-Anaconda-Windows.md b/docs/Installation-Anaconda-Windows.md index 90f70466ba..d3f286fd9f 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_12 https://github.com/Unity-Technologies/ml-agents.git +git clone --branch release_13 https://github.com/Unity-Technologies/ml-agents.git ``` -The `--branch release_12` option will switch to the tag of the latest stable +The `--branch release_13` 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 7f2ed0ebc9..6598481401 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_12 https://github.com/Unity-Technologies/ml-agents.git +git clone --branch release_13 https://github.com/Unity-Technologies/ml-agents.git ``` -The `--branch release_12` option will switch to the tag of the latest stable +The `--branch release_13` 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_12` +back, make sure to clone the `master` branch (by omitting `--branch release_13` 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-on-Amazon-Web-Service.md b/docs/Training-on-Amazon-Web-Service.md index 24560d76a0..314f57c99f 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_12 https://github.com/Unity-Technologies/ml-agents.git + git clone --branch release_13 https://github.com/Unity-Technologies/ml-agents.git cd ml-agents/ml-agents/ pip3 install -e . ``` diff --git a/docs/Unity-Inference-Engine.md b/docs/Unity-Inference-Engine.md index 223478d225..747a0d2f48 100644 --- a/docs/Unity-Inference-Engine.md +++ b/docs/Unity-Inference-Engine.md @@ -35,9 +35,9 @@ The ML-Agents Toolkit only supports the models created with our trainers. Model loading expects certain conventions for constants and tensor names. While it is possible to construct a model that follows these conventions, we don't provide any additional help for this. More details can be found in -[TensorNames.cs](https://github.com/Unity-Technologies/ml-agents/blob/release_12_docs/com.unity.ml-agents/Runtime/Inference/TensorNames.cs) +[TensorNames.cs](https://github.com/Unity-Technologies/ml-agents/blob/release_13_docs/com.unity.ml-agents/Runtime/Inference/TensorNames.cs) and -[BarracudaModelParamLoader.cs](https://github.com/Unity-Technologies/ml-agents/blob/release_12_docs/com.unity.ml-agents/Runtime/Inference/BarracudaModelParamLoader.cs). +[BarracudaModelParamLoader.cs](https://github.com/Unity-Technologies/ml-agents/blob/release_13_docs/com.unity.ml-agents/Runtime/Inference/BarracudaModelParamLoader.cs). If you wish to run inference on an externally trained model, you should use Barracuda directly, instead of trying to run it through ML-Agents. diff --git a/gym-unity/gym_unity/__init__.py b/gym-unity/gym_unity/__init__.py index b4eab77991..85b3e9dce3 100644 --- a/gym-unity/gym_unity/__init__.py +++ b/gym-unity/gym_unity/__init__.py @@ -1,5 +1,5 @@ # Version of the library that will be used to upload to pypi -__version__ = "0.24.0.dev0" +__version__ = "0.24.0" # Git tag that will be checked to determine whether to trigger upload to pypi -__release_tag__ = None +__release_tag__ = "release_13" diff --git a/ml-agents-envs/mlagents_envs/__init__.py b/ml-agents-envs/mlagents_envs/__init__.py index b4eab77991..85b3e9dce3 100644 --- a/ml-agents-envs/mlagents_envs/__init__.py +++ b/ml-agents-envs/mlagents_envs/__init__.py @@ -1,5 +1,5 @@ # Version of the library that will be used to upload to pypi -__version__ = "0.24.0.dev0" +__version__ = "0.24.0" # Git tag that will be checked to determine whether to trigger upload to pypi -__release_tag__ = None +__release_tag__ = "release_13" diff --git a/ml-agents/mlagents/trainers/__init__.py b/ml-agents/mlagents/trainers/__init__.py index b4eab77991..85b3e9dce3 100644 --- a/ml-agents/mlagents/trainers/__init__.py +++ b/ml-agents/mlagents/trainers/__init__.py @@ -1,5 +1,5 @@ # Version of the library that will be used to upload to pypi -__version__ = "0.24.0.dev0" +__version__ = "0.24.0" # Git tag that will be checked to determine whether to trigger upload to pypi -__release_tag__ = None +__release_tag__ = "release_13" diff --git a/utils/validate_release_links.py b/utils/validate_release_links.py index 58d7c77fba..76b3c368f5 100755 --- a/utils/validate_release_links.py +++ b/utils/validate_release_links.py @@ -5,20 +5,22 @@ import os import re import subprocess +import tempfile from typing import List, Optional, Pattern RELEASE_PATTERN = re.compile(r"release_[0-9]+(_docs)*") TRAINER_INIT_FILE = "ml-agents/mlagents/trainers/__init__.py" +MATCH_ANY = re.compile(r"(?s).*") # Filename -> regex list to allow specific lines. # To allow everything in the file, use None for the value ALLOW_LIST = { # Previous release table - "README.md": re.compile(r"\*\*Release [0-9]+\*\*"), - "docs/Versioning.md": None, - "com.unity.ml-agents/CHANGELOG.md": None, - "utils/make_readme_table.py": None, - "utils/validate_release_links.py": None, + "README.md": re.compile(r"\*\*(Verified Package ([0-9]\.?)*|Release [0-9]+)\*\*"), + "docs/Versioning.md": MATCH_ANY, + "com.unity.ml-agents/CHANGELOG.md": MATCH_ANY, + "utils/make_readme_table.py": MATCH_ANY, + "utils/validate_release_links.py": MATCH_ANY, } @@ -72,28 +74,43 @@ def get_release_tag() -> Optional[str]: raise RuntimeError("Can't determine release tag") -def check_file(filename: str, global_allow_pattern: Pattern) -> List[str]: +def check_file( + filename: str, global_allow_pattern: Pattern, release_tag: str +) -> List[str]: """ Validate a single file and return any offending lines. """ bad_lines = [] - with open(filename) as f: - for line in f: - if not RELEASE_PATTERN.search(line): - continue - - if global_allow_pattern.search(line): - continue + with tempfile.TemporaryDirectory() as tempdir: + if not os.path.exists(tempdir): + os.makedirs(tempdir) + new_file_name = os.path.join(tempdir, os.path.basename(filename)) + with open(new_file_name, "w+") as new_file: + # default to match everything if there is nothing in the ALLOW_LIST + allow_list_pattern = ALLOW_LIST.get(filename, MATCH_ANY) + with open(filename) as f: + for line in f: + keep_line = True + keep_line = not RELEASE_PATTERN.search(line) + keep_line |= global_allow_pattern.search(line) is not None + keep_line |= allow_list_pattern.search(line) is not None + + if keep_line: + new_file.write(line) + else: + bad_lines.append(f"{filename}: {line}") + new_file.write( + re.sub(r"release_[0-9]+", fr"{release_tag}", line) + ) + if bad_lines: + if os.path.exists(filename): + os.remove(filename) + os.rename(new_file_name, filename) - if filename in ALLOW_LIST: - if ALLOW_LIST[filename] is None or ALLOW_LIST[filename].search(line): - continue - - bad_lines.append(f"{filename}: {line.strip()}") return bad_lines -def check_all_files(allow_pattern: Pattern) -> List[str]: +def check_all_files(allow_pattern: Pattern, release_tag: str) -> List[str]: """ Validate all files tracked by git. :param allow_pattern: @@ -103,7 +120,7 @@ def check_all_files(allow_pattern: Pattern) -> List[str]: for file_name in git_ls_files(): if "localized" in file_name or os.path.splitext(file_name)[1] not in file_types: continue - bad_lines += check_file(file_name, allow_pattern) + bad_lines += check_file(file_name, allow_pattern, release_tag) return bad_lines @@ -115,14 +132,17 @@ def main(): print(f"Release tag: {release_tag}") allow_pattern = re.compile(f"{release_tag}(_docs)*") - bad_lines = check_all_files(allow_pattern) + bad_lines = check_all_files(allow_pattern, release_tag) if bad_lines: - print( - f"Found lines referring to previous release. Either update the files, or add an exclusion to {__file__}" - ) for line in bad_lines: print(line) + print("*************************************************************") + print( + "This script attempted to fix the above errors. Please double " + + "check them to make sure the replacements were done correctly" + ) + sys.exit(1 if bad_lines else 0)