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)[源代码][源代码]#

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

JAX 实现的 numpy.prod()。

参数:

  • a (ArrayLike) – 输入数组。

  • axis (Axis) – int 或 array, 默认=None。计算乘积的轴。如果为 None，则沿所有轴计算乘积。

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

  • keepdims (bool) – bool, 默认=False。如果为真，缩减的轴将保留在结果中，尺寸为1。

  • initial (ArrayLike | None) – int 或 array, 默认=None。乘积的初始值。

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

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

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

返回:

沿着给定轴的产品数组。

返回类型:

Array

参见

示例

默认情况下，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)
目录