metrics: Use Array and ArrayLike types thoughout #278
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_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 ofArray
orArrayLike
jnp.array
as a type as it's equivalent toAny
Array
While we could make everything use
Array
(instead ofArrayLike
),this would break code like:
which seems undesirable.
Note that
count
andvalue
forLastValue
have typeArrayLike
,as this code needs to support passing a plain number for
value
orcount
. Also, the baseMetric.compute()
method has typeAny
,because some metrics return
Array
while others usedict[str, Array]
.