docs/api/api_python/mint/mindspore.mint.func_add.rst - master - envoy.istio/mindspore

docs/api/api_python/mint/mindspore.mint.func_add.rst

38 строк2 KB

yuhan

modify format

24 июн 2024, 07:08

24 июн 2024, 07:0813b6e64

mindspore.mint.add
===========================

.. py:function:: mindspore.mint.add(input, other, *, alpha=1)

    对 `other` 缩放 `scalar` 后与 `input` 相加。

    .. math::

        out_{i} = input_{i} + alpha \times other_{i}

    .. note::
        - 当两个输入shape不同时，
          它们必须能够广播到一个共同的shape。
        - 两个输入和 `alpha` 遵守隐式类型转换规则以使数据类型
          保持一致。

    参数：
        - **input** (Union[Tensor, number.Number, bool]) - 第一个输入是一个 number.Number、
          一个 bool 或一个数据类型为
          `number <https://www.mindspore.cn/docs/en/master/api_python/mindspore.html#mindspore.dtype>`_ 或
          `bool_ <https://www.mindspore.cn/docs/en/master/api_python/mindspore.html#mindspore.dtype>`_ 的Tensor。
        - **other** (Union[Tensor, number.Number, bool]) - 第二个输入，是一个 number.Number、
          一个 bool 或一个数据类型为
          `number <https://www.mindspore.cn/docs/en/master/api_python/mindspore.html#mindspore.dtype>`_ 或
          `bool_ <https://www.mindspore.cn/docs/en/master/api_python/mindspore.html#mindspore.dtype>`_ 的Tensor。

    关键字参数：
        - **alpha** (number.Number) - 应用于 `other` 的缩放因子，默认值为1。

    返回：
        Tensor，其shape与输入 `input`、 `other` 广播后的shape相同，
        数据类型是两个输入和 alpha 中精度更高或位数更多的类型。

    异常：
        - **TypeError** - 如果 `input`、 `other` 不是以下之一：Tensor、number.Number、bool。
        - **TypeError** - 如果 `alpha` 是 float 类型，但是 `input`、 `other` 不是 float 类型。
        - **TypeError** - 如果 `alpha` 是 bool 类型，但是 `input`、 `other` 不是 bool 类型。