jax.numpy.prod

内容

jax.numpy.prod#

jax.numpy.prod(a, axis=None, dtype=None, out=None, keepdims=False, initial=None, where=None, promote_integers=True)[source]#

返回沿给定轴的数组元素的乘积。

JAX 实现 numpy.prod()。

参数：

  • a (ArrayLike) – 输入数组。

  • axis (Axis | None) – int 或数组，默认为 None。要计算乘积的轴。如果为 None，则沿所有轴计算乘积。

  • dtype (DTypeLike | None | None) – 输出数组的类型。默认为 None。

  • keepdims (bool) – bool，默认为 False。如果为 True，则结果中保留大小为 1 的缩减轴。

  • initial (ArrayLike | None | None) – int 或数组，默认为 None。乘积的初始值。

  • where (ArrayLike | None | None) – int 或数组，默认为 None。用于乘积的元素。数组应与输入广播兼容。

  • promote_integers (bool) – 布尔值，默认为 True。如果为 True，则整数输入将提升到最宽的可用整数数据类型，遵循 NumPy 的行为。如果为 False，则结果将与输入具有相同的数据类型。promote_integers 如果指定了 dtype 则会被忽略。

  • out (None | None) – JAX 未使用。

返回:

沿给定轴的乘积数组。

返回类型:

数组

另请参阅

示例

默认情况下，jnp.prod 计算所有轴上的乘积。

>>> x = jnp.array([[1, 3, 4, 2],
...                [5, 2, 1, 3],
...                [2, 1, 3, 1]])
>>> jnp.prod(x)
Array(4320, dtype=int32)

如果 axis=1，则沿轴 1 计算乘积。

>>> jnp.prod(x, axis=1)
Array([24, 30,  6], dtype=int32)

如果 keepdims=True，则输出的 ndim 等于输入的 ndim。

>>> jnp.prod(x, axis=1, keepdims=True)
Array([[24],
       [30],
       [ 6]], dtype=int32)

要仅包含总和中的特定元素，可以使用 ``where``。

>>> where=jnp.array([[1, 0, 1, 0],
...                  [0, 0, 1, 1],
...                  [1, 1, 1, 0]], dtype=bool)
>>> jnp.prod(x, axis=1, keepdims=True, where=where)
Array([[4],
       [3],
       [6]], dtype=int32)
>>> where = jnp.array([[False],
...                    [False],
...                    [False]])
>>> jnp.prod(x, axis=1, keepdims=True, where=where)
Array([[1],
       [1],
       [1]], dtype=int32)
内容