mindspore.ops.gather_elements
=============================

.. py:function:: mindspore.ops.gather_elements(input, dim, index)

    获取指定轴的元素。

    对于三维Tensor,输出为:

    .. code-block::

        output[i][j][k] = input[index[i][j][k]][j][k]  # if dim == 0

        output[i][j][k] = input[i][index[i][j][k]][k]  # if dim == 1

        output[i][j][k] = input[i][j][index[i][j][k]]  # if dim == 2

    `input` 与 `index` 拥有一样的维度长度,且对于 `axis != dim` , `index.shape[axis] <= input.shape[axis]` 。

    .. warning::
        在Ascend后端,以下场景将导致不可预测的行为:

        - 正向执行流程中, 当 `index` 的取值不在范围 `[-input.shape[dim], input.shape[dim])` 内;
        - 反向执行流程中, 当 `index` 的取值不在范围 `[0, input.shape[dim])` 内。

    参数:
        - **input** (Tensor) - 输入Tensor。
        - **dim** (int) - 获取元素的轴。数据类型为int32或int64。取值范围为 `[-input.ndim, input.ndim)` 。
        - **index** (Tensor) - 获取收集元素的索引。支持的数据类型包括:int32,int64。每个索引元素的取值范围为 `[-input.shape(dim), input.shape(dim))` 。

    返回:
        Tensor,shape与 `index` 相同,数据类型与 `input` 相同。

    异常:
        - **TypeError** - `dim` 或 `index` 的数据类型既不是int32,也不是int64。
        - **ValueError** - `input` 和 `index` 的维度长度不一致。
        - **ValueError** - 除 `dim` 维外,`input` 的维度值小于 `index` 的维度值。
        - **ValueError** - `dim` 的值不在合理范围内。