mindspore.ops.soft_margin_loss
===============================

.. image:: https://mindspore-website.obs.cn-north-4.myhuaweicloud.com/website-images/master/resource/_static/logo_source.svg
    :target: https://gitee.com/mindspore/mindspore/blob/master/docs/api/api_python/ops/mindspore.ops.func_soft_margin_loss.rst
    :alt: 查看源文件


.. py:function:: mindspore.ops.soft_margin_loss(input, target, reduction='mean')

    计算 `input` 和 `target` 之间的soft margin loss。

    一个二分类任务，计算输入 :math:`x` 和真实标签 :math:`y` （包含1或-1）之间的损失。

    .. math::
        \text{loss}(x, y) = \sum_i \frac{\log(1 + \exp(-y[i]*x[i]))}{\text{x.nelement}()}

    其中 :math:`x.nelement()` 是 :math:`x` 的元素数量。

    .. warning::
        这是一个实验性API，后续可能修改或删除。

    参数：
        - **input** (Tensor) - 预测值。数据类型必须为float16或float32。
        - **target** (Tensor) - 真实标签，数据类型和shape与 `input` 相同。
        - **reduction** (str，可选) - 指定应用于输出结果的规约计算方式，可选 ``'none'`` 、 ``'mean'`` 、 ``'sum'`` ，默认值： ``'mean'`` 。

          - ``"none"``：不应用规约方法。
          - ``"mean"``：计算输出元素的平均值。
          - ``"sum"``：计算输出元素的总和。

    输出：
        Tensor或Scalar。如果 `reduction` 为 ``'none'`` ，其shape与 `input` 相同。否则，将返回Scalar。

    异常：
        - **TypeError** - 如果 `input` 或 `target` 不是Tensor。
        - **TypeError** - 如果 `input` 或 `target` 的数据类型既不是float16也不是float32。
        - **ValueError** - 如果 `input` 与 `target` 的shape不相同。
        - **ValueError** - 如果 `reduction` 不是 ``'none'`` 、 ``'mean'`` 或 ``'sum'`` 。