jax.typing 模块#

JAX 类型模块是 JAX 特定的静态类型注释所在的位置。此子模块正在开发中；要查看此处导出的类型背后的提案，请参阅 https://jax.ac.cn/en/latest/jep/12049-type-annotations.html。

当前可用的类型是

  • jax.Array：任何 JAX 数组或跟踪器的注释（即 JAX 转换中数组的表示）。

  • jax.typing.ArrayLike：任何可以安全隐式转换为 JAX 数组的值的注释；这包括 jax.Array、numpy.ndarray，以及 Python 内置数值（例如 int、float 等）和 numpy 标量值（例如 numpy.int32、numpy.float64 等）

  • jax.typing.DTypeLike：用于可转换为 JAX 兼容 dtype 的任何值的注解；这包括字符串（例如 ‘float32’、‘int32’），标量类型（例如 float、np.float32），dtype（例如 np.dtype(‘float32’)），或具有 dtype 属性的对象（例如 jnp.float32、jnp.int32）。

我们可能会在未来的版本中在此处添加其他类型。

JAX 类型标注最佳实践#

在公共 API 函数中注解 JAX 数组时，我们建议对数组输入使用 ArrayLike，对数组输出使用 Array。

例如，您的函数可能如下所示：

import numpy as np
import jax.numpy as jnp
from jax import Array
from jax.typing import ArrayLike

def my_function(x: ArrayLike) -> Array:
  # Runtime type validation, Python 3.10 or newer:
  if not isinstance(x, ArrayLike):
    raise TypeError(f"Expected arraylike input; got {x}")
  # Runtime type validation, any Python version:
  if not (isinstance(x, (np.ndarray, Array)) or np.isscalar(x)):
    raise TypeError(f"Expected arraylike input; got {x}")

  # Convert input to jax.Array:
  x_arr = jnp.asarray(x)

  # ... do some computation; JAX functions will return Array types:
  result = x_arr.sum(0) / x_arr.shape[0]

  # return an Array
  return result

大多数 JAX 的公共 API 都遵循此模式。请特别注意，我们建议 JAX 函数不要接受序列（例如 list 或 tuple）来代替数组，因为这会在 JAX 变换（例如 jit()）中导致额外的开销，并且在批次式变换（例如 vmap() 或 jax.pmap()）中可能会出现意外行为。有关此内容的更多信息，请参阅 非数组输入 NumPy vs JAX

成员列表#

ArrayLike

JAX 类数组对象的类型标注。

DTypeLike

别名：str | type[Any] | dtype | SupportsDType