feat: Add overload signatures to module.apply #4783
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
The
apply
method returns either the output or atuple[output, dict]
depending onmutable
(incore.apply
).flax/flax/core/scope.py
Lines 1080 to 1083 in 7d4a288
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 typeModule.apply
correctly.This PR adds two typing.overload signatures to
Module.apply
to differentiate these cases - when to expect a tuple and when notSee also #2086 as a related discussion.
Resolves:
#4779
Checklist
checks if that's the case).
discussion (please add a
link).