Fix formatting issues in the Orbax guide #2170
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @SamanehSaadat, 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!
This pull request focuses on enhancing the readability and cleanliness of the Orbax checkpoint guide. It addresses minor formatting inconsistencies by adding blank lines to improve the presentation of numbered lists and removes an irrelevant RuntimeWarning message that was inadvertently included in the guide's output examples. These changes aim to make the documentation clearer and more professional.
Highlights
- Improved list formatting: Blank lines were inserted before numbered list items in both the Markdown guide and its corresponding Python file to enhance readability and adhere to common formatting standards.
- Removed extraneous warning message: A
RuntimeWarningrelated toos.fork()and JAX's multithreading, which was erroneously printed in a code output block within the Markdown guide, has been removed.
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 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
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.
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
This pull request cleans up the Orbax checkpointing guide by improving list formatting for better readability and removing a distracting warning message from an output example. The changes are beneficial. I've left one comment pointing out that a generated file seems to be out of sync with the source, which should be addressed to ensure consistency.
| We need to create two main utilities to manage Orbax checkpointing in Keras: | ||
| 1. `KerasOrbaxCheckpointManager`: A wrapper around | ||
| `orbax.checkpoint.CheckpointManager` for Keras models. | ||
| `KerasOrbaxCheckpointManager` uses `Model`'s `get_state_tree` and | ||
| `set_state_tree` APIs to save and restore the model variables. | ||
| 2. `OrbaxCheckpointCallback`: A Keras callback that uses | ||
| `KerasOrbaxCheckpointManager` to automatically save and restore model states | ||
| during training. |
There was a problem hiding this comment.
While the added spacing here improves readability, it appears the corresponding Jupyter notebook file (guides/ipynb/orbax_checkpoint.ipynb) has not been regenerated to reflect this change. Since this Python script acts as the source, please ensure all generated artifacts are updated for consistency.
There was a problem hiding this comment.
The formatting issue doesn't appear on the ipynb file so we don't need to update that.
guides/orbax_checkpoint.py
Outdated
| `orbax.checkpoint.CheckpointManager` for Keras models. | ||
| `KerasOrbaxCheckpointManager` uses `Model`'s `get_state_tree` and | ||
| `set_state_tree` APIs to save and restore the model variables. | ||
There was a problem hiding this comment.
Do we need that newline? Won't that cause Markdown to restart the count to 1. ?
There was a problem hiding this comment.
It looked fine when I locally brought it up but we probably don't need it, let me render it again without a newline between numbers.
3 participants
Formatting issue:
Also removed a warning that was printed in the
.mdfile.