Skip to content

Commit deef960

Browse files
authored
[docs] Update installation docs to mention installation of Barracuda. (#3030)
1 parent 29a7877 commit deef960

File tree

3 files changed

+22
-1
lines changed

3 files changed

+22
-1
lines changed

docs/Installation.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,27 @@ The `UnitySDK` subdirectory contains the Unity Assets to add to your projects.
3333
It also contains many [example environments](Learning-Environment-Examples.md)
3434
to help you get started.
3535

36+
### Package Installation
37+
38+
If you intend to copy the `UnitySDK` folder in to your project, ensure that
39+
you have the [Barracuda preview package](https://docs.unity3d.com/Packages/com.unity.barracuda@0.3/manual/index.html) installed.
40+
41+
To install the Barracuda package in Unity **2017.4.x**, you will have to copy the
42+
`UnityPackageManager` folder under the `UnitySDK` folder to the root directory of your
43+
project.
44+
45+
To install the Barrcuda package in later versions of Unity, navigate to the Package
46+
Manager window by navigating to the menu `Window` -> `Package Manager`. Click on the
47+
`Adavanced` dropdown menu to the left of the search bar and make sure "Show Preview Packages"
48+
is checked. Search for or select the `Barracuda` package and install the latest version.
49+
50+
<p align="center">
51+
<img src="images/barracuda-package.png"
52+
alt="Barracuda Package Manager"
53+
width="710" border="10"
54+
height="569" />
55+
</p>
56+
3657
The `ml-agents` subdirectory contains a Python package which provides deep reinforcement
3758
learning trainers to use with Unity environments.
3859

docs/Migrating.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The versions can be found in
2323
* If you use RayPerception3D, replace it with RayPerceptionSensorComponent3D (and similarly for 2D). The settings, such as ray angles and detectable tags, are configured on the component now.
2424
RayPerception3D would contribute `(# of rays) * (# of tags + 2)` to the State Size in Behavior Parameters, but this is no longer necessary, so you should reduce the State Size by this amount.
2525
Making this change will require retraining your model, since the observations that RayPerceptionSensorComponent3D produces are different from the old behavior.
26-
* If you see messages such as `The type or namespace 'Barracuda' could not be found` or `The type or namespace 'Google' could not be found`, you will need to install the Barracuda preview package from the Package Manager.
26+
* If you see messages such as `The type or namespace 'Barracuda' could not be found` or `The type or namespace 'Google' could not be found`, you will need to [install the Barracuda preview package](Installation.md#package-installation).
2727

2828
## Migrating from ML-Agents toolkit v0.10 to v0.11.0
2929

docs/images/barracuda-package.png

79.4 KB
Loading

0 commit comments

Comments
 (0)