Skip to content

Commit 7b55335

Browse files
Updated docs. (#5986)
1 parent 63b71a8 commit 7b55335

8 files changed

+19
-13
lines changed

docs/Installation.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Consequently, to install and use the ML-Agents Toolkit you will need to:
4242
strongly recommend that you install Unity through the Unity Hub as it will
4343
enable you to manage multiple Unity versions.
4444

45-
### Install **Python 3.7.2** or Higher
45+
### Install **Python 3.10.12** or Higher
4646

4747
We recommend [installing](https://www.python.org/downloads/) Python 3.7.
4848
If you are using Windows, please install the x86-64 version and not x86.
@@ -139,7 +139,7 @@ On Windows, you'll have to install the PyTorch package separately prior to
139139
installing ML-Agents. Activate your virtual environment and run from the command line:
140140

141141
```sh
142-
pip3 install torch~=1.7.1 -f https://download.pytorch.org/whl/torch_stable.html
142+
pip3 install torch~=1.13.1 -f https://download.pytorch.org/whl/torch_stable.html
143143
```
144144

145145
Note that on Windows, you may also need Microsoft's

docs/Integrations-Match3.md

-5
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,3 @@ The indexing for actions is the same as described in
102102
(for example, Figure 2b). The horizontal moves are enumerated first, then the vertical ones.
103103
<img src="images/match3-moves.png" align="center"/>
104104

105-
## Feedback
106-
If you are a Match-3 developer and are trying to leverage ML-Agents for this scenario,
107-
[we want to hear from you](https://forms.gle/TBsB9jc8WshgzViU9). Additionally, we are also looking for interested
108-
Match-3 teams to speak with us for 45 minutes. If you are interested, please indicate that in the
109-
[form](https://forms.gle/TBsB9jc8WshgzViU9). If selected, we will provide gift cards as a token of appreciation.

docs/Migrating.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<!---
55
TODO: update ml-agents-env package version before release
66
--->
7-
## Migrating to the ml-agents-envs 0.29.0 package
7+
## Migrating to the ml-agents-envs 0.30.0 package
88
- Python 3.10 is now the minimum version of python supported due to [python3.6 EOL](https://endoflife.date/python).
99
Please update your python installation to 3.10.12 or higher.
1010
- The `gym-unity` package has been refactored into the `ml-agents-envs` package. Please update your imports accordingly.
@@ -19,7 +19,7 @@ from mlagents_envs.envs.unity_gym_env import UnityToGymWrapper
1919
```
2020

2121

22-
## Migrating the package to version 2.0
22+
## Migrating the package to version 2.x
2323
- The official version of Unity ML-Agents supports is now 2022.3 LTS. If you run
2424
into issues, please consider deleting your project's Library folder and reponening your
2525
project.

docs/Readme.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -164,15 +164,15 @@ We have also published a series of blog posts that are relevant for ML-Agents:
164164

165165
### More from Unity
166166

167-
- [Unity Robotics](https://github.com/Unity-Technologies/Unity-Robotics-Hub)
168-
- [Unity Computer Vision](https://github.com/Unity-Technologies/com.unity.perception)
167+
- [Unity Sentis](https://unity.com/products/sentis)
168+
- [Introductin Unity Muse and Sentis](https://blog.unity.com/engine-platform/introducing-unity-muse-and-unity-sentis-ai)
169169

170170
## Community and Feedback
171171

172172
The ML-Agents Toolkit is an open-source project and we encourage and welcome
173173
contributions. If you wish to contribute, be sure to review our
174174
[contribution guidelines](CONTRIBUTING.md) and
175-
[code of conduct](../CODE_OF_CONDUCT.md).
175+
[code of conduct](CODE_OF_CONDUCT.md).
176176

177177
For problems with the installation and setup of the ML-Agents Toolkit, or
178178
discussions about how to best setup or train your agents, please create a new

docs/Tutorial-Custom-Trainer-Plugin.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
# Custom Trainer Plugin
2+
3+
## How to write a custom trainer plugin
4+
15
### Step 1: Write your custom trainer class
26
Before you start writing your code, make sure to use your favorite environment management tool(e.g. `venv` or `conda`) to create and activate a Python virtual environment. The following command uses `conda`, but other tools work similarly:
37
```shell

docs/Unity-Inference-Engine.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ run the neural network within Unity.
1010
## Supported devices
1111

1212
See the Unity Inference Engine documentation for a list of the
13-
[supported platforms](https://docs.unity3d.com/Packages/com.unity.sentis@latest/index.html#supported-platforms).
13+
[supported platforms](https://docs.unity3d.com/Manual/PlatformSpecific.html).
1414

1515
Scripting Backends : The Unity Inference Engine is generally faster with
1616
**IL2CPP** than with **Mono** for Standalone builds. In the Editor, It is not

docs/Using-Virtual-Environment.md

+4
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@ from dependencies of other projects. This has a few advantages:
2121
This guide has been tested with Python 3.10.12. Newer versions might not
2222
have support for the dependent libraries, so are not recommended.
2323

24+
## Use Conda (or Mamba)
25+
26+
While there are many options for setting up virtual environments for python, by far the most
27+
2428
## Installing Pip (Required)
2529

2630
1. Download the `get-pip.py` file using the command

mkdocs.yml

+3
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ nav:
1313
- Machine Learning: Background-Machine-Learning.md
1414
- PyTorch: Background-PyTorch.md
1515
- Unity: Background-Unity.md
16+
- ELO: ELO-Rating-System.md
1617
- Interfacing with Unity Builds:
1718
- Getting started with the Gym API: Python-Gym-API.md
1819
- Getting started with the PettingZoo API: Python-PettingZoo-API.md
@@ -23,7 +24,9 @@ nav:
2324
- LLAPI Documentation: Python-LLAPI-Documentation.md
2425
- On/Off Policy Trainer: Python-On-Off-Policy-Trainer-Documentation.md
2526
- Tutorials:
27+
- Customizing Training via Plugins: Training-Plugins.md
2628
- Custom Trainer Plugin: Tutorial-Custom-Trainer-Plugin.md
29+
- HuggingFace: Hugging-Face-Integration.md
2730
- About:
2831
- FAQs: FAQ.md
2932
- Limitations: Limitations.md

0 commit comments

Comments
 (0)