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[源代码][源代码]#
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-backend 对 numpy.average() 的实现。

原始文档字符串如下。

参数:

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

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

  • weights (array_like, optional) – 与 a 中的值相关联的权重数组。a 中的每个值根据其关联的权重对平均值做出贡献。如果没有指定轴，权重数组必须与 a 具有相同的形状，否则权重必须在与 a 指定的轴上具有一致的维度和形状。如果 weights=None，则假定 a 中的所有数据具有等于 1 的权重。计算公式为:: avg = sum(a * weights) / sum(weights) 其中求和是对所有包含的元素进行的。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 类型相同。结果的 dtype 遵循一般模式。如果 weights 为 None，结果的 dtype 将为 a 的 dtype，如果 a 是整数，则为 float64。否则，如果 weights 不为 None 且 a 为非整数，结果类型将为能够表示 a 和 weights 值的最低精度的类型。如果 a 恰好是整数，则仍适用前面的规则，但结果 dtype 至少为 float64。

返回类型:

array_type or double

目录