cupy.cuda.Stream¶

class cupy.cuda.Stream(null=False, non_blocking=False)[source]¶

CUDA stream.

This class handles the CUDA stream handle in RAII way, i.e., when an Stream instance is destroyed by the GC, its handle is also destroyed.

Parameters:	null (bool) – If `True`, the stream is a null stream (i.e. the default stream that synchronizes with all streams). Otherwise, a plain new stream is created. non_blocking (bool) – If `True`, the stream does not synchronize with the NULL stream.
Variables:	ptr (cupy.cuda.runtime.Stream) – Raw stream handle. It can be passed to the CUDA Runtime API via ctypes.

Methods

add_callback(callback, arg)[source]¶

Adds a callback that is called when all queued work is done.

Parameters:	callback (function) – Callback function. It must take three arguments (Stream object, int error status, and user data object), and returns nothing. arg (object) – Argument to the callback.

record(event=None)[source]¶

Records an event on the stream.

Parameters:	event (None or cupy.cuda.Event) – CUDA event. If `None`, then a new plain event is created and used.
Returns:	The recorded event.
Return type:	cupy.cuda.Event

See also

wait_event(event)[source]¶

Makes the stream wait for an event.

The future work on this stream will be done after the event.

Parameters:	event (cupy.cuda.Event) – CUDA event.

Attributes