metrics: Use Array and ArrayLike types thoughout#278
Open
copybara-service[bot] wants to merge 1 commit intomainfrom
Open
metrics: Use Array and ArrayLike types thoughout#278copybara-service[bot] wants to merge 1 commit intomainfrom
copybara-service[bot] wants to merge 1 commit intomainfrom
Conversation
6bec892 to
77471a2
Compare
Currently the inputs to `from_model_output` are not typed. However, these functions cannot accept arbitrary inputs, they need to be a value convertable to a `jax.Array`. This change fixes this so that: - `from_model_output` takes in types of `Array` or `ArrayLike` - Removes use of `jnp.array` as a type as it's equivalent to `Any` - Makes members of Metric classes have type `Array` - Moves mask checking code into its own function While we could make everything use `Array` (instead of `ArrayLike`), this would break code like: ``` @flax.struct.dataclass class Collection(metrics.Collection): train_accuracy: metrics.Accuracy learning_rate: metrics.LastValue.from_output("learning_rate") Collection.gather_from_model_output(learning_rate=0.02, ...) ``` which seems undesirable. Note that `count` and `value` for `LastValue` have type `ArrayLike`, as this code needs to support passing a plain number for `value` or `count`. Also, the base `Metric.compute()` method has type `Any`, because some metrics return `Array` while others use `dict[str, Array]`. PiperOrigin-RevId: 529227218
77471a2 to
b515d75
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
metrics: Use Array and ArrayLike types thoughout
Currently the inputs to
from_model_outputare not typed. However,these functions cannot accept arbitrary inputs, they need to be a value
convertable to a
jax.Array. This change fixes this so that:from_model_outputtakes in types ofArrayorArrayLikejnp.arrayas a type as it's equivalent toAnyArrayWhile we could make everything use
Array(instead ofArrayLike),this would break code like:
which seems undesirable.
Note that
countandvalueforLastValuehave typeArrayLike,as this code needs to support passing a plain number for
valueorcount. Also, the baseMetric.compute()method has typeAny,because some metrics return
Arraywhile others usedict[str, Array].