hip.hiprtc

hip.hiprtc#

(No short description)

Attributes:

hiprtcLinkState:: alias of ihiprtcLinkState
hiprtcProgram:: alias of _hiprtcProgram

class hip.hiprtc.hiprtcResult(value)#

Bases: _hiprtcResult__Base

@{

Attributes:

HIPRTC_SUCCESS:: Success
HIPRTC_ERROR_OUT_OF_MEMORY:: Out of memory
HIPRTC_ERROR_PROGRAM_CREATION_FAILURE:: Failed to create program
HIPRTC_ERROR_INVALID_INPUT:: Invalid input
HIPRTC_ERROR_INVALID_PROGRAM:: Invalid program
HIPRTC_ERROR_INVALID_OPTION:: Invalid option
HIPRTC_ERROR_COMPILATION:: Compilation error
HIPRTC_ERROR_BUILTIN_OPERATION_FAILURE:: Failed in builtin operation
HIPRTC_ERROR_NO_NAME_EXPRESSIONS_AFTER_COMPILATION:: No name expression after compilation
HIPRTC_ERROR_NO_LOWERED_NAMES_BEFORE_COMPILATION:: No lowered names before compilation
HIPRTC_ERROR_NAME_EXPRESSION_NOT_VALID:: Invalid name expression
HIPRTC_ERROR_INTERNAL_ERROR:: Internal error
HIPRTC_ERROR_LINKING:: Error in linking

conjugate()#: Returns self, the complex conjugate of any int.

bit_length()#

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

bit_count()#

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

to_bytes(length, byteorder, *, signed=False)#

Return an array of bytes representing an integer.

length: Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes.
byteorder: The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.
signed: Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

from_bytes(byteorder, *, signed=False)#

Return the integer represented by the given array of bytes.

bytes: Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.
byteorder: The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.
signed: Indicates whether two’s complement is used to represent the integer.

as_integer_ratio()#

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

real#: the real part of a complex number

imag#: the imaginary part of a complex number

numerator#: the numerator of a rational number in lowest terms

denominator#: the denominator of a rational number in lowest terms

static ctypes_type()#: The type of the enum constants as ctypes type.

HIPRTC_SUCCESS = 0#

HIPRTC_ERROR_OUT_OF_MEMORY = 1#

HIPRTC_ERROR_PROGRAM_CREATION_FAILURE = 2#

HIPRTC_ERROR_INVALID_INPUT = 3#

HIPRTC_ERROR_INVALID_PROGRAM = 4#

HIPRTC_ERROR_INVALID_OPTION = 5#

HIPRTC_ERROR_COMPILATION = 6#

HIPRTC_ERROR_BUILTIN_OPERATION_FAILURE = 7#

HIPRTC_ERROR_NO_NAME_EXPRESSIONS_AFTER_COMPILATION = 8#

HIPRTC_ERROR_NO_LOWERED_NAMES_BEFORE_COMPILATION = 9#

HIPRTC_ERROR_NAME_EXPRESSION_NOT_VALID = 10#

HIPRTC_ERROR_INTERNAL_ERROR = 11#

HIPRTC_ERROR_LINKING = 100#

class hip.hiprtc.hiprtcJIT_option(value)#

Bases: _hiprtcJIT_option__Base

hiprtc JIT option

Attributes:

HIPRTC_JIT_MAX_REGISTERS:: CUDA Only Maximum registers may be used in a thread, passed to compiler
HIPRTC_JIT_THREADS_PER_BLOCK:: CUDA Only Number of thread per block
HIPRTC_JIT_WALL_TIME:: CUDA Only Value for total wall clock time
HIPRTC_JIT_INFO_LOG_BUFFER:: CUDA Only Pointer to the buffer with logged information
HIPRTC_JIT_INFO_LOG_BUFFER_SIZE_BYTES:: CUDA Only Size of the buffer in bytes for logged info
HIPRTC_JIT_ERROR_LOG_BUFFER:: CUDA Only Pointer to the buffer with logged error(s)
HIPRTC_JIT_ERROR_LOG_BUFFER_SIZE_BYTES:: CUDA Only Size of the buffer in bytes for logged error(s)
HIPRTC_JIT_OPTIMIZATION_LEVEL:: Value of optimization level for generated codes, acceptable options -O0, -O1, -O2, -O3
HIPRTC_JIT_TARGET_FROM_HIPCONTEXT:: CUDA Only The target context, which is the default
HIPRTC_JIT_TARGET:: CUDA Only JIT target
HIPRTC_JIT_FALLBACK_STRATEGY:: CUDA Only Fallback strategy
HIPRTC_JIT_GENERATE_DEBUG_INFO:: CUDA Only Generate debug information
HIPRTC_JIT_LOG_VERBOSE:: CUDA Only Generate log verbose
HIPRTC_JIT_GENERATE_LINE_INFO:: CUDA Only Generate line number information
HIPRTC_JIT_CACHE_MODE:: CUDA Only Set cache mode

HIPRTC_JIT_NEW_SM3X_OPT:

HIPRTC_JIT_FAST_COMPILE:: CUDA Only Set fast compile
HIPRTC_JIT_GLOBAL_SYMBOL_NAMES:: CUDA Only Array of device symbol names to be relocated to the host
HIPRTC_JIT_GLOBAL_SYMBOL_ADDRESS:: CUDA Only Array of host addresses to be relocated to the device
HIPRTC_JIT_GLOBAL_SYMBOL_COUNT:: CUDA Only Number of symbol count.

HIPRTC_JIT_LTO:

HIPRTC_JIT_FTZ:

HIPRTC_JIT_PREC_DIV:

HIPRTC_JIT_PREC_SQRT:

HIPRTC_JIT_FMA:

HIPRTC_JIT_NUM_OPTIONS:: Number of options
HIPRTC_JIT_IR_TO_ISA_OPT_EXT:: Linker options to be passed on to compiler
HIPRTC_JIT_IR_TO_ISA_OPT_COUNT_EXT:: Count of linker options to be passed on to compiler

conjugate()#: Returns self, the complex conjugate of any int.

bit_length()#

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

bit_count()#

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

to_bytes(length, byteorder, *, signed=False)#

Return an array of bytes representing an integer.

length: Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes.
byteorder: The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.
signed: Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

from_bytes(byteorder, *, signed=False)#

Return the integer represented by the given array of bytes.

bytes: Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.
byteorder: The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.
signed: Indicates whether two’s complement is used to represent the integer.

as_integer_ratio()#

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

real#: the real part of a complex number

imag#: the imaginary part of a complex number

numerator#: the numerator of a rational number in lowest terms

denominator#: the denominator of a rational number in lowest terms

static ctypes_type()#: The type of the enum constants as ctypes type.

HIPRTC_JIT_MAX_REGISTERS = 0#

HIPRTC_JIT_THREADS_PER_BLOCK = 1#

HIPRTC_JIT_WALL_TIME = 2#

HIPRTC_JIT_INFO_LOG_BUFFER = 3#

HIPRTC_JIT_INFO_LOG_BUFFER_SIZE_BYTES = 4#

HIPRTC_JIT_ERROR_LOG_BUFFER = 5#

HIPRTC_JIT_ERROR_LOG_BUFFER_SIZE_BYTES = 6#

HIPRTC_JIT_OPTIMIZATION_LEVEL = 7#

HIPRTC_JIT_TARGET_FROM_HIPCONTEXT = 8#

HIPRTC_JIT_TARGET = 9#

HIPRTC_JIT_FALLBACK_STRATEGY = 10#

HIPRTC_JIT_GENERATE_DEBUG_INFO = 11#

HIPRTC_JIT_LOG_VERBOSE = 12#

HIPRTC_JIT_GENERATE_LINE_INFO = 13#

HIPRTC_JIT_CACHE_MODE = 14#

HIPRTC_JIT_NEW_SM3X_OPT = 15#

HIPRTC_JIT_FAST_COMPILE = 16#

HIPRTC_JIT_GLOBAL_SYMBOL_NAMES = 17#

HIPRTC_JIT_GLOBAL_SYMBOL_ADDRESS = 18#

HIPRTC_JIT_GLOBAL_SYMBOL_COUNT = 19#

HIPRTC_JIT_LTO = 20#

HIPRTC_JIT_FTZ = 21#

HIPRTC_JIT_PREC_DIV = 22#

HIPRTC_JIT_PREC_SQRT = 23#

HIPRTC_JIT_FMA = 24#

HIPRTC_JIT_NUM_OPTIONS = 25#

HIPRTC_JIT_IR_TO_ISA_OPT_EXT = 10000#

HIPRTC_JIT_IR_TO_ISA_OPT_COUNT_EXT = 10001#

class hip.hiprtc.hiprtcJITInputType(value)#

Bases: _hiprtcJITInputType__Base

hiprtc JIT input type

Attributes:

HIPRTC_JIT_INPUT_CUBIN:: Input cubin
HIPRTC_JIT_INPUT_PTX:: Input PTX
HIPRTC_JIT_INPUT_FATBINARY:: Input fat binary
HIPRTC_JIT_INPUT_OBJECT:: Input object
HIPRTC_JIT_INPUT_LIBRARY:: Input library
HIPRTC_JIT_INPUT_NVVM:: Input NVVM
HIPRTC_JIT_NUM_LEGACY_INPUT_TYPES:: Number of legacy input type
HIPRTC_JIT_INPUT_LLVM_BITCODE:: LLVM bitcode or IR assembly
HIPRTC_JIT_INPUT_LLVM_BUNDLED_BITCODE:: LLVM bundled bitcode
HIPRTC_JIT_INPUT_LLVM_ARCHIVES_OF_BUNDLED_BITCODE:: LLVM archives of boundled bitcode
HIPRTC_JIT_NUM_INPUT_TYPES:: (undocumented)

conjugate()#: Returns self, the complex conjugate of any int.

bit_length()#

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

bit_count()#

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

to_bytes(length, byteorder, *, signed=False)#

Return an array of bytes representing an integer.

length: Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes.
byteorder: The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.
signed: Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

from_bytes(byteorder, *, signed=False)#

Return the integer represented by the given array of bytes.

bytes: Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.
byteorder: The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value.
signed: Indicates whether two’s complement is used to represent the integer.

as_integer_ratio()#

Return integer ratio.

Return a pair of integers, whose ratio is exactly equal to the original int and with a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

real#: the real part of a complex number

imag#: the imaginary part of a complex number

numerator#: the numerator of a rational number in lowest terms

denominator#: the denominator of a rational number in lowest terms

static ctypes_type()#: The type of the enum constants as ctypes type.

HIPRTC_JIT_INPUT_CUBIN = 0#

HIPRTC_JIT_INPUT_PTX = 1#

HIPRTC_JIT_INPUT_FATBINARY = 2#

HIPRTC_JIT_INPUT_OBJECT = 3#

HIPRTC_JIT_INPUT_LIBRARY = 4#

HIPRTC_JIT_INPUT_NVVM = 5#

HIPRTC_JIT_NUM_LEGACY_INPUT_TYPES = 6#

HIPRTC_JIT_INPUT_LLVM_BITCODE = 100#

HIPRTC_JIT_INPUT_LLVM_BUNDLED_BITCODE = 101#

HIPRTC_JIT_INPUT_LLVM_ARCHIVES_OF_BUNDLED_BITCODE = 102#

HIPRTC_JIT_NUM_INPUT_TYPES = 9#

class hip.hiprtc.ihiprtcLinkState#

Bases: Pointer

Python wrapper for cdef class chiprtc.ihiprtcLinkState.

If this type is initialized via its __init__ method, it allocates a member of the underlying C type and destroys it again if the wrapper type is deallocated.

This type also serves as adapter when appearing as argument type in a function signature. In this case, the type can further be initialized from a number of Python objects:

None:

This will set the self._ptr attribute to NULL.
int:

Interprets the integer value as pointer address and writes it to self._ptr. No ownership is transferred.
ctypes.c_void_p:

Takes the pointer address pyobj.value and writes it to self._ptr. No ownership is transferred.
object that implements the CUDA Array Interface protocol:

Takes the integer-valued pointer address, i.e. the first entry of the data tuple from pyobj’s member __cuda_array_interface__ and writes it to self._ptr.
object that implements the Python buffer protocol:

If the object represents a simple contiguous array, writes the Py_buffer associated with pyobj to self._py_buffer, sets the self._py_buffer_acquired flag to True, and writes self._py_buffer.buf to the data pointer self._ptr.
hip._util.types.Pointer:

Takes the pointer address pyobj._ptr and writes it to self._ptr. No ownership is transferred.

Type checks are performed in the above order.

C Attributes:

_ptr (C type void *, protected):: Stores a pointer to the data of the original Python object.
_is_ptr_owner (C type bint, protected):: If this wrapper is the owner of the underlying data.
_py_buffer (C type ``Py_buffer`, protected):: Stores a pointer to the data of the original Python object.
_py_buffer_acquired (C type bint, protected):: Stores a pointer to the data of the original Python object.

static PROPERTIES()#

__getitem__(key, /)#: Return self[key].

__init__()#

Constructor.

Args:

pyobj (object):: See the class description Pointer for information about accepted types for pyobj. Defaults to None.

Raises:

TypeError: If the input object pyobj is not of the right type.

as_c_void_p(self)#: Returns the data’s address as ctypes.c_void_p Note:

Implemented as function to not collide with autogenerated property names.

createRef(self) → Pointer#

Creates are reference to this pointer.

Returns a Pointer that stores the address of this `~.Pointer’s data pointer.

Note:: No ownership information is transferred.

static fromObj(pyobj)#

Creates a ihiprtcLinkState from a Python object.

Derives a ihiprtcLinkState from the given Python object pyobj. In case pyobj is itself an ihiprtcLinkState reference, this method returns it directly. No new ihiprtcLinkState is created in this case.

is_ptr_null#: If data pointer is NULL.

hip.hiprtc.hiprtcLinkState#: alias of ihiprtcLinkState

hip.hiprtc.hiprtcGetErrorString(result)#

Returns text string message to explain the error which occurred

Warning:

In HIP, this function returns the name of the error, if the hiprtc result is defined, it will return “Invalid HIPRTC error code”

See:

hip.hiprtc

Contents

hip.hiprtc#