-
Notifications
You must be signed in to change notification settings - Fork 2
Optimisation tutorial updates #44
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
Conversation
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.
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 "Parameter Studies and Optimization" tutorial, specifically the "Optimization Studies" lesson. The primary goal is to ensure the models in the lesson function correctly and produce reasonable results. Additionally, the PR includes minor updates and a refresh of several images within the tutorial.
Highlights
- Model Stabilization: Ensured that the models within the "Optimization Studies" lesson work correctly and produce expected results.
- Tutorial Updates: Made minor updates throughout the tutorial, including text adjustments and image replacements.
- Chart Enhancements: Replaced references to 'Chart Settings' with 'Property Window' for clarity and updated instructions for chart manipulation.
- Image Updates: Replaced and updated multiple images within the tutorial to improve visual clarity and relevance.
Changelog
Click here to see the changelog
- Parameter_studies_and_optimization/lesson1.md
- Added spacing for image in note for turning off model view to speed up computation (lines 282-284).
- Added width attribute to AnyChart 3 and AnyChart 4 images (lines 339 and 355).
- Replaced text referring to chart settings button with a reference to the Property Window (line 345).
- Parameter_studies_and_optimization/lesson2.md
- Replaced
scale
attribute withwidth
attribute for the Metabolic efficiency example image (line 71). - Rephrased instructions for running the optimization study for better clarity (lines 147-152).
- Updated the number of iterations expected in the optimization process from 4 to 6 (line 156).
- Modified instructions for opening Chart2, using
View
->Charts
->Chart2
instead ofView
->Charts
->Chart2
(line 174). - Updated the number of iterations mentioned when plotting metabolism over iterations from 4 to 6 (line 177).
- Removed
class: bg-primary
from the final model view image (line 200). - Changed "New" to "Add" when referring to adding a new series in the chart (line 213).
- Added width attribute to the Chart New Series image (line 219).
- Replaced instructions for changing the color of the line in the chart with instructions that refer to the Property Window (lines 234-239).
- Clarified that the plot illustrates convergence history (line 249).
- Replaced
Type = GreaterThanZero
withType = GreaterThanZero
(line 327). - Added width attribute to the Metab value vs Steps image (line 352).
- Added width attribute to the opt Study constrained image (line 362).
- Added width attribute to the SeatDist vs Steps image (line 378).
- Removed
class: bg-primary
from the Final model view 2 image (line 396).
- Replaced
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.
A saddle's height,
A metabolic quest,
Optimization's path.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
The pull request updates the optimization tutorial, securing models and updating images. The changes seem reasonable and improve the clarity of the tutorial. Here are some suggestions for improvement.
Summary of Findings
- Inconsistent Terminology: The tutorial uses both 'Property Window' and 'chartsettings' button to refer to the same element. Maintaining consistency in terminology will improve clarity.
- Minor Grammatical Issues: There are a few instances of minor grammatical errors, such as missing words or typos, that should be corrected for improved readability.
- Inaccurate Iteration Count: The iteration count was updated from 4 to 6 in one section but not consistently updated in other related sections, leading to potential confusion.
Merge Readiness
The pull request is almost ready for merging. Addressing the identified issues, particularly the terminology inconsistencies and grammatical errors, will further enhance the quality and clarity of the tutorial. I am unable to approve the pull request in any circumstance, and users should have others review and approve this code before merging. Once these points are addressed, the pull request should be in good shape to be merged.
you change the scale of the value axis. This and all other settings are | ||
available if you click | ||
the  | ||
button in the toolbar. Doing so will produce a window with a tree view | ||
available if you open the Property Window | ||
 | ||
in the toolbar. Doing so will produce a window with a tree view |
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.
To maintain consistency, consider using 'Property Window' throughout the tutorial instead of switching between 'Property Window' and referring to the button name directly. Is there a way to refer to the Property Window in a more generic way?
you change the scale of the value axis. This and all other settings are | |
available if you click | |
the  | |
button in the toolbar. Doing so will produce a window with a tree view | |
available if you open the Property Window | |
 | |
in the toolbar. Doing so will produce a window with a tree view | |
available if you open the Property Window | |
 | |
in the toolbar. Doing so will produce a window with a tree view |
Made sure the models in the lesson "Optimization Studies" in tutorial "Parameter Studies and Optimization" works and produces reasonable results.
Also made some minor updates in the tutorial. Updated a lot of images.