From 45ad34af7549f1c0207909df002527d905bfce42 Mon Sep 17 00:00:00 2001 From: Christopher Goy Date: Thu, 11 Mar 2021 14:27:09 -0800 Subject: [PATCH 1/5] Update install docs to mention samples and link to the fourm for feedback. --- docs/Installation.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/Installation.md b/docs/Installation.md index c129fdb92f..b589b0be90 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -3,7 +3,10 @@ The ML-Agents Toolkit contains several components: - Unity package ([`com.unity.ml-agents`](../com.unity.ml-agents/)) contains the - Unity C# SDK that will be integrated into your Unity scene. + Unity C# SDK that will be integrated into your Unity scene. This package contains + the [3DBall example](../Project/Assets/ML-Agents/Examples/3DBall/Scenes/3DBall.unity) + as a sample. Please let us know what samples you'd like to see shipped with the package in + [this forum thread](https://forum.unity.com/threads/feedback-wanted-shipping-sample-s-with-the-ml-agents-package.1073468/). - Unity package ([`com.unity.ml-agents.extensions`](../com.unity.ml-agents.extensions/)) contains experimental C#/Unity components that are not yet ready to be part From 080ca1b8fbddea2262054ef5f04c3a2ec1227f86 Mon Sep 17 00:00:00 2001 From: Chris Goy Date: Thu, 11 Mar 2021 15:16:33 -0800 Subject: [PATCH 2/5] Update docs/Installation.md Co-authored-by: Chris Elion --- docs/Installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Installation.md b/docs/Installation.md index b589b0be90..21bfe0ef10 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -3,7 +3,7 @@ The ML-Agents Toolkit contains several components: - Unity package ([`com.unity.ml-agents`](../com.unity.ml-agents/)) contains the - Unity C# SDK that will be integrated into your Unity scene. This package contains + Unity C# SDK that will be integrated into your Unity project. This package contains the [3DBall example](../Project/Assets/ML-Agents/Examples/3DBall/Scenes/3DBall.unity) as a sample. Please let us know what samples you'd like to see shipped with the package in [this forum thread](https://forum.unity.com/threads/feedback-wanted-shipping-sample-s-with-the-ml-agents-package.1073468/). From b74ea7727fce2ae9c469ed606e7b070c82fb65ed Mon Sep 17 00:00:00 2001 From: Christopher Goy Date: Thu, 11 Mar 2021 16:23:09 -0800 Subject: [PATCH 3/5] Update docs. --- README.md | 5 +++++ docs/Installation.md | 7 ++++--- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 57f1013a1c..f3490ee8f5 100644 --- a/README.md +++ b/README.md @@ -170,6 +170,11 @@ sure to include as much detail as possible. If you run into any other problems using the ML-Agents Toolkit or have a specific feature request, please [submit a GitHub issue](https://github.com/Unity-Technologies/ml-agents/issues). +Please tell us which samples you would like to see shipped with the ML-Agents Unity +package by replying to +[this forum thread](https://forum.unity.com/threads/feedback-wanted-shipping-sample-s-with-the-ml-agents-package.1073468/). + + Your opinion matters a great deal to us. Only by hearing your thoughts on the Unity ML-Agents Toolkit can we continue to improve and grow. Please take a few minutes to diff --git a/docs/Installation.md b/docs/Installation.md index b589b0be90..a4fd56fd18 100644 --- a/docs/Installation.md +++ b/docs/Installation.md @@ -4,9 +4,7 @@ The ML-Agents Toolkit contains several components: - Unity package ([`com.unity.ml-agents`](../com.unity.ml-agents/)) contains the Unity C# SDK that will be integrated into your Unity scene. This package contains - the [3DBall example](../Project/Assets/ML-Agents/Examples/3DBall/Scenes/3DBall.unity) - as a sample. Please let us know what samples you'd like to see shipped with the package in - [this forum thread](https://forum.unity.com/threads/feedback-wanted-shipping-sample-s-with-the-ml-agents-package.1073468/). + a sample to help you get started with ML-Agents. - Unity package ([`com.unity.ml-agents.extensions`](../com.unity.ml-agents.extensions/)) contains experimental C#/Unity components that are not yet ready to be part @@ -62,6 +60,9 @@ packages, but you may choose to clone the repository if you'd like download our example environments and training configurations to experiment with them (some of our tutorials / guides assume you have access to our example environments). +**NOTE:** There are samples shipped with the Unity Package. You only need to clone +the repository if you would like to explore more examples. + ```sh git clone --branch release_14 https://github.com/Unity-Technologies/ml-agents.git ``` From c008ad257c1a7f864254541cd8122a41760cf5a3 Mon Sep 17 00:00:00 2001 From: Christopher Goy Date: Thu, 11 Mar 2021 16:37:10 -0800 Subject: [PATCH 4/5] Update getting started for 3D Ball. --- docs/Getting-Started.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/Getting-Started.md b/docs/Getting-Started.md index f7486ef22f..a37e52e7ae 100644 --- a/docs/Getting-Started.md +++ b/docs/Getting-Started.md @@ -28,10 +28,10 @@ Let's get started! If you haven't already, follow the [installation instructions](Installation.md). Afterwards, open the Unity Project that contains all the example environments: -1. Launch Unity Hub -1. On the Projects dialog, choose the **Add** option at the top of the window. -1. Using the file dialog that opens, locate the `Project` folder within the - ML-Agents Toolkit and click **Open**. +1. Open the Package Manager Window by navigating to `Window -> Package Manager` + in the menu. +1. Navigate to the ML-Agents Package and click on it. +1. Find the 3D Ball Sample and click `Import`. 1. In the **Project** window, go to the `Assets/ML-Agents/Examples/3DBall/Scenes` folder and open the `3DBall` scene file. From 37a4be753e54c056320e79c3d475f983b827efd8 Mon Sep 17 00:00:00 2001 From: Christopher Goy Date: Thu, 11 Mar 2021 16:37:51 -0800 Subject: [PATCH 5/5] Update getting started. --- docs/Getting-Started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Getting-Started.md b/docs/Getting-Started.md index a37e52e7ae..c4ec5332ad 100644 --- a/docs/Getting-Started.md +++ b/docs/Getting-Started.md @@ -31,7 +31,7 @@ Afterwards, open the Unity Project that contains all the example environments: 1. Open the Package Manager Window by navigating to `Window -> Package Manager` in the menu. 1. Navigate to the ML-Agents Package and click on it. -1. Find the 3D Ball Sample and click `Import`. +1. Find the `3D Ball` sample and click `Import`. 1. In the **Project** window, go to the `Assets/ML-Agents/Examples/3DBall/Scenes` folder and open the `3DBall` scene file.