From f05c1c8fb6b31977f2ce430b8adef65f28ccb537 Mon Sep 17 00:00:00 2001 From: vincentpierre Date: Fri, 16 Apr 2021 10:18:45 -0700 Subject: [PATCH] Release 17 version bumps and docs version bumps --- README.md | 4 +-- .../com.unity.ml-agents.extensions.md | 12 ++++----- com.unity.ml-agents.extensions/package.json | 2 +- .../Documentation~/com.unity.ml-agents.md | 14 +++++----- com.unity.ml-agents/Runtime/Academy.cs | 4 +-- .../Runtime/Actuators/IActionReceiver.cs | 2 +- .../Runtime/Actuators/IDiscreteActionMask.cs | 2 +- com.unity.ml-agents/Runtime/Agent.cs | 26 +++++++++---------- .../Demonstrations/DemonstrationRecorder.cs | 2 +- docs/Installation-Anaconda-Windows.md | 8 +++--- docs/Installation.md | 8 +++--- docs/Migrating.md | 2 +- docs/Training-on-Amazon-Web-Service.md | 2 +- docs/Training-on-Microsoft-Azure.md | 2 +- docs/Unity-Inference-Engine.md | 4 +-- gym-unity/gym_unity/__init__.py | 4 +-- ml-agents-envs/README.md | 2 +- ml-agents-envs/mlagents_envs/__init__.py | 4 +-- ml-agents/README.md | 2 +- ml-agents/mlagents/trainers/__init__.py | 4 +-- ml-agents/setup.py | 2 +- 21 files changed, 56 insertions(+), 56 deletions(-) diff --git a/README.md b/README.md index a12e0a21ed..1d59eac1bc 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_16_docs/docs/) +[![docs badge](https://img.shields.io/badge/docs-reference-blue.svg)](https://github.com/Unity-Technologies/ml-agents/tree/release_17_docs/docs/) [![license badge](https://img.shields.io/badge/license-Apache--2.0-green.svg)](LICENSE) @@ -48,7 +48,7 @@ descriptions of all these features. **Our latest, stable release is `Release 16`. Click -[here](https://github.com/Unity-Technologies/ml-agents/tree/release_16_docs/docs/Readme.md) +[here](https://github.com/Unity-Technologies/ml-agents/tree/release_17_docs/docs/Readme.md) to get started with the latest release of ML-Agents.** The table below lists all our releases, including our `main` branch which is 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 326dadfd6c..0bdf5ec158 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 @@ -27,24 +27,24 @@ 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_16_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_16_docs/docs/Installation.md#advanced-local-installation-for-development-1) +[Clone the repository](https://github.com/Unity-Technologies/ml-agents/tree/release_17_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_17_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/blob/release_16_docs/docs/images/unity_package_manager_git_url.png) +![Package Manager git URL](https://github.com/Unity-Technologies/ml-agents/blob/release_17_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#release_16 +git+https://github.com/Unity-Technologies/ml-agents.git?path=com.unity.ml-agents.extensions#release_17 ``` You can also edit your project's `manifest.json` directly and add the following line to the `dependencies` section: ``` -"com.unity.ml-agents.extensions": "git+https://github.com/Unity-Technologies/ml-agents.git?path=com.unity.ml-agents.extensions#release_16", +"com.unity.ml-agents.extensions": "git+https://github.com/Unity-Technologies/ml-agents.git?path=com.unity.ml-agents.extensions#release_17", ``` See [Git dependencies](https://docs.unity3d.com/Manual/upm-git.html#subfolder) for more information. Note that this may take several minutes to resolve the packages the first time that you add it. @@ -66,4 +66,4 @@ If using the `InputActuatorComponent` - No way to customize the action space of the `InputActuatorComponent` ## Need Help? -The main [README](https://github.com/Unity-Technologies/ml-agents/tree/release_16_docs/README.md) contains links for contacting the team or getting support. +The main [README](https://github.com/Unity-Technologies/ml-agents/tree/release_17_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 cec215933e..ee6f5c368b 100644 --- a/com.unity.ml-agents.extensions/package.json +++ b/com.unity.ml-agents.extensions/package.json @@ -1,7 +1,7 @@ { "name": "com.unity.ml-agents.extensions", "displayName": "ML Agents Extensions", - "version": "0.3.1-preview", + "version": "0.4.0-preview", "unity": "2019.4", "description": "A source-only package for new features based on ML-Agents", "dependencies": { 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 8a91bb22c8..38f8ce68ad 100644 --- a/com.unity.ml-agents/Documentation~/com.unity.ml-agents.md +++ b/com.unity.ml-agents/Documentation~/com.unity.ml-agents.md @@ -61,25 +61,25 @@ With the changes to Unity Package Manager in 2021, experimental packages will no 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/blob/release_16_docs/docs/images/unity_package_manager_git_url.png) +![Package Manager git URL](https://github.com/Unity-Technologies/ml-agents/blob/release_17_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#release_16 +git+https://github.com/Unity-Technologies/ml-agents.git?path=com.unity.ml-agents#release_17 ``` You can also edit your project's `manifest.json` directly and add the following line to the `dependencies` section: ``` -"com.unity.ml-agents": "git+https://github.com/Unity-Technologies/ml-agents.git?path=com.unity.ml-agents#release_16", +"com.unity.ml-agents": "git+https://github.com/Unity-Technologies/ml-agents.git?path=com.unity.ml-agents#release_17", ``` See [Git dependencies](https://docs.unity3d.com/Manual/upm-git.html#subfolder) for more information. Note that this may take several minutes to resolve the packages the first time that you add it. #### Local Installation for Development -[Clone the repository](https://github.com/Unity-Technologies/ml-agents/tree/release_16_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_16_docs/docs/Installation.md#advanced-local-installation-for-development-1) +[Clone the repository](https://github.com/Unity-Technologies/ml-agents/tree/release_17_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_17_docs/docs/Installation.md#advanced-local-installation-for-development-1) directions. ## Requirements @@ -152,10 +152,10 @@ 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_16_docs/docs/Installation.md +[installation instructions]: https://github.com/Unity-Technologies/ml-agents/blob/release_17_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 [connect with us]: https://github.com/Unity-Technologies/ml-agents#community-and-feedback [ml-agents forum]: https://forum.unity.com/forums/ml-agents.453/ -[ML-Agents GitHub repo]: https://github.com/Unity-Technologies/ml-agents/blob/release_16_docs/com.unity.ml-agents.extensions +[ML-Agents GitHub repo]: https://github.com/Unity-Technologies/ml-agents/blob/release_17_docs/com.unity.ml-agents.extensions diff --git a/com.unity.ml-agents/Runtime/Academy.cs b/com.unity.ml-agents/Runtime/Academy.cs index e844d2c667..b436041c89 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_16_docs/docs/ + * https://github.com/Unity-Technologies/ml-agents/tree/release_17_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_16_docs/" + + [HelpURL("https://github.com/Unity-Technologies/ml-agents/tree/release_17_docs/" + "docs/Learning-Environment-Design.md")] public class Academy : IDisposable { diff --git a/com.unity.ml-agents/Runtime/Actuators/IActionReceiver.cs b/com.unity.ml-agents/Runtime/Actuators/IActionReceiver.cs index 0898fed9e8..f00a1e1e16 100644 --- a/com.unity.ml-agents/Runtime/Actuators/IActionReceiver.cs +++ b/com.unity.ml-agents/Runtime/Actuators/IActionReceiver.cs @@ -184,7 +184,7 @@ public interface IActionReceiver /// /// See [Agents - Actions] for more information on masking actions. /// - /// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_16_docs/docs/Learning-Environment-Design-Agents.md#actions + /// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_17_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 e7ac7e60f3..0fe0ab96d8 100644 --- a/com.unity.ml-agents/Runtime/Actuators/IDiscreteActionMask.cs +++ b/com.unity.ml-agents/Runtime/Actuators/IDiscreteActionMask.cs @@ -16,7 +16,7 @@ public interface IDiscreteActionMask /// /// See [Agents - Actions] for more information on masking actions. /// - /// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_16_docs/docs/Learning-Environment-Design-Agents.md#actions + /// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_17_docs/docs/Learning-Environment-Design-Agents.md#actions /// /// The branch for which the actions will be masked. /// Index of the action diff --git a/com.unity.ml-agents/Runtime/Agent.cs b/com.unity.ml-agents/Runtime/Agent.cs index e3e8e16bc6..f349cff25d 100644 --- a/com.unity.ml-agents/Runtime/Agent.cs +++ b/com.unity.ml-agents/Runtime/Agent.cs @@ -185,13 +185,13 @@ public override BuiltInActuatorType GetBuiltInActuatorType() /// [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_16_docs/docs/Learning-Environment-Design-Agents.md - /// [Reinforcement Learning in Unity]: https://github.com/Unity-Technologies/ml-agents/blob/release_16_docs/docs/Learning-Environment-Design.md + /// [Agents]: https://github.com/Unity-Technologies/ml-agents/blob/release_17_docs/docs/Learning-Environment-Design-Agents.md + /// [Reinforcement Learning in Unity]: https://github.com/Unity-Technologies/ml-agents/blob/release_17_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_16_docs/docs/Readme.md + /// [Unity ML-Agents Toolkit manual]: https://github.com/Unity-Technologies/ml-agents/blob/release_17_docs/docs/Readme.md /// /// - [HelpURL("https://github.com/Unity-Technologies/ml-agents/blob/release_16_docs/" + + [HelpURL("https://github.com/Unity-Technologies/ml-agents/blob/release_17_docs/" + "docs/Learning-Environment-Design-Agents.md")] [Serializable] [RequireComponent(typeof(BehaviorParameters))] @@ -692,8 +692,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_16_docs/docs/Learning-Environment-Design-Agents.md#rewards - /// [Reward Signals]: https://github.com/Unity-Technologies/ml-agents/blob/release_16_docs/docs/ML-Agents-Overview.md#a-quick-note-on-reward-signals + /// [Agents - Rewards]: https://github.com/Unity-Technologies/ml-agents/blob/release_17_docs/docs/Learning-Environment-Design-Agents.md#rewards + /// [Reward Signals]: https://github.com/Unity-Technologies/ml-agents/blob/release_17_docs/docs/ML-Agents-Overview.md#a-quick-note-on-reward-signals /// /// The new value of the reward. public void SetReward(float reward) @@ -720,8 +720,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_16_docs/docs/Learning-Environment-Design-Agents.md#rewards - /// [Reward Signals]: https://github.com/Unity-Technologies/ml-agents/blob/release_16_docs/docs/ML-Agents-Overview.md#a-quick-note-on-reward-signals + /// [Agents - Rewards]: https://github.com/Unity-Technologies/ml-agents/blob/release_17_docs/docs/Learning-Environment-Design-Agents.md#rewards + /// [Reward Signals]: https://github.com/Unity-Technologies/ml-agents/blob/release_17_docs/docs/ML-Agents-Overview.md#a-quick-note-on-reward-signals /// /// Incremental reward value. public void AddReward(float increment) @@ -909,8 +909,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_16_docs/docs/Learning-Environment-Design-Agents.md#recording-demonstrations - /// [Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_16_docs/docs/Learning-Environment-Design-Agents.md#actions + /// [Demonstration Recorder]: https://github.com/Unity-Technologies/ml-agents/blob/release_17_docs/docs/Learning-Environment-Design-Agents.md#recording-demonstrations + /// [Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_17_docs/docs/Learning-Environment-Design-Agents.md#actions /// [GameObject]: https://docs.unity3d.com/Manual/GameObjects.html /// /// @@ -1165,7 +1165,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_16_docs/docs/Learning-Environment-Design-Agents.md#observations-and-sensors + /// [Observations and Sensors]: https://github.com/Unity-Technologies/ml-agents/blob/release_17_docs/docs/Learning-Environment-Design-Agents.md#observations-and-sensors /// public virtual void CollectObservations(VectorSensor sensor) { @@ -1196,7 +1196,7 @@ public ReadOnlyCollection GetObservations() /// /// See [Agents - Actions] for more information on masking actions. /// - /// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_16_docs/docs/Learning-Environment-Design-Agents.md#actions + /// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_17_docs/docs/Learning-Environment-Design-Agents.md#actions /// /// public virtual void WriteDiscreteActionMask(IDiscreteActionMask actionMask) { } @@ -1262,7 +1262,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_16_docs/docs/Learning-Environment-Design-Agents.md#actions + /// [Agents - Actions]: https://github.com/Unity-Technologies/ml-agents/blob/release_17_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 db504c216b..a9724b7df8 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_16_docs/docs//Learning-Environment-Design-Agents.md#recording-demonstrations + /// [Imitation Learning - Recording Demonstrations]: https://github.com/Unity-Technologies/ml-agents/blob/release_17_docs/docs//Learning-Environment-Design-Agents.md#recording-demonstrations /// [RequireComponent(typeof(Agent))] [AddComponentMenu("ML Agents/Demonstration Recorder", (int)MenuGroup.Default)] diff --git a/docs/Installation-Anaconda-Windows.md b/docs/Installation-Anaconda-Windows.md index 4c4441d790..7a91bf6b10 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_16 https://github.com/Unity-Technologies/ml-agents.git +git clone --branch release_17 https://github.com/Unity-Technologies/ml-agents.git ``` -The `--branch release_16` option will switch to the tag of the latest stable +The `--branch release_17` option will switch to the tag of the latest stable release. Omitting that will get the `main` branch which is potentially unstable. @@ -151,7 +151,7 @@ config files in this directory when running `mlagents-learn`. Make sure you are connected to the Internet and then type in the Anaconda Prompt: ```console -python -m pip install mlagents==0.25.1 +python -m pip install mlagents==0.26.0 ``` This will complete the installation of all the required Python packages to run @@ -162,7 +162,7 @@ pip will get stuck when trying to read the cache of the package. If you see this, you can try: ```console -python -m pip install mlagents==0.25.1 --no-cache-dir +python -m pip install mlagents==0.26.0 --no-cache-dir ``` This `--no-cache-dir` tells the pip to disable the cache. diff --git a/docs/Installation.md b/docs/Installation.md index 79424664bb..308c45f771 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -64,17 +64,17 @@ of our tutorials / guides assume you have access to our example environments). the repository if you would like to explore more examples. ```sh -git clone --branch release_16 https://github.com/Unity-Technologies/ml-agents.git +git clone --branch release_17 https://github.com/Unity-Technologies/ml-agents.git ``` -The `--branch release_16` option will switch to the tag of the latest stable +The `--branch release_17` option will switch to the tag of the latest stable release. Omitting that will get the `main` branch which is potentially unstable. #### Advanced: Local Installation for Development 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 `main` branch (by omitting `--branch release_16` +back, make sure to clone the `main` branch (by omitting `--branch release_17` from the command above). See our [Contributions Guidelines](../com.unity.ml-agents/CONTRIBUTING.md) for more information on contributing to the ML-Agents Toolkit. @@ -155,7 +155,7 @@ To install the `mlagents` Python package, activate your virtual environment and run from the command line: ```sh -python -m pip install mlagents==0.25.1 +python -m pip install mlagents==0.26.0 ``` Note that this will install `mlagents` from PyPi, _not_ from the cloned diff --git a/docs/Migrating.md b/docs/Migrating.md index 8867a7787d..ef0c19359e 100644 --- a/docs/Migrating.md +++ b/docs/Migrating.md @@ -198,7 +198,7 @@ folder - The Parameter Randomization feature has been merged with the Curriculum feature. It is now possible to specify a sampler in the lesson of a Curriculum. Curriculum has been refactored and is now specified at the level of the parameter, not the behavior. More information -[here](https://github.com/Unity-Technologies/ml-agents/blob/release_16_docs/docs/Training-ML-Agents.md).(#4160) +[here](https://github.com/Unity-Technologies/ml-agents/blob/release_17_docs/docs/Training-ML-Agents.md).(#4160) ### Steps to Migrate - The configuration format for curriculum and parameter randomization has changed. To upgrade your configuration files, diff --git a/docs/Training-on-Amazon-Web-Service.md b/docs/Training-on-Amazon-Web-Service.md index 8aa7b3611d..aae9490516 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_16 https://github.com/Unity-Technologies/ml-agents.git + git clone --branch release_17 https://github.com/Unity-Technologies/ml-agents.git cd ml-agents/ml-agents/ pip3 install -e . ``` diff --git a/docs/Training-on-Microsoft-Azure.md b/docs/Training-on-Microsoft-Azure.md index aeaa55f63b..d195428ccd 100644 --- a/docs/Training-on-Microsoft-Azure.md +++ b/docs/Training-on-Microsoft-Azure.md @@ -33,7 +33,7 @@ view the documentation for doing so [here](#custom-instances). instance, and set it as the working directory. 2. Install the required packages: Torch: `pip3 install torch==1.7.0 -f https://download.pytorch.org/whl/torch_stable.html` and - MLAgents: `python -m pip install mlagents==0.25.1` + MLAgents: `python -m pip install mlagents==0.26.0` ## Testing diff --git a/docs/Unity-Inference-Engine.md b/docs/Unity-Inference-Engine.md index 825cb47959..767839a7cc 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_16_docs/com.unity.ml-agents/Runtime/Inference/TensorNames.cs) +[TensorNames.cs](https://github.com/Unity-Technologies/ml-agents/blob/release_17_docs/com.unity.ml-agents/Runtime/Inference/TensorNames.cs) and -[BarracudaModelParamLoader.cs](https://github.com/Unity-Technologies/ml-agents/blob/release_16_docs/com.unity.ml-agents/Runtime/Inference/BarracudaModelParamLoader.cs). +[BarracudaModelParamLoader.cs](https://github.com/Unity-Technologies/ml-agents/blob/release_17_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 9dfb0e107b..eb355d679e 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.26.0.dev0" +__version__ = "0.26.0" # Git tag that will be checked to determine whether to trigger upload to pypi -__release_tag__ = None +__release_tag__ = "release_17" diff --git a/ml-agents-envs/README.md b/ml-agents-envs/README.md index 96300bd14b..ef3b267ef6 100644 --- a/ml-agents-envs/README.md +++ b/ml-agents-envs/README.md @@ -13,7 +13,7 @@ communication. Install the `mlagents_envs` package with: ```sh -python -m pip install mlagents_envs==0.25.1 +python -m pip install mlagents_envs==0.26.0 ``` ## Usage & More Information diff --git a/ml-agents-envs/mlagents_envs/__init__.py b/ml-agents-envs/mlagents_envs/__init__.py index 9dfb0e107b..eb355d679e 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.26.0.dev0" +__version__ = "0.26.0" # Git tag that will be checked to determine whether to trigger upload to pypi -__release_tag__ = None +__release_tag__ = "release_17" diff --git a/ml-agents/README.md b/ml-agents/README.md index 6d3cd55c0e..e86f13ae41 100644 --- a/ml-agents/README.md +++ b/ml-agents/README.md @@ -16,7 +16,7 @@ package. Install the `mlagents` package with: ```sh -python -m pip install mlagents==0.25.1 +python -m pip install mlagents==0.26.0 ``` ## Usage & More Information diff --git a/ml-agents/mlagents/trainers/__init__.py b/ml-agents/mlagents/trainers/__init__.py index 9dfb0e107b..eb355d679e 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.26.0.dev0" +__version__ = "0.26.0" # Git tag that will be checked to determine whether to trigger upload to pypi -__release_tag__ = None +__release_tag__ = "release_17" diff --git a/ml-agents/setup.py b/ml-agents/setup.py index 2e501476fb..5c33c3ad17 100644 --- a/ml-agents/setup.py +++ b/ml-agents/setup.py @@ -65,7 +65,7 @@ def run(self): "protobuf>=3.6", "pyyaml>=3.1.0", # Windows ver. of PyTorch doesn't work from PyPi. Installation: - # https://github.com/Unity-Technologies/ml-agents/blob/release_16_docs/docs/Installation.md#windows-installing-pytorch + # https://github.com/Unity-Technologies/ml-agents/blob/release_17_docs/docs/Installation.md#windows-installing-pytorch # Torch only working on python 3.9 for 1.8.0 and above. Details see: # https://github.com/pytorch/pytorch/issues/50014 "torch>=1.8.0,<1.9.0;(platform_system!='Windows' and python_version>='3.9')",