mindspore.ops.sequence_mask
============================

.. 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_sequence_mask.rst
    :alt: 查看源文件


.. py:function:: mindspore.ops.sequence_mask(lengths, maxlen=None)

    返回一个表示每个单元的前N个位置的掩码tensor，内部元素数据类型为bool。

    如果 `lengths` 的shape为 :math:`(d_1, d_2, ..., d_n)` ，则生成的tensor掩码拥有数据类型，其shape为 :math:`(d_1, d_2, ..., d_n, maxlen)` 。
    且mask :math:`[i_1, i_2, ..., i_n, j] = (j < lengths[i_1, i_2, ..., i_n])` 。

    参数：
        - **lengths** (Tensor) - 输入tensor。此tensor中的所有值都应小于或等于 `maxlen` ，大于 `maxlen` 的值将被视为 `maxlen` 。
        - **maxlen** (int) - 指定返回tensor的长度。

    返回：
        Tensor，shape为 `lengths.shape + (maxlen,)` 。