【Paddle Hackathon No.11】

docs/api/paddle/nn/MultiMarginLoss_cn.rst

@@ -0,0 +1,49 @@
+.. _cn_api_paddle_nn_MultiMarginLoss:
+
+MultiMarginLoss
+-------------------------------
+
+.. py:class:: paddle.nn.MultiMarginLoss(p: int = 1, margin: float = 1.0, weight=None, reduction: str = 'mean', name:str=None)
+
+创建一个 MultiMarginLoss 的可调用类。通过计算输入 `input` 和 `label` 间的多分类问题的 `hinge loss (margin-based loss)` 损失。
+
+损失函数如果在没有权重下计算每一个 mini-batch 的 loss 按照下列公式计算
+
+.. math::
+    \text{loss}(input_i, label_i) = \frac{\sum_{j} \max(0, \text{margin} - input_i[label_i] + input_i[j])^p}{\text{C}}
+
+
+其中 :math:`0 \leq j \leq \text{C}-1`, 且 :math:`j \neq label_i`， :math:`0 \leq i \leq \text{N}-1` N 为 batch 数量, C 为类别数量。
+
+如果含有权重 `weight` 则损失函数按以下公式计算
+
+.. math::
+    \text{loss}(input_i, label_i) = \frac{\sum_{j} \max(0, weight[label_i] * (\text{margin} - input_i[label_i] + input_i[j]))^p}{\text{C}}
+
+
+参数
+:::::::::
+    - **p** (int，可选) - 手动指定幂次方指数大小，默认为 1。
+    - **margin** (float，可选) - 手动指定间距，默认为 1。
+    - **weight** (Tensor，可选) - 权重值，默认为 None。 如果给定权重则形状为 :math:`[C, ]`
+    - **reduction** (str，可选) - 指定应用于输出结果的计算方式，可选值有：``'none'``、``'mean'``、``'sum'``。默认为 ``'mean'``，计算 Loss 的均值；设置为 ``'sum'`` 时，计算 Loss 的总和；设置为 ``'none'`` 时，则返回原始 Loss。
+    - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。
+
+调用参数
+:::::::::
+    - **input** (Tensor) - 数据类型是 float32、float64。
+    - **label** (Tensor) - 标签的数据类型为 int32、int64。
+
+形状
+:::::::::
+    - **input** (Tensor) - :math:`[N, C]`，其中 N 是 batch_size， C 是类别数量。
+    - **label** (Tensor) - :math:`[N, ]`。
+    - **output** (Tensor) - 输出的 Tensor。如果 :attr:`reduction` 是 ``'none'``，则输出的维度为 :math:`[N, ]`。如果 :attr:`reduction` 是 ``'mean'`` 或 ``'sum'``，则输出的维度为 :math:`[1]` 。
+
+返回
+:::::::::
+   返回计算 MultiMarginLoss 的可调用对象。
+
+代码示例
+:::::::::
+COPY-FROM: paddle.nn.MultiMarginLoss

docs/api/paddle/nn/Overview_cn.rst

@@ -262,6 +262,7 @@ Loss 层
     " :ref:`paddle.nn.TripletMarginLoss <cn_api_paddle_nn_TripletMarginLoss>` ", "TripletMarginLoss 层"
     " :ref:`paddle.nn.TripletMarginWithDistanceLoss <cn_api_paddle_nn_TripletMarginWithDistanceLoss>` ", "TripletMarginWithDistanceLoss 层"
     " :ref:`paddle.nn.MultiLabelSoftMarginLoss <cn_api_paddle_nn_MultiLabelSoftMarginLoss>` ", "多标签 Hinge 损失层"
+    " :ref:`paddle.nn.MultiMarginLoss <cn_api_paddle_nn_MultiMarginLoss>` ", "MultiMarginLoss 层"
 
 
 .. _vision_layers:
