jax.numpy.vectorize

目录

jax.numpy.vectorize#

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

定义一个带有广播功能的矢量化函数。

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

这些函数仅编写为处理一维或二维数组（assert 语句永远不会被违反），但通过向量化，它们支持任意维度的输入，并使用 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].
目录