mindspore.hal.Stream
=======================

.. 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/hal/mindspore.hal.Stream.rst
    :alt: 查看源文件


.. py:class:: mindspore.hal.Stream(priority=0, **kwargs)

    基于设备流的封装器。
    设备流是属于特定设备的线性执行序列，流之间相互独立。

    如何快速使用Stream，请参考 `流管理介绍 <https://www.mindspore.cn/docs/zh-CN/master/api_python/samples/hal/stream_manager.html>`_ 。

    参数：
        - **priority** (int, 可选) - 流的优先级，较低的数字表示较高的优先级。默认情况下，流的优先级为 ``0``。
        - **kwargs** (dict) - 关键字参数字典。

    .. py:method:: mindspore.hal.Stream.query()

        检查所有提交的工作是否已完成。

        返回：
            bool，指示该流中的所有算子是否已执行完成。

    .. py:method:: mindspore.hal.Stream.record_event(event=None)

        记录一个事件。

        参数：
            - **event** (Event, 可选) - 要记录的事件。如果输入为 ``None``，将分配一个新的事件。默认值： ``None``。

        返回：
            Event，记录的事件。

        异常：
            - **TypeError** - 参数 `event` 即不是一个 :class:`mindspore.hal.Event` 也不是一个 ``None``。

    .. py:method:: mindspore.hal.Stream.synchronize()

        等待此流中的所有算子执行完成。

    .. py:method:: mindspore.hal.Stream.wait_event(event)

        使提交到流的所有未来工作等待本事件。

        参数：
            - **event** (Event) - 等待的事件。

        异常：
            - **TypeError** - 参数 `event` 不是一个 :class:`mindspore.hal.Event`。

    .. py:method:: mindspore.hal.Stream.wait_stream(stream)

        与另一个流同步。

        所有提交到本流的未来工作都将等待，直到所有算子都提交至给定流并执行完成。

        参数：
            - **stream** (Stream) - 需要同步的流。

        异常：
            - **TypeError** - 参数 `stream` 不是一个 :class:`mindspore.hal.Stream` 。