Skip to content

feat: Add overload signatures to module.apply #4783

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Daraan
Copy link

@Daraan Daraan commented Jun 18, 2025

What does this PR do?

The apply method returns either the output or a tuple[output, dict] depending on mutable (in core.apply).

flax/flax/core/scope.py

Lines 1080 to 1083 in 7d4a288

if mutable is not False:
return y, root.mutable_variables()
else:
return y

The current type hints are were general in the return type -> Any | tuple[Any, FrozenVariableDict | dict[str, Any]]: which can be confusing lead to type-checking errors. A related SO question how to type Module.apply correctly.

This PR adds two typing.overload signatures to Module.apply to differentiate these cases - when to expect a tuple and when not

See also #2086 as a related discussion.

Resolves:
#4779

Checklist

  • This PR fixes a minor issue (e.g.: typo or small bug) or improves the docs (you can dismiss the other
    checks if that's the case).
  • This change is discussed in a Github issue/
    discussion (please add a
    link).

Copy link

google-cla bot commented Jun 18, 2025

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant