Update installation doc #6242
Open
Update installation doc #6242
+43
−46
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Update LICENSE Copyright date. * Updated changelog. * Updated package version in Academy.cs * Update package version. * Update release date
| @@ -1,23 +1,21 @@ | |||
| # Installation | |||
There was a problem hiding this comment.
Suggested change
| # Installation | |
| # Install the ML-Agents Toolkit |
| @@ -1,23 +1,21 @@ | |||
| # Installation | |||
| To install and use the ML-Agents Toolkit, follow the steps below. Detailed instructions for each step are provided later on this page. | |||
| To install and use the ML-Agents Toolkit, follow the steps below. Detailed instructions for each step are provided later on this page. For advanced installation and development setup, see the [Advanced Installation](#advanced-installation) section at the bottom of this page. | |||
There was a problem hiding this comment.
Suggested change
| To install and use the ML-Agents Toolkit, follow the steps below. Detailed instructions for each step are provided later on this page. For advanced installation and development setup, see the [Advanced Installation](#advanced-installation) section at the bottom of this page. | |
| Use this information to install and use the ML-Agents Toolkit. | |
| For advanced setup and development options, refer to [Advanced Installation](#advanced-installation). |
| 1. Install Unity (6000.0 or later) | ||
| 2. Install Python (>= 3.10.1, <=3.10.12) - we recommend using 3.10.12 | ||
| 3. Install the `com.unity.ml-agents` Unity package; or clone this repository and install locally (recommended for the latest version and bug fixes) | ||
| 2. Install Python using conda (>= 3.10.1, <=3.10.12) - we recommend using 3.10.12 |
There was a problem hiding this comment.
Suggested change
| 2. Install Python using conda (>= 3.10.1, <=3.10.12) - we recommend using 3.10.12 |
| 2. Install Python (>= 3.10.1, <=3.10.12) - we recommend using 3.10.12 | ||
| 3. Install the `com.unity.ml-agents` Unity package; or clone this repository and install locally (recommended for the latest version and bug fixes) | ||
| 2. Install Python using conda (>= 3.10.1, <=3.10.12) - we recommend using 3.10.12 | ||
| 3. Install the `com.unity.ml-agents` Unity package |
There was a problem hiding this comment.
Suggested change
| 3. Install the `com.unity.ml-agents` Unity package |
| 3. Install the `com.unity.ml-agents` Unity package; or clone this repository and install locally (recommended for the latest version and bug fixes) | ||
| 2. Install Python using conda (>= 3.10.1, <=3.10.12) - we recommend using 3.10.12 | ||
| 3. Install the `com.unity.ml-agents` Unity package | ||
| 4. Install `mlagents-envs` |
There was a problem hiding this comment.
Suggested change
| 4. Install `mlagents-envs` |
|
|
||
| ### Install Python package | ||
|
|
||
| Installing the `mlagents` Python package involves installing other Python packages that `mlagents` depends on. So you may run into installation issues if your machine has older versions of any of those dependencies already installed. Consequently, our supported path for installing `mlagents` is to leverage Python Virtual Environments. Virtual Environments provide a mechanism for isolating the dependencies for each project and are supported on Mac / Windows / Linux. We offer a dedicated [guide on Virtual Environments](Using-Virtual-Environment.md). |
There was a problem hiding this comment.
Suggested change
| Installing the `mlagents` Python package involves installing other Python packages that `mlagents` depends on. So you may run into installation issues if your machine has older versions of any of those dependencies already installed. Consequently, our supported path for installing `mlagents` is to leverage Python Virtual Environments. Virtual Environments provide a mechanism for isolating the dependencies for each project and are supported on Mac / Windows / Linux. We offer a dedicated [guide on Virtual Environments](Using-Virtual-Environment.md). | |
| To Install the `mlagents` Python package, you need to install other Python packages that `mlagents` depend on. Note that you might encounter installation issues if your machine has older versions of any of those dependencies already installed. Consequently, our supported path for installing `mlagents` is to leverage Python Virtual Environments. Virtual Environments provide a mechanism for isolating the dependencies for each project and are supported on Mac / Windows / Linux. For more information, refer to [Virtual Environments](Using-Virtual-Environment.md). |
|
|
||
| **Important:** Ensure you install a Python package version that matches your Unity package version. Check the [release history](https://github.com/Unity-Technologies/ml-agents/releases) to find compatible versions. | ||
|
|
||
| To install, activate your virtual environment and run the following command: |
There was a problem hiding this comment.
Suggested change
| To install, activate your virtual environment and run the following command: | |
| To install `mlagents`, activate your virtual environment and run the following command: |
| python -m pip install mlagents==1.1.0 | ||
| ``` | ||
|
|
||
| which will install the latest version of ML-Agents Python packages and associated dependencies available on PyPi. If building the wheel for `grpcio` fails, run the following command before installing `mlagents` with pip: |
There was a problem hiding this comment.
Suggested change
| which will install the latest version of ML-Agents Python packages and associated dependencies available on PyPi. If building the wheel for `grpcio` fails, run the following command before installing `mlagents` with pip: | |
| This command installs the latest version of ML-Agents Python packages and associated dependencies available on PyPi. If building the wheel for `grpcio` fails, run the following command before you install `mlagents` with pip: |
| ## Advanced Installation | ||
|
|
||
| #### Advanced: Local Installation for Development | ||
| ### Unity Package: Local Installation for Development |
There was a problem hiding this comment.
Suggested change
| ### Unity Package: Local Installation for Development | |
| ### Unity Package: Local installation for development |
|
|
||
| If you are going to follow the examples from our documentation, you can open the | ||
| `Project` folder in Unity and start tinkering immediately. | ||
| If you are going to follow the examples from our documentation, you can open the `Project` folder in Unity and start tinkering immediately. |
There was a problem hiding this comment.
Suggested change
| If you are going to follow the examples from our documentation, you can open the `Project` folder in Unity and start tinkering immediately. | |
| If you want to start experimenting immediately, open the **Project** folder in Unity and explore the example scenes. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed change(s)
Improve the installation documentation for better clarity and ease of use.
Types of change(s)
Checklist
Other comments