jax.numpy.histogramdd#

jax.numpy.histogramdd(sample, bins=10, range=None, weights=None, density=None)[源]#

计算 N 维直方图。

JAX 对 numpy.histogramdd() 的实现。

参数:

  • sample (ArrayLike) – 形状为 (N, D) 的输入数组，表示 N 个 D 维点。

  • bins (ArrayLike | list[ArrayLike]) – 指定直方图每个维度中的 bin 数量。(默认值：10)。也可以是长度为 D 的整数序列或 bin 边界数组。

  • range (Sequence[None | Array | Sequence[ArrayLike]] | None) – 长度为 D 的对序列，用于指定每个维度的范围。如果未指定，则范围从数据中推断。

  • weights (ArrayLike | None) – 一个可选的形状为 (N,) 的数组，用于指定数据点的权重。应与 sample 具有相同的形状。如果未指定，则每个数据点都被赋予相同的权重。

  • density (bool | None) – 如果为 True，则返回归一化的直方图，单位是每单位体积的计数。如果为 False（默认值），则返回每个 bin 的（加权）计数。

返回:

一个数组元组 (histogram, bin_edges)，其中 histogram 包含聚合数据，而 bin_edges 指定了 bin 的边界。

返回类型:

tuple[Array, list[Array]]

另请参阅

示例

一个包含 100 个三维点的直方图

>>> key = jax.random.key(42)
>>> a = jax.random.normal(key, (100, 3))
>>> counts, bin_edges = jnp.histogramdd(a, bins=6,
...                                     range=[(-3, 3), (-3, 3), (-3, 3)])
>>> counts.shape
(6, 6, 6)
>>> bin_edges  
[Array([-3., -2., -1.,  0.,  1.,  2.,  3.], dtype=float32),
 Array([-3., -2., -1.,  0.,  1.,  2.,  3.], dtype=float32),
 Array([-3., -2., -1.,  0.,  1.,  2.,  3.], dtype=float32)]

使用 density=True 返回一个归一化的直方图

>>> density, bin_edges = jnp.histogramdd(a, density=True)
>>> bin_widths = map(jnp.diff, bin_edges)
>>> dx, dy, dz = jnp.meshgrid(*bin_widths, indexing='ij')
>>> normed = jnp.sum(density * dx * dy * dz)
>>> jnp.allclose(normed, 1.0)
Array(True, dtype=bool)