numpy.average#

numpy.average(a, axis=None, weights=None, returned=False, *, keepdims=<no value>)[source]#

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

参数:
aarray_like

包含要平均数据的数组。如果 a 不是数组,则尝试进行转换。

axisNone 或 int 或 int 元组,可选

a 进行平均值的轴或轴。默认值为 axis=None,将对输入数组的所有元素进行平均。如果 axis 为负数,则从最后一个轴到第一个轴进行计数。

1.7.0 版本的新增功能。

如果 axis 是 int 的元组,则将在元组中指定的所有轴上执行平均,而不是像以前那样在一个轴上或所有轴上。

weightsarray_like,可选

a 中的值相关联的权重数组。每个 a 中的值根据其关联的权重对平均值进行贡献。如果未指定轴,则权重数组的形状必须与 a 相同,否则权重必须具有与 a 在指定轴上的维度和形状一致的维度和形状。如果 weights=None,则假定 a 中的所有数据权重都为 1。计算公式为:

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

其中总和在所有包含的元素上进行。对 weights 的值的唯一约束是 sum(weights) 不能为 0。

returnedbool,可选

默认值为 False。如果 True,则返回元组 (average, sum_of_weights),否则仅返回平均值。如果 weights=None,则 sum_of_weights 等效于进行平均的元素数量。

keepdimsbool,可选

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

1.23.0 版本的新增功能。

返回值:
retval, [sum_of_weights]array_type 或 double

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

引发:
ZeroDivisionError

当轴上的所有权重都为零时。有关此类错误的稳健版本的详细信息,请参见 numpy.ma.average

TypeError

weights 的形状与 a 不相同时,且 axis=None

ValueError

weights 的维度和形状与指定 axis 上的 a 不一致时。

参见

mean
ma.average

用于掩码数组的 average - 如果您的数据包含“缺失”值,则很有用

numpy.result_type

返回将 numpy 类型提升规则应用于参数后的类型。

示例

>>> import numpy as np
>>> data = np.arange(1, 5)
>>> data
array([1, 2, 3, 4])
>>> np.average(data)
2.5
>>> np.average(np.arange(1, 11), weights=np.arange(10, 0, -1))
4.0
>>> data = np.arange(6).reshape((3, 2))
>>> data
array([[0, 1],
       [2, 3],
       [4, 5]])
>>> np.average(data, axis=1, weights=[1./4, 3./4])
array([0.75, 2.75, 4.75])
>>> np.average(data, weights=[1./4, 3./4])
Traceback (most recent call last):
    ...
TypeError: Axis must be specified when shapes of a and weights differ.

使用 keepdims=True,以下结果的形状为 (3, 1)。

>>> np.average(data, axis=1, keepdims=True)
array([[0.5],
       [2.5],
       [4.5]])
>>> data = np.arange(8).reshape((2, 2, 2))
>>> data
array([[[0, 1],
        [2, 3]],
       [[4, 5],
        [6, 7]]])
>>> np.average(data, axis=(0, 1), weights=[[1./4, 3./4], [1., 1./2]])
array([3.4, 4.4])
>>> np.average(data, axis=0, weights=[[1./4, 3./4], [1., 1./2]])
Traceback (most recent call last):
    ...
ValueError: Shape of weights must be consistent
with shape of a along specified axis.