Skip to content
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

Merged
merged 254 commits into from
Jan 25, 2024
Merged

Conversation

alhasacademy96
Copy link
Member

@alhasacademy96 alhasacademy96 commented Jan 16, 2024

Proposed change(s)

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 #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)

  • Bug fix
  • New feature
  • Code refactor
  • Breaking change
  • Documentation update
  • Other (Overhaul of repository structure)

Checklist

  • Added tests that prove my fix is effective or that my feature works
  • Updated the changelog (if applicable)
  • 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).

Screenshots (if any)

N/A

alhasacademy96 and others added 8 commits January 22, 2024 15:24
added another image of signposter with annotations per sign for completeness
added important note about adding documentation
removed redundant meessage
docs/Background-YAML.md Outdated Show resolved Hide resolved
Copy link
Member

@kozzy97 kozzy97 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@alhasacademy96

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.

docs/configGuide/Sample-Config-Tutorial.ipynb Outdated Show resolved Hide resolved
minor tweak
updated project aims and background after feedback from lucy
project/AAI-Versions-Archive.md Show resolved Hide resolved
project/AAI-RoadMap.md Show resolved Hide resolved
.github/pull_request_template.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
docs/gettingStarted/Arena-Environment-Guide.md Outdated Show resolved Hide resolved
docs/gettingStarted/Getting-Started.md Outdated Show resolved Hide resolved
docs/gettingStarted/Getting-Started.md Outdated Show resolved Hide resolved
docs/gettingStarted/Getting-Started.md Outdated Show resolved Hide resolved
docs/Arena-Object-Definitions.md Show resolved Hide resolved
Copy link
Member Author

@alhasacademy96 alhasacademy96 left a 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.

@alhasacademy96 alhasacademy96 self-assigned this Jan 24, 2024
@alhasacademy96 alhasacademy96 merged commit 0d8f474 into main Jan 25, 2024
1 check passed
@alhasacademy96 alhasacademy96 deleted the overhaul_docs branch January 25, 2024 12:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Documentation [High Level] Update GIFs in Readme Moveable Object Images Are Incorrect In Docs
5 participants