jax.numpy.vectorize

内容

jax.numpy.vectorize#

jax.numpy.vectorize(pyfunc, *, excluded=frozenset({}), signature=None)[source]#

定义具有广播功能的矢量化函数。

vectorize() 是用于定义具有广播功能的矢量化函数的便捷包装器，其风格类似于 NumPy 的 广义通用函数。它允许定义自动跨任何前导维度重复的函数，而无需函数的实现关注如何处理更高维度的输入。

jax.numpy.vectorize() 的接口与 numpy.vectorize 相同，但它是自动批处理转换 (vmap()) 的语法糖，而不是 Python 循环。这应该会更高效，但实现必须用作用于 JAX 数组的函数来编写。

参数:

  • pyfunc – 要矢量化的函数。

  • excluded – 可选的整数集，表示函数不会对其进行矢量化的位置参数。这些参数将直接传递给 pyfunc 且不会被修改。

  • signature – 可选的广义通用函数签名，例如 (m,n),(n)->(m) 用于矢量化矩阵向量乘法。如果提供，pyfunc 将被调用（并期望返回）具有由对应核心维度的大小给出的形状的数组。默认情况下，假设 pyfunc 以标量数组作为输入和输出。

返回值:

给定函数的矢量化版本。

以下是一些使用 vectorize() 编写矢量化线性代数例程的方法示例。

>>> from functools import partial

>>> @partial(jnp.vectorize, signature='(k),(k)->(k)')
... def cross_product(a, b):
...   assert a.shape == b.shape and a.ndim == b.ndim == 1
...   return jnp.array([a[1] * b[2] - a[2] * b[1],
...                     a[2] * b[0] - a[0] * b[2],
...                     a[0] * b[1] - a[1] * b[0]])

>>> @partial(jnp.vectorize, signature='(n,m),(m)->(n)')
... def matrix_vector_product(matrix, vector):
...   assert matrix.ndim == 2 and matrix.shape[1:] == vector.shape
...   return matrix @ vector

这些函数仅编写为处理 1D 或 2D 数组（assert 语句永远不会被违反），但使用 vectorize，它们支持具有 NumPy 风格广播的任意维输入，例如：

>>> cross_product(jnp.ones(3), jnp.ones(3)).shape
(3,)
>>> cross_product(jnp.ones((2, 3)), jnp.ones(3)).shape
(2, 3)
>>> cross_product(jnp.ones((1, 2, 3)), jnp.ones((2, 1, 3))).shape
(2, 2, 3)
>>> matrix_vector_product(jnp.ones(3), jnp.ones(3))  
Traceback (most recent call last):
ValueError: input with shape (3,) does not have enough dimensions for all
core dimensions ('n', 'k') on vectorized function with excluded=frozenset()
and signature='(n,k),(k)->(k)'
>>> matrix_vector_product(jnp.ones((2, 3)), jnp.ones(3)).shape
(2,)
>>> matrix_vector_product(jnp.ones((2, 3)), jnp.ones((4, 3))).shape
(4, 2)

请注意，这与 jnp.matmul 的语义不同。

>>> jnp.matmul(jnp.ones((2, 3)), jnp.ones((4, 3)))  
Traceback (most recent call last):
TypeError: dot_general requires contracting dimensions to have the same shape, got [3] and [4].
目录