Add the loss api doc for the MarginRankingLoss

update the margin rank loss api doc

doc/fluid/api/nn.rst

@@ -84,7 +84,6 @@ paddle.nn
     nn/logsigmoid.rst
     nn/loss.rst
     nn/lrn.rst
-    nn/margin_rank_loss.rst
     nn/matrix_nms.rst
     nn/maxout.rst
     nn/mse_loss.rst
@@ -150,3 +149,5 @@ paddle.nn
     nn/while_loop.rst
     nn/yolo_box.rst
     nn/yolov3_loss.rst
+    nn/functional/loss/margin_ranking_loss.rst
+    nn/layer/loss/MarginRankingLoss.rst

doc/fluid/api/nn/functional/loss/margin_ranking_loss.rst

+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
+.. _api_nn_functional_loss_margin_ranking_loss:
+
+margin_ranking_loss
+-------------------
+
+..  autofunction:: paddle.nn.functional.loss.margin_ranking_loss
+    :noindex:
+

doc/fluid/api/nn/layer/loss/MarginRankingLoss.rst

+..  THIS FILE IS GENERATED BY `gen_doc.{py|sh}`
+    !DO NOT EDIT THIS FILE MANUALLY!
+
+.. _api_nn_layer_loss_MarginRankingLoss:
+
+MarginRankingLoss
+-----------------
+
+..  autoclass:: paddle.nn.layer.loss.MarginRankingLoss
+    :members:
+    :inherited-members:
+    :noindex:
+

doc/fluid/api/nn/margin_rank_loss.rst

-.. _api_nn_margin_rank_loss:
-
-margin_rank_loss
--------------------------------
-:doc_source: paddle.fluid.layers.margin_rank_loss
-
-

doc/fluid/api_cn/nn_cn.rst

@@ -95,7 +95,7 @@ paddle.nn
     nn_cn/logsigmoid_cn.rst
     nn_cn/log_loss_cn.rst
     nn_cn/lrn_cn.rst
-    nn_cn/margin_rank_loss_cn.rst
+    nn_cn/margin_ranking_loss_cn.rst
     nn_cn/maxout_cn.rst
     nn_cn/mse_loss_cn.rst
     nn_cn/multiclass_nms_cn.rst
@@ -162,3 +162,6 @@ paddle.nn
     nn_cn/while_loop_cn.rst
     nn_cn/yolov3_loss_cn.rst
     nn_cn/yolo_box_cn.rst
+    nn_cn/loss_cn/MarginRankingLoss_cn.rst
+    nn_cn/functional_cn/margin_ranking_loss_cn.rst
+     

doc/fluid/api_cn/nn_cn/functional_cn.rst

@@ -10,3 +10,4 @@ functional
 
     functional_cn/l1_loss_cn.rst
     functional_cn/nll_loss_cn.rst
+    functional_cn/margin_ranking_loss_cn.rst

doc/fluid/api_cn/nn_cn/functional_cn/margin_ranking_loss_cn.rst

+.. _cn_api_nn_cn_margin_ranking_loss:
+
+margin_ranking_loss
+-------------------------------
+
+.. py:function:: paddle.nn.functional.margin_ranking_loss(input, other, label, margin=0.0, reduction='mean', name=None)
+
+该算子计算输入input，other 和 标签label间的 `margin rank loss` 损失。该损失函数的数学计算公式如下：
+
+ .. math:: 
+     margin\_rank\_loss = max(0, -label * (input - other) + margin)
+
+当 `reduction` 设置为 ``'mean'`` 时，
+
+    .. math::
+       Out = MEAN(margin\_rank\_loss)
+
+当 `reduction` 设置为 ``'sum'`` 时，
+    
+    .. math::
+       Out = SUM(margin\_rank\_loss)
+
+当 `reduction` 设置为 ``'none'`` 时，直接返回最原始的 `margin_rank_loss` 。
+
+参数
+::::::::
+    - **input** （Tensor）：第一个输入的 `Tensor` ，数据类型为：float32、float64。
+    - **other** （Tensor）：第二个输入的 `Tensor` ，数据类型为：float32、float64。
+    - **label** （Tensor）：训练数据的标签，数据类型为：float32, float64。
+    - **margin** （float，可选）： - 用于加和的margin值，默认值为0。  
+    - **reduction** （string，可选）： - 指定应用于输出结果的计算方式，可选值有: ``'none'`` 、 ``'mean'`` 、 ``'sum'`` 。如果设置为 ``'none'`` ，则直接返回 最原始的 ``margin_rank_loss`` 。如果设置为 ``'sum'`` ，则返回 ``margin_rank_loss`` 的总和。如果设置为 ``'mean'`` ，则返回 ``margin_rank_loss`` 的平均值。默认值为 ``'none'`` 。
+    - **name** （str，可选） - 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。  
+
+返回
+::::::::
+Tensor, 如果 :attr:`reduction` 为 ``'sum'`` 或者是 ``'mean'`` ，则形状为 :math:`[1]` ，否则shape和输入 `input` 保持一致 。数据类型与 ``input``、 ``other`` 相同。
+
+代码示例
+::::::::
+
+.. code-block:: python
+
+    import numpy as np 
+    import paddle 
+    
+    paddle.disable_static()
+     
+    input = paddle.to_variable(np.array([[1, 2], [3, 4]]).astype('float32'))
+    other = paddle.to_variable(np.array([[2, 1], [2, 4]]).astype('float32'))
+    label = paddle.to_variable(np.array([[1, -1], [-1, -1]]).astype('float32'))
+    loss = paddle.nn.functional.margin_ranking_loss(input, other, label) 
+    print(loss.numpy()) # [0.75]

