Remove Keras 2 guides from rendering #2259

sachinprasadhs · 2026-01-22T01:02:33Z

Remove Keras 2 Examples from Rendering
This PR updates the documentation generation system to filter Keras 2 examples, ensuring that only Keras 3 content is displayed on keras.io. By adding a Keras_2 tag, legacy guides remain in the repository for future migration reference but will no longer be rendered on the website.
Moved all of the existing examples from others section to it's appropriate section.

gemini-code-assist · 2026-01-22T01:02:53Z

Summary of Changes

Hello @sachinprasadhs, I'm Gemini Code Assist¹! 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 streamlining the documentation and examples by removing Keras 2 specific content from the rendering process. It achieves this by systematically tagging Keras 2 examples and modifying the content generation script to filter them out, ensuring that only Keras 3 relevant guides are displayed. This change helps maintain a consistent and up-to-date resource for users.

Highlights

Keras 2 Example Tagging: Numerous existing examples across various categories have been explicitly tagged with a 'keras_2: True' flag in scripts/examples_master.py to identify them as Keras 2 specific content.
Conditional Rendering Logic: The scripts/autogen.py script has been updated to include logic that prevents the rendering of any example marked with 'keras_2: True', effectively removing Keras 2 guides from the generated output.
Empty Subcategory Removal: The rendering process now automatically removes subcategories that become empty after Keras 2 examples are filtered out, ensuring a cleaner presentation.
New Keras 3 Example: A new Keras 3 example titled 'MultipleChoice Task with Transfer Learning' has been added to the text classification category.
Gitignore Update: The .gitignore file has been updated to include templates/examples/keras_rs/*, likely to prevent new Keras 3 related examples from being tracked or to ignore temporary files.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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.

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. ↩

gemini-code-assist

Code Review

This pull request updates the documentation generation scripts to filter out Keras 2 examples from the examples landing page. This is achieved by adding a keras_2 flag to the relevant examples in scripts/examples_master.py and then modifying scripts/autogen.py to skip these examples during rendering. The changes also include logic to handle categories and subcategories that become empty after filtering.

The implementation is mostly correct and achieves the intended goal. I've left one comment in scripts/autogen.py with a suggestion to simplify a part of the code for better readability and maintainability.

scripts/autogen.py

jeffcarp

Thanks! Have we confirmed that all of the Keras 2 guides are not able to be updated to Keras 3? If we're not certain, it might be better to add a warning at the top of the Keras 2 guides until we can confirm. Also re: Fabien's point, I think we should keep rendering the pages, but maybe just remove them from the navigation?

jeffcarp · 2026-01-22T17:18:28Z

scripts/autogen.py

+                            {
+                                "path": example_path,
+                                "title": title.strip(),
+                                "keras_3": True,


Instead of separate keys for keras_2 and keras_3, it feels cleaner to have a keras_version key that can be 2 or 3

The reason I introduced Keras_2 is, we already have a Keras_3 key, based on that the examples are loading the information like this https://keras.io/examples/nlp/multimodal_entailment/

Assuming this Keras_2 key is only temporary, till we figure out the fate of each examples, either to remove it or migrate it.

Ah gotcha, if a guide is not keras_3 does that mean 100% the time it's Keras 2? In that case do we even need a new key?

Is this still necessary given the most recent changes? Logically it seems like we only need the keras_2 key.

sachinprasadhs · 2026-01-22T19:15:03Z

Thanks for the review.
Warning sounds good, does something like "Warning: This example is legacy and may be removed in future updates. It is no longer guaranteed to function correctly. Please refer to the Keras 3 examples instead." works, right under where we have "This example uses Keras 2 like this https://keras.io/examples/vision/near_dup_search/?

When you mentioned remove from navigation, you mean to remove from here https://keras.io/examples/?
If we remove from examples_master.py for these examples, this also will remove from rendering the pages as per the current implementation.

jeffcarp · 2026-01-28T19:29:10Z

Sorry for the delay - ah I see, so it looks like we already automatically apply a warning to Keras 2 guides:

keras-io/scripts/autogen.py

Line 468 in f4ebbf6

    
           f"<div class='example_version_banner keras_{version}'>ⓘ This example uses Keras {version}</div>",

In that case, expanding on the warning sounds good. How about something like:

if version == 2:
  md_content_lines.insert(
    ... (
        "Warning: This example uses Keras 2 and may not be compatible with the latest version of Keras. "
        "Please check out all of our <a href="https://keras.io/examples/">Keras 3 examples here</a>."
    )

If we remove from examples_master.py for these examples, this also will remove from rendering the pages as per the current implementation.

Would it be possible to decouple this so the pages still render but they don't show up in the navigation? That sounds like a smoother step forward.

sachinprasadhs · 2026-01-30T08:53:57Z

Added the warning message as suggested, and now it only renders keras 3 examples in landing page and in the navigation keras 2 examples will be loaded and it will show the warning.

Added the below screenshots for reference.

Keras 2 example with warning:

jeffcarp

Thanks Sachin! Looks good, just left a comment about potential simplification.

jeffcarp · 2026-01-30T17:47:03Z

scripts/autogen.py

+                            {
+                                "path": example_path,
+                                "title": title.strip(),
+                                "keras_3": True,


Is this still necessary given the most recent changes? Logically it seems like we only need the keras_2 key.

sachinprasadhs · 2026-01-30T22:25:43Z

This block is necessary as a fallback mechanism. If a new example is added to keras.io but isn't explicitly updated in examples_master.py, this script ensures it is still pulled from the src directory and listed under the Others category. By setting Keras_3 to True, we ensure these new examples are correctly tagged as Keras 3 by default, preventing the previous issue where they were incorrectly labeled as Keras 2."

jeffcarp

Got it - thanks for the clarification. Left one more comment

jeffcarp · 2026-02-04T23:29:58Z

scripts/autogen.py

+                            if version == 2:
+                                md_content_lines.insert(
+                                    i + 1,
+                                    "<div class='example_keras2_warning'><strong>Warning:</strong> This example uses Keras 2 and may not be compatible with the latest version of Keras. Please check out all of our <a href=\"https://keras.io/examples/\">Keras 3 examples here</a>.</div>",


I just realized won't this be duplicative with the warning above? I.e. it will show:
This example uses Keras 2
Warning: This example uses Keras 2 and

Can you make it so that there's only one message for 3 and one message for 2?

There is no extra message for Keras 3, this warning message is only for Keras 2 tutorials.
Shall I rephrase the warning message like

"Warning: This example is legacy and may be removed in future updates. It is no longer guaranteed to function correctly. Please refer to our Keras 3 examples here"

Right, but for Keras 2 there are still two separate messages, right? Can you restructure so there's only one message for both? Something like:

if version == 3: md_content_lines.insert( {keras 3 message} ) elif version == 2: md_content_lines.insert( {keras 2 message} )

Just to clarify.

Currently this is how we are rendering for Keras 3 example( Banner after description): https://keras.io/examples/vision/image_classification_from_scratch/

For Keras 2 example:
https://keras.io/examples/vision/retinanet/

With the changes in this PR, for this banner, the only extra thing is getting added is a warning message(after Keras 2 banner) for Keras 2 examples like below image

So, if I'm understanding it correctly, you are suggesting to replace Keras 2 warning message from "ⓘ This example uses Keras 2" to

( "Warning: This example uses Keras 2 and may not be compatible with the latest version of Keras. " "Please check out all of our <a href="https://keras.io/examples/">Keras 3 examples here</a>." )

If we are replacing this above message in banner, it would be too big, we may have to shorten the message.

Thanks for the visual explanation - yes that sounds good, I think it makes sense to move the 2nd Keras 2 message up into the yellow text box so it's more prominent to users. Would the text be able to fit if we added line breaks (<br/>) in the right places?

It looks like this

Shall I commit this change?

Looks good, thanks!

Pushed the change, please review it.

jeffcarp · 2026-02-10T22:55:49Z

Thanks for your patience! Lgtm

sachinprasadhs added 3 commits January 21, 2026 13:53

comment Keras 2 examples

fcafa96

update gitignore

0b8dcb2

update examples master with missing examples

cbf3bd6

github-actions bot assigned sachinprasadhs Jan 22, 2026

gemini-code-assist bot reviewed Jan 22, 2026

View reviewed changes

scripts/autogen.py Outdated Show resolved Hide resolved

address gemini comment

59c0ea4

sachinprasadhs requested review from divyashreepathihalli and jeffcarp January 22, 2026 04:43

jeffcarp reviewed Jan 22, 2026

View reviewed changes

sachinprasadhs added 2 commits January 30, 2026 00:03

Merge branch 'keras-team:master' into remove_guides

023c245

add warning message

832e36c

jeffcarp reviewed Jan 30, 2026

View reviewed changes

jeffcarp reviewed Feb 4, 2026

View reviewed changes

move banner text

c48b441

jeffcarp approved these changes Feb 10, 2026

View reviewed changes

jeffcarp merged commit 5221bab into keras-team:master Feb 10, 2026
3 checks passed

sachinprasadhs deleted the remove_guides branch February 10, 2026 23:31

Remove Keras 2 guides from rendering #2259

Remove Keras 2 guides from rendering #2259

Conversation

sachinprasadhs commented Jan 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gemini-code-assist bot commented Jan 22, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

jeffcarp left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sachinprasadhs commented Jan 22, 2026

Uh oh!

jeffcarp commented Jan 28, 2026

Uh oh!

sachinprasadhs commented Jan 30, 2026

Uh oh!

jeffcarp left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sachinprasadhs commented Jan 30, 2026

Uh oh!

jeffcarp left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jeffcarp Feb 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jeffcarp commented Feb 10, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

sachinprasadhs commented Jan 22, 2026 •

edited

Loading

jeffcarp Feb 5, 2026 •

edited

Loading