-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Add Keras NNX guide #2159
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 #2159
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!
I've added a new guide that details the integration of Keras with Flax's NNX module system. This guide aims to show how Keras can leverage NNX for enhanced variable handling and advanced training capabilities within the JAX ecosystem. It covers the setup, demonstrates the core integration of Keras variables with NNX, and illustrates both the classic Keras model.fit workflow and custom training loops using NNX. The guide also includes sections on model saving/loading and a practical example of fine-tuning a Gemma model.
Highlights
- Introduction of Keras-NNX Integration Guide: I've added a new comprehensive guide that details the integration of Keras with Flax's NNX module system, explaining the benefits of combining Keras's user-friendliness with JAX's performance and NNX's explicit state management.
- Demonstration of Keras Variable Compatibility with NNX: The guide demonstrates how
keras.Variableinstances are fully recognized and managed by NNX's state management, allowing for seamless mixing of Keras and NNX components. - Dual Training Workflow Support: I've included examples for both the familiar
model.fit()API for high-level training and custom JAX/NNX training loops for fine-grained control over the gradient and update process. - Model Persistence and Real-World Application: The guide covers standard model serialization (saving and loading) with NNX enabled and provides a real-world application example of loading and fine-tuning a Gemma model from KerasHub.
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 or fill out our survey 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.
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 introduces a new guide on using Keras with the Flax NNX backend. The guide is comprehensive and covers enabling NNX mode, using Keras Variables within NNX, training with both model.fit and custom loops, saving/loading models, and a real-world example with Gemma. My review includes suggestions to improve code style by consolidating imports, correcting the usage of nnx.grad to align with the public API, and fixing a typo and formatting in the conclusion to enhance clarity.
hertschuh
left a comment
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.
Can you run autogen and add the ipynb and md files?
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
abheesht17
left a comment
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.
Thanks!
No description provided.