A massive PR which aims to overhaul the material presented and drastically improve user experience.
Key modifications:
Removed the src folder which contains python code. All code are now removed from the repo, emphasizing the documentation of animalai in this repo.
Added extensive documentation on the Arena, Objects, configurations, and added figures for every object.
Removed legacy documentation/figures
Added background material for UNITY, YAML, COG.SCIENCE, ML for refresher.
Cleaned up the config archive, removing outdated and incompatible configs.
Added FAQ, GLOSSARY, and CHANGELOG markdown files for completeness.
Started work on a technical documentation on AAI backend development.
Updated README.md for a cleaner presentation and included a new features section, among others.
Useful links (Github issues, ML-Agents forum threads etc.)
Closes #37Closes #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)
[ ] Bug fix
[ ] New feature
[ ] Code refactor
[ ] Breaking change
[x] Documentation update
[x] Other (Overhaul of repository structure)
Checklist
[ ] Added tests that prove my fix is effective or that my feature works
[x] Updated the changelog (if applicable)
[x] Updated the documentation (if applicable)
[ ] Updated the migration guide (if applicable)
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).
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.mdis still a WIP/docs/gettingStarted/Getting-Started.mdis still a WIP (needs wider-team collaboration)/docs/Technical-Overview.mdis 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