jax.numpy.average

内容

jax.numpy.average#

jax.numpy.average(a: ArrayLike, axis: Axis = None, weights: ArrayLike | None = None, returned: Literal[False] = False, keepdims: bool = False) → Array[source]#
jax.numpy.average(a: ArrayLike, axis: Axis = None, weights: ArrayLike | None = None, *, returned: Literal[True], keepdims: bool = False) → Array
jax.numpy.average(a: ArrayLike, axis: Axis = None, weights: ArrayLike | None = None, returned: bool = False, keepdims: bool = False) → Array | tuple[Array, Array]

计算指定轴上的加权平均值。

LAX 后端实现 numpy.average().

原始文档字符串如下。

参数:

  • a (array_like) – 要平均的数据所在的数组。如果 a 不是数组，则尝试进行转换。

  • axis (None 或 int 或 tuple of ints, optional) – 要对 a 进行平均的轴或轴。默认值 axis=None 将对输入数组的所有元素进行平均。如果 axis 为负数，则从最后一个轴到第一个轴进行计数。

  • weights (array_like, optional) –

    与 a 中的值相关的权重数组。a 中的每个值根据其关联的权重对平均值做出贡献。权重数组必须与 a 的形状相同（如果未指定轴），否则权重必须具有与 a 沿指定轴一致的维度和形状。如果 weights=None，则假定 a 中的所有数据都具有等于 1 的权重。计算为

    avg = sum(a * weights) / sum(weights)

    其中 sum 是所有包含元素的总和。对 weights 值的唯一约束是 sum(weights) 必须不为 0。

  • returned (bool, optional) – 默认值为 False。如果为 True，则返回元组 (average, sum_of_weights)，否则只返回平均值。如果 weights=None，则 sum_of_weights 等效于取平均值的元素数量。

  • keepdims (bool, optional) – 如果设置为 True，则将缩减的轴保留在结果中，作为大小为 1 的维度。使用此选项，结果将针对原始 a 正确广播。注意：keepdims 不会与 numpy.matrix 或其他其方法不支持 keepdims 的类的实例一起使用。

返回值:

retval, [sum_of_weights] – 返回指定轴上的平均值。当 returned 为 True 时，返回一个元组，其中平均值作为第一个元素，权重总和作为第二个元素。 sum_of_weights 与 retval 的类型相同。结果数据类型遵循一般模式。如果 weights 为 None，则结果数据类型将为 a 的数据类型，或者如果 a 为整数，则为 float64。否则，如果 weights 不为 None 且 a 非整数，则结果类型将是能够表示 a 和 weights 值的最低精度的类型。如果 a 恰好是整数，则之前规则仍然适用，但结果数据类型至少将为 float64。

返回类型:

array_type 或 double

内容