Shortcuts

Event

class torch.xpu.Event(enable_timing=False)[source][source]

Wrapper around a XPU event.

XPU events are synchronization markers that can be used to monitor the device’s progress, and to synchronize XPU streams.

The underlying XPU events are lazily initialized when the event is first recorded. After creation, only streams on the same device may record the event. However, streams on any device can wait on the event.

Parameters

enable_timing (bool, optional) – indicates if the event should measure time (default: False)

elapsed_time(end_event)[source][source]

Return the time elapsed.

Time reported in milliseconds after the event was recorded and before the end_event was recorded.

query()[source][source]

Check if all work currently captured by event has completed.

Returns

A boolean indicating if all work currently captured by event has completed.

Return type

bool

record(stream=None)[source][source]

Record the event in a given stream.

Uses torch.xpu.current_stream() if no stream is specified. The stream’s device must match the event’s device.

synchronize()[source][source]

Wait for the event to complete.

Waits until the completion of all work currently captured in this event. This prevents the CPU thread from proceeding until the event completes.

wait(stream=None)[source][source]

Make all future work submitted to the given stream wait for this event.

Use torch.xpu.current_stream() if no stream is specified.

Docs

Access comprehensive developer documentation for PyTorch

View Docs

Tutorials

Get in-depth tutorials for beginners and advanced developers

View Tutorials

Resources

Find development resources and get your questions answered

View Resources