Add backend compatibility table to documentation #21733
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
Summary of ChangesHello @MalyalaKarthik66, 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 enhances the project's documentation by introducing a comprehensive backend compatibility table within the Highlights
Using Gemini Code AssistThe 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 by creating a comment using either
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 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
Thank you for adding the backend compatibility table to the documentation. This is a valuable addition for users. I've provided a couple of suggestions to improve clarity and prevent potential confusion for developers working with the source code, mainly regarding the discrepancy between the versions listed and those in the requirements.txt files, and the format of the 'Detailed Compatibility' section.
| | JAX | 0.4.20 | | ||
| | PyTorch | 2.1.0 | | ||
|
|
||
| > **Note:** These versions are verified to be compatible with the latest stable release of Keras 3, according to the official documentation. |
There was a problem hiding this comment.
The backend versions in the table are quite different from those in the requirements.txt files, which could confuse developers setting up a local environment. To clarify this, I suggest expanding this note to mention that the requirements.txt files should be used for development environments.
| > **Note:** These versions are verified to be compatible with the latest stable release of Keras 3, according to the official documentation. | |
| > **Note:** These versions are verified to be compatible with the latest stable release of Keras 3, according to the official documentation. For setting up a development environment, please refer to the versions specified in the `requirements.txt` files. |
| ### Detailed Compatibility | ||
|
|
||
| - **JAX:** `jax==0.4.20 & keras==3.0` | ||
| - **TensorFlow:** `tensorflow==2.16.1 & keras==3.0` | ||
| - **PyTorch:** `torch==2.1.0 & keras==3.0` | ||
|
|
||
|
|
There was a problem hiding this comment.
This "Detailed Compatibility" section is redundant with the table above and uses a confusing format. The & symbol in jax==0.4.20 & keras==3.0 is not standard for specifying package versions and might be misinterpreted as a shell operator.
I recommend removing this section to improve clarity and reduce redundancy. The table and the note on line 69 provide sufficient information.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #21733 +/- ##
==========================================
+ Coverage 82.55% 82.59% +0.04%
==========================================
Files 571 572 +1
Lines 57628 58535 +907
Branches 9002 9158 +156
==========================================
+ Hits 47572 48345 +773
- Misses 7760 7853 +93
- Partials 2296 2337 +41
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Thanks for the PR. This information is going to get out of date really fast. |
4 participants
Added a table showing compatible JAX, TensorFlow, and PyTorch versions for Keras as requested in Issue #21730.
This improves clarity for users on which backend versions are supported, helping prevent version conflicts and making it easier to start with Keras.