@@ -488,6 +489,7 @@ Embedding 相关函数
     " :ref:`paddle.nn.functional.triplet_margin_loss <cn_api_paddle_nn_functional_triplet_margin_loss>` ", "用于计算 TripletMarginLoss"
     " :ref:`paddle.nn.functional.triplet_margin_with_distance_loss <cn_api_paddle_nn_functional_triplet_margin_with_distance_loss>` ", "用户自定义距离函数用于计算 triplet margin loss 损失"
     " :ref:`paddle.nn.functional.multi_label_soft_margin_loss <cn_api_nn_functional_multi_label_soft_margin_loss>` ", "用于计算多分类的 hinge loss 损失函数"
+    " :ref:`paddle.nn.functional.multi_margin_loss <cn_api_paddle_nn_functional_multi_margin_loss>` ", "用于计算 multi margin loss 损失函数"
 
 
 .. _common_functional:

docs/api/paddle/nn/functional/multi_margin_loss_cn.rst

@@ -0,0 +1,45 @@
+.. _cn_api_paddle_nn_functional_multi_margin_loss:
+
+multi_margin_loss
+-------------------------------
+
+.. py:function:: paddle.nn.functional.multi_margin_loss(input, label, p:int = 1, margin: float = 1.0, weight=None, reduction: str = 'mean', name:str=None)
+
+计算输入 `input` 和 `label` 间的多分类问题的 `hinge loss` 损失。
+
+
+损失函数如果在没有的权重下计算每一个 mini-batch 的 loss 按照下列公式计算
+
+.. math::
+    \text{loss}(input_i, label_i) = \frac{\sum_{j} \max(0, \text{margin} - input_i[label_i] + input_i[j])^p}{\text{C}}
+
+其中 :math:`0 \leq j \leq \text{C}-1`, 且 :math:`j \neq label_i`, :math:`0 \leq i \leq \text{N}-1` N 为 batch 数量, C 为类别数量。
+
+如果含有权重 `weight` 则损失函数按以下公式计算
+
+.. math::
+    \text{loss}(input_i, label_i) = \frac{\sum_{j} \max(0, weight[label_i] * (\text{margin} - input_i[label_i] + input_i[j]))^p}{\text{C}}
+
+参数
+:::::::::
+    - **input** (Tensor) - :math:`[N, C]`，其中 N 是 batch_size， `C` 是类别数量。数据类型是 float32、float64。
+    - **label** (Tensor) - :math:`[N, ]`。标签 ``label`` 的数据类型为 int32、int64。
+    - **p** (int，可选) - 手动指定范数，默认为 1。
+    - **margin** (float，可选) - 手动指定间距，默认为 1。
+    - **weight** (Tensor，可选) - 权重值，默认为 None。如果给定则形状为 :math:`[C, ]`。
+    - **reduction** (str，可选) - 指定应用于输出结果的计算方式，可选值有：``'none'``， ``'mean'``， ``'sum'``。默认为 ``'mean'``，计算 Loss 的均值；设置为 ``'sum'`` 时，计算 Loss 的总和；设置为 ``'none'`` 时，则返回原始 Loss。
+    - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。
+
+形状
+:::::::::
+    - **input** (Tensor) - :math:`[N, C ]`，其中 N 是 batch_size，`C` 是类别问题。数据类型是 float32、float64。
+    - **label** (Tensor) - :math:`[N, ]`，标签 ``label`` 的数据类型为 int32、int64。
+    - **output** (Tensor) - 输出的 Tensor。如果 :attr:`reduction` 是 ``'none'``，则输出的维度为 :math:`[N, ]`，与输入 ``input`` 的形状相同。如果 :attr:`reduction` 是 ``'mean'`` 或 ``'sum'``，则输出的维度为 :math:`[1]` 。
+
+返回
+:::::::::
+   返回计算的 Loss。
+
+代码示例
+:::::::::
+COPY-FROM: paddle.nn.functional.multi_margin_loss