torch.nn.functional.cosine_similarity

torch.nn.functional.cosine_similarity(x1, x2, dim=1, eps=1e-8) → Tensor

返回 x1 和 x2 之间的余弦相似度，沿 dim 计算。 x1 和 x2 必须可广播到公共形状。dim 指的是此公共形状中的维度。 输出的维度 dim 会被压缩（参见 torch.squeeze()），从而使输出 Tensor 减少 1 个维度。

$$\text{similarity} = \dfrac{x_1 \cdot x_2}{\max(\Vert x_1 \Vert _2, \epsilon) \cdot \max(\Vert x_2 \Vert _2, \epsilon)}$$

支持 类型提升。

参数

• x1 (Tensor) – 第一个输入。

• x2 (Tensor) – 第二个输入。

• dim (int, 可选) – 计算余弦相似度的维度。 默认值：1

• eps (float, 可选) – 用于避免除以零的微小值。 默认值：1e-8

示例

>>> input1 = torch.randn(100, 128)
>>> input2 = torch.randn(100, 128)
>>> output = F.cosine_similarity(input1, input2)
>>> print(output)