Tutorial renames of Motion Capture Movement#39
Conversation
![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 renaming and updating the 'Making things Move' tutorial to 'Motion Capture Movement'. It reorganizes the lessons, incorporates new content, and generally updates the tutorial material. The previous Lesson 5 is moved to Lesson 1, and the original Lesson 1 is deleted, with its content integrated into other tutorials.
Highlights
- Tutorial Rename: The 'Making things Move' tutorial is renamed to 'Motion Capture Movement' to better reflect its content.
- Lesson Reorganization: Lesson 5 from the original tutorial is moved to become the new Lesson 1, focusing on using real motion capture data.
- Content Update: The tutorial content is generally updated, including modifications to the pendulum model and the addition of new explanations and instructions.
- Lesson Deletion: The original Lesson 1 is deleted, with its relevant information moved to other tutorials.
Changelog
Click here to see the changelog
- Making_things_move/index.md
- Complete removal of the index file for the old 'Making things move' tutorial.
- Motion_Capture_Movement/Downloads/pendulum.any
- Added AnyKinMotion JointDriver to drive the pendulum's revolute joint with a polynomial function.
- Motion_Capture_Movement/index.md
- Creation of a new index file for the 'Motion Capture Movement' tutorial, outlining the tutorial's objectives and structure.
- Motion_Capture_Movement/intro.md
- Commented out the download instruction for pendulum.any from the introduction.
- Motion_Capture_Movement/lesson1.md
- Renamed 'Lesson 5: Using real data' to 'Lesson 1: Using real data'.
- Added introductory content explaining the use of motion capture data and C3D files in biomechanics.
- Updated image paths from
_static/lesson5/to_static/lesson1/. - Modified text to reflect the lesson's new position and content.
- Motion_Capture_Movement/lesson1Deleted.txt
- Added a DELETED tag to the title of the deleted lesson.
- Minor text edits for clarity.
- Motion_Capture_Movement/lesson2.md
- Rewrote the introduction to focus on building a simple model driven by motion capture data.
- Added instructions for downloading the pendulum model and C3D file.
- Replaced references to AnyKinMotion with a reference to a prior tutorial.
- Added a section on driving the pendulum using motion capture data.
- Updated code snippets and explanations for using AnyInputC3D.
- Added instructions for using AnyKinDriverMarker to drive the pendulum with marker data.
- Added information about degrees of freedom and how to handle over-constrained systems.
- Added instructions for removing unnecessary markers and improving performance.
- Added instructions for drawing the marker from the C3D file and the point on the pendulum simultaneously.
- Added a section on kinematic constraints.
- Motion_Capture_Movement/lesson3.md
- Updated lesson title to 'Lesson 3: Noise and filters'.
- Added an introductory sentence about the lesson's focus.
- Replaced image references with restructured text image directives.
- Added a section on filtering the motion capture data to reduce noise.
- Added a description of the filter parameters and their effects.
- Added instructions for activating the filter section in the AnyInputC3D object.
- Added instructions for adjusting the cutoff frequency to improve the results.
- Motion_Capture_Movement/lesson4.md
- Added a section on building the initial model.
- Added a section on setting up the parameter optimization study.
- Added a section on including the marker positions in the parameter optimization.
- Updated image references to restructured text image directives.
- Modified text to reflect the lesson's new content and structure.
- Added a description of the AnyOptKinStudy and its parameters.
- Added instructions for running the parameter optimization and interpreting the results.
- Added instructions for saving and loading the optimized joint location.
- Added a discussion of the limitations of the parameter optimization approach.
- Removed the reference to Lesson 5 and replaced it with a reference to troubleshooting C3D files in Lesson 5.
- Motion_Capture_Movement/lesson5.md
- Renamed 'Lesson 6: Troubleshooting C3D files' to 'Lesson 5: Troubleshooting C3D files'.
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 AnyBody's realm, models stride,
Driven by data, deep inside.
Mocap's dance, a digital grace,
Brings biomechanics to this place.
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. ↩
There was a problem hiding this comment.
Code Review
The pull request involves renaming the "Making things Move" tutorial to "Motion Capture Movement", reorganizing the lessons, and updating the content. Overall, the changes seem well-structured and aim to improve the clarity and relevance of the tutorial. However, there are several areas where improvements can be made, particularly in terms of consistency, clarity, and accuracy.
Summary of Findings
- Inconsistent Lesson Numbering: The tutorial renames and lesson reordering introduce some inconsistencies in lesson numbering and references. Ensure that all references to lessons are updated to reflect the new structure.
- Image Path Updates: Several image paths are updated from
_static/lesson5/...to_static/lesson1/.... Verify that these paths are correct and that the images are accessible in the new locations. - Clarity of Instructions: Some instructions, especially in
lesson4.md, could be clearer. For example, the initial steps for creating a new Main file could be more detailed. - File Deletion Artifacts: The file
Motion_Capture_Movement/lesson1Deleted.txtcontains the content of the deleted lesson, but it's not clear why this file is included in the pull request. It might be better to remove it or clarify its purpose.
Merge Readiness
While the changes generally improve the tutorial, several issues need to be addressed before merging. Specifically, the inconsistencies in lesson numbering, image paths, and clarity of instructions should be resolved. Additionally, the purpose of the lesson1Deleted.txt file should be clarified or the file should be removed. I am unable to directly approve this pull request, and other reviewers should review and approve this code before merging. Given the presence of medium and high severity issues, I recommend that this pull request not be merged until these are addressed.
2 participants
Renamed the previously Making things Move tutorial to Motion Capture Movement.
Moved previous Lesson 5 up to be new Lesson 1.
Previous Lesson 1 is deleted. The important information from this lesson is moved to other tutorials, e.g. to How to Write AnyScript Lesson 5.
Generally updated the tutorial
Should Lesson 1 and 2 be renamed?
NOT a complete update of the tutorial "Motion Capture Movement". Could use further updates of its general content and use of Code Snippets for test of models.