Fix misleading documentation for smart_resize backend_module parameter

[Flakes342]

Summary

Clarifies the backend_module parameter documentation in smart_resize() to prevent user confusion.

Changes

Updated the docstring for the backend_module parameter to clarify:

• It's primarily for internal use
• Should be left as None for typical usage
• Does not allow switching between TensorFlow/JAX/PyTorch backends

Motivation

Fixes issue #21711 where users attempt to pass keras.backend or other modules, resulting in AttributeError. The current documentation suggests this parameter offers more flexibility than it actually provides.

Current documentation & proposed change:

backend_module: Backend module to use (if different from the default
    backend).

Proposed change:

backend_module: Backend module to use (if different from the default
    backend). This parameter is primarily for internal use and should
    typically be left as None (default: `keras.src.backend`).
    Note: This does not allow switching between TensorFlow/JAX/PyTorch
    backends. Use `keras.config.set_backend()` to change the global backend.

Testing

• Documentation builds successfully
• Existing tests pass
• No functional changes, only documentation update

[gemini-code-assist]

Summary of Changes

Hello @Flakes342, 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 enhances the clarity of the smart_resize function's backend_module parameter documentation. The update aims to prevent common user errors and confusion by explicitly detailing the parameter's internal nature, its typical None usage, and its inability to switch Keras backends. This ensures users understand its intended purpose and avoid incorrect usage, ultimately improving the developer experience without altering any core functionality.

Highlights

• Documentation Clarity: The documentation for the backend_module parameter in the smart_resize function has been updated to prevent user confusion.
• Internal Use Clarification: The docstring now explicitly states that backend_module is primarily for internal use and should typically be left as None.
• Backend Switching Guidance: It clarifies that this parameter does not allow switching between TensorFlow/JAX/PyTorch backends, directing users to keras.config.set_backend() for that purpose.
• Issue Resolution: This change addresses issue #21711, which arose from users attempting to pass keras.backend or other modules, leading to AttributeError.
• No Functional Change: This pull request is a documentation-only update with no functional changes to the codebase.

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.

Footnotes

1. 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 clarifies the documentation for the backend_module parameter in smart_resize to indicate it's for internal use and shouldn't be used to switch backends. This is a helpful change to prevent user confusion. However, the implementation has a small but critical issue where the argument name backend_module: is removed from the docstring, which will likely break documentation generation. I've added a comment with a suggestion to fix this.

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.59%. Comparing base (94ca6ef) to head (7abb45d).

Additional details and impacted files

@@           Coverage Diff           @@
##           master   #21722   +/-   ##
=======================================
  Coverage   82.59%   82.59%           
=======================================
  Files         572      572           
  Lines       58401    58401           
  Branches     9146     9146           
=======================================
  Hits        48238    48238           
  Misses       7828     7828           
  Partials     2335     2335           

Flag	Coverage Δ
keras	82.40% <ø> (ø)
keras-jax	63.24% <ø> (ø)
keras-numpy	57.58% <ø> (ø)
keras-openvino	34.37% <ø> (ø)
keras-tensorflow	63.97% <ø> (ø)
keras-torch	63.56% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.