Ammr tutorial updates #1039
Ammr tutorial updates #1039
Conversation
…thing different than the default
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @JacobAdamsen, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
Summary of Changes
This pull request focuses on updating the AMMR tutorials related to scaling. It involves moving the scaling introduction from the 'Guides' section to the 'Body models' section and relocating the scaling lessons to the 'Tutorials' section. The pull request also includes modifications to the scaling tutorial lessons, providing more detailed instructions and updated code snippets, and adding a new media file.
Highlights
- Documentation Restructuring: The scaling introduction has been moved from the 'Guides' section to the 'Body models' section, and the scaling lessons have been relocated to the 'Tutorials' section.
- Tutorial Updates: The scaling tutorial lessons have been updated with more detailed instructions, updated code snippets, and new images to improve clarity and user experience.
- Code Modifications: Code snippets within the scaling lessons have been modified to reflect the updated instructions and provide more accurate examples.
Changelog
Click here to see the changelog
- Docs/Applications/Other/StandingModelScalingDisplay.md
- Updated the link to the scaling tutorial to point to the new location.
- Docs/Deleted/Scaling/intro.md
- Moved the scaling introduction content to a new location and added a note indicating the move.
- Docs/Deleted/Scaling/lesson1.md
- Updated the content of Lesson 1 with more detailed instructions, code snippets, and new images.
- Adjusted code examples and explanations for clarity and accuracy.
- Docs/Deleted/Scaling/lesson2.md
- Minor edits to lesson 2 to reflect changes in lesson 1
- Docs/Deleted/Scaling/lesson3.md
- Minor edits to lesson 3 to reflect changes in lesson 1
- Docs/FullHuman_media.any
- Added a new media file path for video creation.
- Docs/Scaling_.md
- Created a new file for the scaling documentation, containing the introduction and basic information.
- Docs/anymocap/grf-prediction.md
- Minor edits to reflect the move of the scaling tutorials
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
In AnyScript's realm, models scale,
From giants tall to sprites so frail.
With scaling laws,
Defying all flaws,
Virtual humans never fail.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
|
/gemini review |
There was a problem hiding this comment.
Code Review
The pull request involves updates to the AMMR tutorials, focusing on scaling. The changes include moving content, updating links, and revising explanations in the scaling tutorials. The updates seem well-intentioned, but there are a few areas where clarity and correctness could be improved.
Summary of Findings
- Inconsistent terminology: The tutorials use both 'outcommenting' and 'commenting out' to describe the same action. Using consistent terminology improves clarity.
- Broken links: There are instances where links are broken or point to incorrect locations. These need to be corrected to ensure users can access the intended resources.
- Clarity of instructions: Some instructions are unclear or assume prior knowledge, which may confuse new users. Instructions should be explicit and easy to follow.
Merge Readiness
The pull request requires changes before merging. The issues identified, particularly broken links and unclear instructions, need to be addressed to ensure the tutorials are accurate and easy to follow. I am unable to approve this pull request, and recommend that another reviewer also review this code before merging. At a minimum, the high severity issues should be addressed before merging.
| // #define BM_SCALING _SCALING_STANDARD_ | ||
| §// #define BM_SCALING _SCALING_NONE_ |
There was a problem hiding this comment.
These lines are commented out, but the text below refers to them as if they are active. Either uncomment them or update the text to reflect that they are examples.
| // #define BM_SCALING _SCALING_STANDARD_ | |
| §// #define BM_SCALING _SCALING_NONE_ | |
| Main.HumanModel.Anthropometrics.BodyHeight = 1.8; | |
| Main.HumanModel.Anthropometrics.BodyMass = 80;§ |
There was a problem hiding this comment.
Code Review
The pull request updates the AMMR tutorials, focusing on scaling and AnyMoCap frameworks. The changes involve moving and reorganizing documentation, updating links, and refining explanations within the scaling tutorials. The addition of video path configuration in FullHuman_media.any is also noted. Overall, the changes aim to improve the clarity, accuracy, and accessibility of the AMMR documentation.
Summary of Findings
- Inconsistent Terminology: The term 'Joint to joint' is sometimes written as 'Joint to Joint' and other times as 'Joint to joint'. Consistent capitalization should be used throughout the documentation.
- Broken Hyperlink: The hyperlink in
Docs/Applications/Other/StandingModelScalingDisplay.mdshould be checked to ensure it is working. - Ambiguous Language: In
Docs/Deleted/Scaling/lesson1.md, the phrase 'RunApplication operation from the Operations tab' is ambiguous. It should be clarified to 'RunApplication operation from the Operations tab in AMS' to ensure the user knows where to find it.
Merge Readiness
The pull request is well-structured and aims to improve the documentation of the AMMR tutorials. However, there are a few issues that should be addressed before merging. The inconsistent terminology and ambiguous language should be fixed to ensure clarity. The broken hyperlink should also be checked and corrected. Once these issues are addressed, the pull request will be ready for merging. I am unable to directly approve this pull request, and recommend that others review and approve this code before merging.
Rearrangement of content in AMMR. Moved some chapters around, created a new "Deleted" folder containing chapters which are moved to the "Tutorials" or just incorporated into other chapter.