docs/api/api_python/ops/mindspore.ops.func_norm.rst - master - envoy.istio/mindspore

docs/api/api_python/ops/mindspore.ops.func_norm.rst
54 строки3 KB
lilinjie
fix norm demo code
25 сен 2023, 05:17
25 сен 2023, 05:17f78f2ce
mindspore.ops.norm
==================

.. py:function:: mindspore.ops.norm(A, ord=None, dim=None, keepdim=False, *, dtype=None)

    返回给定Tensor的矩阵范数或向量范数。

    `ord` 为norm的计算模式。支持下列norm模式。

    =================   ================================== ==============================================
    `ord`                矩阵范数                               向量范数
    =================   ================================== ==============================================
    `None` (默认值)      Frobenius norm                     `2`-norm (参考最下方公式)
    `'fro'`              Frobenius norm                     不支持
    `'nuc'`              nuclear norm                       不支持
    `inf`                :math:`max(sum(abs(x), dim=1))`    :math:`max(abs(x))`
    `-inf`               :math:`min(sum(abs(x), dim=1))`    :math:`min(abs(x))`
    `0`                  不支持                             :math:`sum(x != 0)`
    `1`                  :math:`max(sum(abs(x), dim=0))`    参考最下方公式
    `-1`                 :math:`min(sum(abs(x), dim=0))`    参考最下方公式
    `2`                  最大奇异值                         参考最下方公式
    `-2`                 最小奇异值                         参考最下方公式
    其余int或float值     不支持                             :math:`sum(abs(x)^{ord})^{(1 / ord)}`
    =================   ================================== ==============================================

    参数：
        - **A** (Tensor) - shape为 :math:`(*, n)` 或者 :math:`(*, m, n)` 的Tensor，其中*是零个或多个batch维度。
        - **ord** (Union[int, float, inf, -inf, 'fro', 'nuc'], 可选) - norm的模式。行为参考上表。默认值： ``None`` 。
        - **dim** (Union[int, Tuple(int)], 可选) - 计算向量范数或矩阵范数的维度。默认值： ``None`` 。

          - 当 `dim` 为int时，会按向量范数计算。
          - 当 `dim` 为一个二元组时，会按矩阵范数计算。
          - 当 `dim` 为None且 `ord` 为None，`A` 将会被展平为1D并计算向量的2-范数。
          - 当 `dim` 为None且 `ord` 不为None，`A` 必须为1D或者2D。

        - **keepdim** (bool) - 输出Tensor是否保留原有的维度。默认值： ``False`` 。

    关键字参数：
        - **dtype** (:class:`mindspore.dtype`, 可选) - 如果设置此参数，则会在执行之前将 `A` 转换为指定的类型，返回的Tensor类型也将为指定类型 `dtype`。默认值： ``None`` 。

    返回：
        Tensor，在指定维度 `dim` 上进行范数计算的结果，与输入 `A` 的数据类型相同。

    异常：
        - **ValueError** - `dim` 超出范围。
        - **TypeError** - `dim` 既不是int也不是由int组成的tuple。
        - **TypeError** - `A` 是一个向量并且 `ord` 是str类型。
        - **ValueError** - `A` 是一个矩阵并且 `ord` 不是有效的取值。
        - **ValueError** - `A` 是一个矩阵并且 `ord` 为一个整型但是取值不为[1, -1, 2, -2]之一。
        - **ValueError** - `dim` 的两个元素在标准化过后取值相同。
        - **ValueError** - `dim` 的任意元素超出索引。

    .. note::
        - 当前暂不支持复数。