-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Add keras nnx guide to guides master #2164
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
Add keras nnx guide to guides master #2164
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.
Summary of Changes
Hello @divyashreepathihalli, 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 introduces a new guide to the Keras documentation. The primary purpose of this change is to provide users with comprehensive instructions on how to effectively utilize Keras with the NNX backend. By adding this guide, the project aims to enhance user understanding and facilitate smoother integration of Keras with this specific backend, thereby improving the overall documentation and user experience.
Highlights
- New Guide Integration: A new entry for "How to use Keras with NNX backend" has been added to the
guides_master.pyscript. This addition integrates the new guide into the main documentation structure, making it accessible to users.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request adds a new developer guide for using Keras with the Flax NNX backend. The change correctly adds an entry for the new guide to the guides_master.py configuration file. My feedback includes a suggestion to adjust the title of the new guide for better stylistic consistency with other guides in the list and with the content of the guide itself.
| }, | ||
| { | ||
| "path": "keras_nnx_guide", | ||
| "title": "How to use Keras with NNX backend", |
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.
For consistency with other guide titles in this list, which are typically concise noun or gerund phrases (e.g., 'The Functional API', 'Distributed training with Keras 3'), consider rephrasing this. A title like 'Keras and NNX Integration' would align better with the existing style, improve scannability, and be more consistent with the guide's own H1 ('A Guide to the Keras & Flax NNX Integration').
| "title": "How to use Keras with NNX backend", | |
| "title": "Keras and NNX Integration", |
No description provided.