getting started documentation does not get you started ;)

joslat commented 3 years ago

Describe the bug Follow the getting started documentation, https://github.com/Unity-Technologies/ml-agents/blob/release_15_docs/docs/Getting-Started.md until you reach the installation steps.

it does not indicate where is the unity project that contains the example environments.
- looking at external videos I figured out It is \ml-agents\Project
Opening the Package manager and navigating to the ML-Agents package... there is no way to find the "3D Ball" sample and importing it. image attached..
- Also, apart from "clicking it", there should appear a 3D Ball sample?
- But, if we open the sample it is already imported so... what are we doing with clicking it... clicking it where?
Step 3 cannot be followed (Find the 3D Ball Sample and click "import".
Step 4 seems to be working, but steps 2 and 3 do not seem to make too much sense... and are pretty confusing. Or am I missing something?

Attaching the installation section of https://github.com/Unity-Technologies/ml-agents/blob/release_15_docs/docs/Getting-Started.md

To Reproduce Steps to reproduce the behavior: As described in the error, follow the "Installation" steps or better, try to follow them...

surfnerd commented 3 years ago

Hi @joslat, I added this documentation and it is definitely misleading now that you've brought it up. If you have already opened up the Project Folder, the 3DBall example should be under Assets/ML-Agents/Examples/3DBall.

The sample will show up when the package is actually installed from the package manager, not when you clone the git repo and open up the Project project. I'll update the documentation and have you review it for me along with another team member. Thank you for the important feedback. Cheers, Chris

joslat commented 3 years ago

Thanks, outstandingly fast feedback!!

I'll keep a watch on it, let's see If I can get this working and train something that makes sense :)

Jconrad15 commented 3 years ago

Hi @surfnerd,

I am having a similar problem as joslat.

I followed through the installation section here: https://github.com/Unity-Technologies/ml-agents/blob/main/docs/Installation.md

The end of the installation section includes a Next Step of working though the Getting Started Guide here: https://github.com/Unity-Technologies/ml-agents/blob/main/docs/Getting-Started.md

During the Getting Started Guide I navigate to the ML Agents package in the Package Manager (per steps 1 and 2), as shown in: Capture1

However, there is no option to import any samples. This is shown in the included screenshot: Capture

I am unsure why the samples are not showing in the ML Agents package.

Thanks.

surfnerd commented 3 years ago

Hey @Jconrad15, The sample shows up in version 1.9.1-preview and later. I will call that out in the docs when I get to the task of fixing this issue. Thank you for the feedback!

Jconrad15 commented 3 years ago

Hi @surfnerd

Thanks for the very fast reply. That fixed my issue.

I've included another screenshot with the 3D ball import option for others who stumble across this thread: Capture2

crcdng commented 3 years ago

The sample shows up in version 1.9.1-preview and later. I will call that out in the docs when I get to the task of fixing this issue. Thank you for the feedback!

The sample does not show up in 2.1.0-exp.1 Preview on Unity 2020.3 for Mac. Installed through package manager.

stale[bot] commented 2 years ago

This issue has been automatically marked as stale because it has not had activity in the last 28 days. It will be closed in the next 14 days if no further activity occurs. Thank you for your contributions.

stale[bot] commented 2 years ago

This issue has been automatically closed because it has not had activity in the last 42 days. If this issue is still valid, please ping a maintainer. Thank you for your contributions.

stale[bot] commented 2 years ago

This issue has been automatically marked as stale because it has not had activity in the last 28 days. It will be closed in the next 14 days if no further activity occurs. Thank you for your contributions.

stale[bot] commented 2 years ago

This issue has been automatically closed because it has not had activity in the last 42 days. If this issue is still valid, please ping a maintainer. Thank you for your contributions.

github-actions[bot] commented 2 years ago

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

Unity-Technologies / ml-agents

getting started documentation does not get you started ;) #5232