doc/fluid/api_cn/nn_cn/loss_cn.rst

@@ -11,5 +11,6 @@ loss
     loss_cn/BCELoss_cn.rst
     loss_cn/CrossEntropyLoss_cn.rst
     loss_cn/L1Loss_cn.rst
+    loss_cn/MarginRankingLoss_cn.rst
     loss_cn/MSELoss_cn.rst
     loss_cn/NLLLoss_cn.rst

doc/fluid/api_cn/nn_cn/loss_cn/MarginRankingLoss_cn.rst

+.. _cn_api_nn_loss_MarginRankingLoss:
+
+MarginRankingLoss
+-------------------------------
+
+.. py:class:: paddle.nn.loss.MarginRankingLoss(margin=0.0, reduction='mean', name=None)
+
+该接口用于创建一个 ``MarginRankingLoss`` 的可调用类，计算输入input，other 和 标签label间的 `margin rank loss` 损失。
+
+该损失函数的数学计算公式如下：
+
+ .. math:: 
+     margin\_rank\_loss = max(0, -label * (input - other) + margin)
+
+当 `reduction` 设置为 ``'mean'`` 时，
+
+    .. math::
+       Out = MEAN(margin\_rank\_loss)
+
+当 `reduction` 设置为 ``'sum'`` 时，
+    
+    .. math::
+       Out = SUM(margin\_rank\_loss)
+
+当 `reduction` 设置为 ``'none'`` 时，直接返回最原始的 `margin_rank_loss` 。
+
+参数
+::::::::
+    - **margin** （float，可选）： - 用于加和的margin值，默认值为0。  
+    - **reduction** （string，可选）： - 指定应用于输出结果的计算方式，可选值有: ``'none'`` 、 ``'mean'`` 、 ``'sum'`` 。如果设置为 ``'none'`` ，则直接返回 最原始的 ``margin_rank_loss`` 。如果设置为 ``'sum'`` ，则返回 ``margin_rank_loss`` 的总和。如果设置为 ``'mean'`` ，则返回 ``margin_rank_loss`` 的平均值。默认值为 ``'none'`` 。
+    - **name** （str，可选） - 操作的名称(可选，默认值为None）。更多信息请参见 :ref:`api_guide_Name`。
+
+形状
+::::::::
+    - **input** - N-D Tensor, 维度是[N，*] 其中N 是batch size，`*` 是任意数量的额外维度，数据类型为float32或float64。
+    - **other** - 与 ``input`` 的形状、数据类型相同。
+    - **label** - 与 ``input`` 的形状、数据类型相同。
+    - **output** - 如果 :attr:`reduction` 为 ``'sum'`` 或者是 ``'mean'`` ，则形状为 :math:`[1]` ，否则shape和输入 `input` 保持一致 。数据类型与 ``input``、 ``other`` 相同。
+
+返回
+::::::::
+返回计算MarginRankingLoss的可调用对象。
+
+代码示例
+::::::::
+
+.. code-block:: python
+
+
+     import numpy as np 
+     import paddle 
+     
+     paddle.disable_static()
+      
+     input = paddle.to_variable(np.array([[1, 2], [3, 4]]).astype("float32"))
+     other = paddle.to_variable(np.array([[2, 1], [2, 4]]).astype("float32"))
+     label = paddle.to_variable(np.array([[1, -1], [-1, -1]]).astype("float32"))
+     margin_rank_loss = paddle.nn.MarginRankingLoss()
+     loss = margin_rank_loss(input, other, label) 
+     print(loss.numpy()) # [0.75]

doc/fluid/api_cn/nn_cn/margin_rank_loss_cn.rst

-.. _cn_api_nn_cn_margin_rank_loss:
-
-margin_rank_loss
--------------------------------
-:doc_source: paddle.fluid.layers.margin_rank_loss
-
-