-
Notifications
You must be signed in to change notification settings - Fork 9
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
[MAJOR] PR - Overhaul Repository Structure #45
Conversation
needs populating. Will take time but will be completed.
added another image of signposter with annotations per sign for completeness
added important note about adding documentation
removed redundant meessage
minor changes
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.
I think the following files should be removed:
- Background-Cognitive-Science.md
- Background-Machine-Learning.md
- Sample-Config-Tutorial.ipynb
Some of the figures need to be updated so they're not from the unity editor. Most users won't see that and they look quite different from what they will see (which might make some think that something has gone wrong). Specifically, the figures in:
- Agent-HUD
- prefabs/dispensers --> so they don't have the strange outlines
- Any that contain the directional legends or tool bars from the editor.
The Background-YAML.md
file focuses too much on yaml files for ml-agents. I think this is too technical, when most people will want to get to grips with yaml for building configs in AAI first. We should leave ml-agents tutorials for another document, if we decide to explicitly support it.
minor tweak
updated project aims and background after feedback from lucy
minor tweaks
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.
feedback has been implemented and changes are committed.
Proposed change(s)
A massive PR which aims to overhaul the material presented and drastically improve user experience.
Key modifications:
Useful links (Github issues, ML-Agents forum threads etc.)
Closes #37
Closes #19 <-- GIFS need to be updated but i am suggesting we close this issue with this PR for simplicity.
Closes #10
Types of change(s)
Checklist
Other comments
/project/AAI-RoadMap.md
is still a WIP/docs/gettingStarted/Getting-Started.md
is still a WIP (needs wider-team collaboration)/docs/Technical-Overview.md
is still a WIP (likely to take more time as it's intended purpose is to offer a very low-level, hands-on technical presentation/demonstration on how AAI works behind the scenes).Screenshots (if any)
N/A