pull/1294 from has-taiar #1310
pull/1294 from has-taiar #1310
Conversation
|
This is on top of this PR. Thanks for the contribution from #1294. |
docs/Installation.md
Outdated
| width="500" border="10" /> | ||
| </p> | ||
|
|
||
| ## Windows installation |
There was a problem hiding this comment.
Should keep the header "Windows Users"
docs/Installation.md
Outdated
| guide](Installation-Windows.md) to setting up your env. For Mac and Linux, | ||
| continue with this guide. | ||
|
|
||
| ## Clone the ML-Agents Toolkit Repository |
There was a problem hiding this comment.
This header should be renamed to "## Mac and Unix Users", immediately follows by a sub-heading "### Clone the ML-Agents Toolkit Repository"
There was a problem hiding this comment.
Further, below:
## Install Python and mlagents Package-->### Install Python and mlagents Package### NOTES-->**Notes:**(bold instead of header)- Delete
### Mac and Unix Usersheader
These suggested are following the thinking that the intention here is to have three top-level sections:
- Windows Users
- Mac and Unix Users
- Docker Installation
…, added the package explanation to the Windows installation doc
|
Hi @mmattar , I've resolved all of your comments. |
docs/Installation-Windows.md
Outdated
| To use the ML-Agents toolkit, you install Python and the required Python | ||
| packages as outlined below. This guide also covers how set up GPU-based training | ||
| (for advanced users). GPU-based training is not required for the v0.4 release of | ||
| (for advanced users). GPU-based training is not required for the v0.6 release of |
There was a problem hiding this comment.
On second thought, can we just remove v0.6 and say "for the current release"
There was a problem hiding this comment.
More appropriately .... "GPU-based training is not currently required for the ML-Agents toolkit."
docs/Installation-Windows.md
Outdated
| check Nvidia's page [here](https://developer.nvidia.com/cuda-gpus). | ||
|
|
||
| As of the ML-Agents toolkit v0.4, only CUDA v9.0 and cuDNN v7.0.5 is supported. | ||
| As of the ML-Agents toolkit v0.6, only CUDA v9.0 and cuDNN v7.0.5 is supported. |
There was a problem hiding this comment.
similar to above - remove the v0.6 as we'll always need to uptick
There was a problem hiding this comment.
Fixed both places.
docs/Installation-Windows.md
Outdated
|
|
||
| The `UnitySDK` subdirectory contains the Unity Assets to add to your projects. | ||
| It also contains many [example environments](Learning-Environment-Examples.md) | ||
| that can be used to help get you familiar with Unity. |
There was a problem hiding this comment.
"that can be used to help get you familiar with Unity." --> "to help you get started."
There was a problem hiding this comment.
Fixed, I also fixed the exact same wording in the Installation.md doc.
| If you don't want to use Git, you can always directly download all the files | ||
| [here](https://github.com/Unity-Technologies/ml-agents/archive/master.zip). | ||
|
|
||
| The `UnitySDK` subdirectory contains the Unity Assets to add to your projects. |
There was a problem hiding this comment.
Why are we referring to the SDK as assets?
There was a problem hiding this comment.
I copied over the same sentences in the Installation doc to this Installation windows doc. Also they can be considered as Assets since they are something we can put in the Asset store. (And are compatible with the Asset usage, while the python package isn't).
|
@mmattar I've resolved all of the comments. |
docs/Installation-Windows.md
Outdated
| check Nvidia's page [here](https://developer.nvidia.com/cuda-gpus). | ||
|
|
||
| As of the ML-Agents toolkit v0.6, only CUDA v9.0 and cuDNN v7.0.5 is supported. | ||
| Currently for ML-Agents toolkit, only CUDA v9.0 and cuDNN v7.0.5 is supported. |
No description provided.