Skip to content

Commit

Permalink
Update triplet_margin_with_distance_loss_cn.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
yangguohao authored May 9, 2022
1 parent 6aa92a1 commit ba6b33d
Showing 1 changed file with 3 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ triplet_margin_with_distance_loss
- **input** (Tensor) - :math:`[N, * ]` , 其中N是batch_size, `*` 是任意其他维度。数据类型是float32、float64。
- **positive** (Tensor) - :math:`[N, *]` ,正样本,维度、数据类型与输入 ``input`` 相同。
- **negative** (Tensor) - :math:`[N, *]` ,负样本,维度、数据类型与输入 ``input`` 相同。
- **distance_function** (可选) - 手动指定范数,默认为 None, 计算欧式距离。
- **distance_function** (Callable,可选) - 手动指定范数,默认为 None, 计算欧式距离。
- **margin** (float,可选) - 手动指定间距,默认为1。
- **swap** (bool,可选) - 默认为 False。
- **reduction** (str,可选) - 指定应用于输出结果的计算方式,可选值有: ``'none'``, ``'mean'``, ``'sum'`` 。默认为 ``'mean'``,计算 Loss 的均值;设置为 ``'sum'`` 时,计算 Loss 的总和;设置为 ``'none'`` 时,则返回原始 Loss。
- **reduction** (str可选) - 指定应用于输出结果的计算方式,可选值有: ``'none'``, ``'mean'``, ``'sum'`` 。默认为 ``'mean'``,计算 Loss 的均值;设置为 ``'sum'`` 时,计算 Loss 的总和;设置为 ``'none'`` 时,则返回原始 Loss。
- **name** (str,可选) - 操作的名称(可选,默认值为None)。更多信息请参见 :ref:`api_guide_Name` 。

形状
Expand All @@ -45,7 +45,7 @@ triplet_margin_with_distance_loss

返回
:::::::::
返回计算的 Loss
输出的Tensor。如果 :attr:`reduction` 是 ``'none'``, 则输出的维度为 :math:`[N, *]` , 与输入 ``input`` 的形状相同。如果 :attr:`reduction` 是 ``'mean'`` 或 ``'sum'``, 则输出的维度为 :math:`[1]`

代码示例
:::::::::
Expand Down

0 comments on commit ba6b33d

Please sign in to comment.