Skip to content

Latest commit

 

History

History
41 lines (28 loc) · 2.15 KB

CosineEmbeddingLoss_cn.rst

File metadata and controls

41 lines (28 loc) · 2.15 KB
Raw

CosineEmbeddingLoss

该函数计算给定的输入 input1, input2 和 label 之间的 CosineEmbedding 损失，通常用于学习非线性嵌入或半监督学习

如果 label=1，则该损失函数的数学计算公式如下：


Out = 1 − cos(input1, input2)

如果 label=-1，则该损失函数的数学计算公式如下：


Out = max(0, cos(input1, input2)) − margin

其中 cos 计算公式如下：

$$cos(x1, x2) = \frac{x1 \cdot{} x2}{\Vert x1 \Vert_2 * \Vert x2 \Vert_2}$$

参数

  • margin (float，可选): - 可以设置的范围为[-1, 1]，建议设置的范围为[0, 0.5]。其默认为 0。数据类型为 int。
  • reduction (string，可选): - 指定应用于输出结果的计算方式，可选值有：'none', 'mean', 'sum'。默认为 'mean'，计算 CosineEmbeddingLoss 的均值；设置为 'sum' 时，计算 CosineEmbeddingLoss 的总和；设置为 'none' 时，则返回 CosineEmbeddingLoss。数据类型为 string。
  • name (str，可选) - 具体用法请参见 api_guide_Name，一般无需设置，默认值为 None。

形状

  • input1 (Tensor): - 输入的 Tensor，维度是[N, M]，其中 N 是 batch size，可为 0，M 是数组长度。数据类型为：float32、float64。
  • input2 (Tensor): - 输入的 Tensor，维度是[N, M]，其中 N 是 batch size，可为 0，M 是数组长度。数据类型为：float32、float64。
  • label (Tensor): - 标签，维度是[N]，N 是数组长度，数据类型为：float32、float64、int32、int64。
  • output (Tensor): - 输入 input1 、 input2 和标签 label 间的 CosineEmbeddingLoss 损失。如果 reduction 是 'none'，则输出 Loss 的维度为 [N]，与输入 input1 和 input2 相同。如果 reduction 是 'mean' 或 'sum'，则输出 Loss 的维度为 []。

代码示例

COPY-FROM: paddle.nn.CosineEmbeddingLoss