評價此頁

torch.histogramdd#

torch.histogramdd(input, bins, *, range=None, weight=None, density=False, out=None) -> (Tensor, Tensor[])#

計算張量中值的多維直方圖。

將一個 innermost dimension 大小為 N 的輸入張量解釋為 N 維點的集合。將每個點對映到一個 N 維的 bin 集合中,並返回每個 bin 中的點數(或總權重)。

input 必須是至少有 2 個維度的張量。如果 input 的 shape 是 (M, N),它的 M 行定義了 N 維空間中的一個點。如果 input 有三個或更多維度,除了最後一個維度之外的所有維度都會被展平。

每個維度獨立地與其自身的嚴格遞增的 bin 邊界序列相關聯。可以透過傳遞 1D 張量序列來顯式指定 bin 邊界。或者,可以透過傳遞指定每個維度中等寬 bin 數量的整數序列來自動構建 bin 邊界。

對於 input 中的每個 N 維點
  • 它的每個座標都會在與它所屬維度相對應的 bin 邊界之間獨立地進行 binning

    對應的維度

  • binning 結果被組合起來以確定該點所屬的 N 維 bin(如果有的話)

    落入的

  • 如果點落入某個 bin,則該 bin 的計數(或總權重)會增加

  • 不落入任何 bin 的點不計入輸出

bins 可以是 N 個 1D 張量的序列,N 個整數的序列,或單個整數。

如果 bins 是 N 個 1D 張量的序列,它顯式指定了 N 個 bin 邊界序列。每個 1D 張量應包含一個至少有一個元素的嚴格遞增序列。K 個 bin 邊界的序列定義了 K-1 個 bin,顯式指定了所有 bin 的左邊界和右邊界。每個 bin 都包含其左邊界。只有最右邊的 bin 包含其右邊界。

如果 bins 是 N 個整數的序列,它指定了每個維度中等寬 bin 的數量。預設情況下,每個維度中最左邊和最右邊的 bin 邊界由輸入張量在相應維度中的最小和最大元素確定。可以使用 range 引數手動指定每個維度中最左邊和最右邊的 bin 邊界。

如果 bins 是一個整數,它指定了所有維度中等寬 bin 的數量。

注意

另請參閱 torch.histogram(),它專門計算 1D 直方圖。雖然 torch.histogramdd()input 的 shape 推斷其 bin 和 binning 值的維度,但 torch.histogram() 接受並展平任何 shape 的 input

引數
  • input (Tensor) – 輸入張量。

  • bins – Tensor[]、int[] 或 int。如果為 Tensor[],則定義 bin 邊界序列。如果為 int[],則定義每個維度中等寬 bin 的數量。如果為 int,則定義所有維度中等寬 bin 的數量。

關鍵字引數
  • range (sequence of float) – 定義每個維度中最左邊和最右邊的 bin 邊界。

  • weight (Tensor) – 預設情況下,input 中的每個值權重為 1。如果傳入權重張量,則 input 中的每個 N 維座標會將其關聯的權重計入其 bin 的結果中。權重張量應與 input 張量具有相同的 shape,但不包括其 innermost dimension N。

  • density (bool) – 如果為 False (預設),結果將包含每個 bin 中的計數(或總權重)。如果為 True,則每個計數(權重)除以總計數(總權重),然後除以其關聯 bin 的體積。

返回

包含直方圖值的 N 維張量。bin_edges(Tensor[]): 包含 bin 邊界的 N 個 1D 張量序列。

返回型別

hist (Tensor)

示例

>>> torch.histogramdd(torch.tensor([[0., 1.], [1., 0.], [2., 0.], [2., 2.]]), bins=[3, 3],
...                   weight=torch.tensor([1., 2., 4., 8.]))
    torch.return_types.histogramdd(
        hist=tensor([[0., 1., 0.],
                     [2., 0., 0.],
                     [4., 0., 8.]]),
        bin_edges=(tensor([0.0000, 0.6667, 1.3333, 2.0000]),
                   tensor([0.0000, 0.6667, 1.3333, 2.0000])))

>>> torch.histogramdd(torch.tensor([[0., 0.], [1., 1.], [2., 2.]]), bins=[2, 2],
...                   range=[0., 1., 0., 1.], density=True)
    torch.return_types.histogramdd(
       hist=tensor([[2., 0.],
                    [0., 2.]]),
       bin_edges=(tensor([0.0000, 0.5000, 1.0000]),
                  tensor([0.0000, 0.5000, 1.0000])))