-
Notifications
You must be signed in to change notification settings - Fork 4.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update docs to reflect new package installation workflow. #3362
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -39,22 +39,32 @@ The `Project` subdirectory contains many [example environments](Learning-Environ | |
to help you get started. | ||
|
||
### Package Installation | ||
ML-Agents C# SDK is transitioning to a Unity Package. While we are working on getting into the | ||
official packages list, you can add the `com.unity.ml-agents` package to your project by | ||
navigating to the menu `Window` -> `Package Manager`. In the package manager window click | ||
on the `+` button. | ||
|
||
If you intend to copy the `com.unity.ml-agents` folder in to your project, ensure that | ||
you have the [Barracuda preview package](https://docs.unity3d.com/Packages/com.unity.barracuda@0.3/manual/index.html) installed. | ||
<p align="center"> | ||
<img src="images/unity_package_manager_window.png" | ||
alt="Linux Build Support" | ||
width="500" border="10" /> | ||
</p> | ||
|
||
**NOTE:** In Unity 2018.4 it's on the bottom right of the packages list, and in Unity 2019.3 it's on the top left of the packages list. | ||
|
||
To install the Barracuda package in later versions of Unity, navigate to the Package | ||
Manager window by navigating to the menu `Window` -> `Package Manager`. Click on the | ||
`Advanced` dropdown menu to the left of the search bar and make sure "Show Preview Packages" | ||
is checked. Search for or select the `Barracuda` package and install the latest version. | ||
Select `Add package from disk...` and navigate into the | ||
`com.unity.ml-agents` folder and select the `package.json` folder. | ||
|
||
<p align="center"> | ||
<img src="images/barracuda-package.png" | ||
alt="Barracuda Package Manager" | ||
width="710" border="10" | ||
height="569" /> | ||
<img src="images/unity_package_json.png" | ||
alt="Linux Build Support" | ||
width="500" border="10" /> | ||
</p> | ||
|
||
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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There are some project settings that the user should modify in the PlayerSettings no ? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Like what? |
||
|
||
The `ml-agents` subdirectory contains a Python package which provides deep reinforcement | ||
learning trainers to use with Unity environments. | ||
|
||
|
This file contains 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
This file contains 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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure we still generate this file