From a8cb4a7574ebbab8657f3e81fc530d8b4d7ab390 Mon Sep 17 00:00:00 2001 From: Chris Elion Date: Wed, 20 May 2020 16:20:11 -0700 Subject: [PATCH] fix release_1 references --- com.unity.ml-agents/Documentation~/com.unity.ml-agents.md | 2 +- docs/Installation-Anaconda-Windows.md | 4 ++-- docs/Installation.md | 6 +++--- docs/Training-on-Amazon-Web-Service.md | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) 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/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-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 . ```