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

docs/api/api_python/ops/mindspore.ops.func_all.rst

27 строк2 KB

Chenglin Jinag

fix mint.all and mint.all docs

26 июн 2024, 10:05

26 июн 2024, 10:05b1d9a2a

mindspore.ops.all
=================

.. py:function:: mindspore.ops.all(input, axis=None, keep_dims=False)

    默认情况下，通过对维度中所有元素进行“逻辑与”来减少 `input` 的维度。也可以沿 `axis` 减少 `input` 的维度。通过控制 `keep_dims` 来确定输出和输入的维度是否相同。

    .. note::
        Tensor类型的 `axis` 仅用作兼容旧版本，不推荐使用。

    参数：
        - **input** (Tensor) - 输入Tensor，shape是 :math:`(N, *)` ，其中 :math:`*` 表示任意数量的附加维度。
        - **axis** (Union[int, tuple(int), list(int), Tensor], 可选) - 要减少的维度。假设 `input` 的秩为r，取值范围[-r,r)。默认值： ``None`` ，缩小所有维度。
        - **keep_dims** (bool, 可选) - 如果为 ``True`` ，则保留缩小的维度，大小为1。否则移除维度。默认值： ``False`` 。

    返回：
        Tensor，数据类型是bool。

        - 如果 `axis` 为 ``None`` ，且 `keep_dims` 为 ``False`` ，则输出一个零维Tensor，表示输入Tensor中所有元素进行“逻辑与”。
        - 如果 `axis` 为int，例如取值为2，并且 `keep_dims` 为 ``False`` ，则输出的shape为 :math:`(input_1, input_3, ..., input_R)` 。
        - 如果 `axis` 为tuple(int)或list(int)，例如取值为(2, 3)，并且 `keep_dims` 为 ``False`` ，则输出Tensor的shape为 :math:`(input_1, input_4, ..., input_R)` 。
        - 如果 `axis` 为一维Tensor，例如取值为[2, 3]，并且 `keep_dims` 为 ``False`` ，则输出Tensor的shape为 :math:`(input_1, input_4, ..., input_R)` 。

    异常：
        - **TypeError** - `keep_dims` 不是bool类型。
        - **TypeError** - `input` 不是Tensor。
        - **TypeError** - `axis` 不是以下数据类型之一：int、tuple、list或Tensor。