OpenCL Runtime: Basics

Version Queries

pyopencl.VERSION

Gives the numeric version of PyOpenCL as a variable-length tuple of integers. Enables easy version checks such as VERSION >= (0, 93).

pyopencl.VERSION_STATUS

A text string such as "rc4" or "beta" qualifying the status of the release.

pyopencl.VERSION_TEXT

The full release name (such as "0.93rc4") in string form.

pyopencl.get_cl_header_version()

Return a variable-length tuple of integers representing the version of the OpenCL header against which PyOpenCL was compiled.

Added in version 0.92.

Error Reporting

class pyopencl.Error

Base class for all PyOpenCL exceptions.

class pyopencl.MemoryError
class pyopencl.LogicError
class pyopencl.RuntimeError

References

These are only here because Sphinx, our documentation tool, struggles to resolve them.

class pyopencl.WaitList

A Sequence of Events or None.

class pyopencl.NDArray

See numpy.typing.NDArray.

class pyopencl.DTypeLike

See numpy.typing.DTypeLike.

class pyopencl.SVMInnerT

A type variable for the object wrapped by an SVM.

class pyopencl.RetT

A generic type variable, used for a return type.

class pyopencl.P

A ParamSpec.

class pyopencl.typing.DTypeT

A type variable for a numpy.dtype.

class pyopencl._cl.svm_mem_flags

See pyopencl.svm_mem_flags.

class cl.WaitList

A Sequence of Events or None.

class cl.Context

See pyopencl.Context.

class cl.CommandQueue

See pyopencl.CommandQueue.

class cl.Event

See pyopencl.Event.

class cl_tools.AllocatorBase

See pyopencl.tools.AllocatorBase.