Skip to content

[DOC]: Description of EventOptions.busy_waited_sync is contradictory #657

@carterbox

Description

@carterbox

Is this a duplicate?

Is this for new documentation, or an update to existing docs?

Update

Describe the incorrect/future/missing documentation

This documentation states the following:

busy_waited_sync

If True, event will use blocking synchronization. When a CPU thread calls synchronize, the
call will block until the event has actually been completed. Otherwise, the CPU thread will
busy-wait until the event has been completed. (Default to False)

Type:
[bool](https://docs.python.org/3/library/functions.html#bool), optional

This description is confusion because the text implies: busy_waited_sync=True -> blocking, but from the parameter name, you would think that busy_waited_sync=True -> busy waiting.

The upstream docs are no help because they use the opposite convention where the flag is named cudaEventBlockingSync https://docs.nvidia.com/cuda/cuda-runtime-api/group__CUDART__EVENT.html#group__CUDART__EVENT and busy waiting seems to be the default?

If this is a correction, please provide a link to the incorrect documentation. If this is a new documentation request, please link to where you have looked.

https://nvidia.github.io/cuda-python/cuda-core/0.2.0/generated/cuda.core.experimental.EventOptions.html

Metadata

Metadata

Assignees

Labels

cuda.coreEverything related to the cuda.core moduledocumentationImprovements or additions to documentation

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions