Enumerations

enum DataFmt

enum DataFmt : int {
  YUV420SP = 0,
  YUV422SP = 1,
  YUV444SP = 2,
  ND = 5,
};

enum tcim::DataFmt

Data format of the tensor.

Values:

enumerator YUV420SP = 0

YUV 4:2:0 Semi-Planar format, where chrominance components are subsampled in both the horizontal and vertical dimensions.

enumerator YUV422SP = 1

YUV 4:2:2 Semi-Planar format, where chrominance components are subsampled in the horizontal dimension only.

enumerator YUV444SP = 2

YUV 4:4:4 Semi-Planar format, where no subsampling is applied to chrominance components.

enumerator ND = 5

The format of non-image data.

enum DataType

enum DataType : int {
  INT8 = 0,
  UINT8 = 1,
  INT16 = 2,
  UINT16 = 3,
  INT32 = 4,
  UINT32 = 5,
  FLOAT16 = 6,
  FLOAT32 = 7,
};

enum tcim::DataType

Tensor data types.

Values:

enumerator INT8 = 0

The data is a signed 8-bit integer data type.

enumerator UINT8 = 1

The data is an unsigned 8-bit integer data type.

enumerator INT16 = 2

The data is a signed 16-bit integer data type.

enumerator UINT16 = 3

The data is an unsigned 16-bit integer data type.

enumerator INT32 = 4

The data is a signed 32-bit integer data type.

enumerator UINT32 = 5

The data is an unsigned 32-bit integer data type.

enumerator FLOAT16 = 6

The data is a 16-bit floating point data type.

enumerator FLOAT32 = 7

The data is a 32-bit floating point data type.

enum Device

enum Device : int {
  CPU = 0,
  HDPL = 1,
  DEV_INNER = 3,
  COMPND = 5,
  BLOCK_ND = 6
};

enum tcim::Device

Specifies if data is processed or stored on the host CPU or a Houmo device.

Values:

enumerator CPU = 0

The data is processed or stored on the host CPU.

enumerator HDPL = 1

The data is processed or stored on the Houmo device.

enumerator DEV_INNER = 3

The data is processed or stored on the inner device, inner device could not allocated by user. Internal use only.

enumerator COMPND = 5

The data is processed or stored on the Multi-device, only used for CompTensor.

enumerator BLOCK_ND = 6

The data is processed or stored on the block tensor. Internal use only.

enum Status

enum Status : int {
  ERR_UNDEFINED = -1,
  OK = 0,
  UNINITIALIZED = 1,
  OUT_OF_RANGE = 2,
  UNSUPPORTED = 3,
  INVALID_ARGUMENT = 4,
  ALREADY_EXISTS = 5,
  PERMISSION_DENIED = 6,
  UNAVAILABLE = 7,
  UNAUTHENTICATED = 8,
  RESOURCE_EXHAUSTED = 9,
  TIMEOUT = 10,
  ERR_KERNEL = 11,
  ERR_FATAL = 12,
  SESSION_EXPIRED = 13,
  RECOVERING = 14,
};

enum tcim::Status

The return status of the functions.

Values:

enumerator ERR_UNDEFINED = -1

An undefined or unknown internal error has occurred.

enumerator OK = 0

This function returned with no errors.

enumerator UNINITIALIZED = 1

This object or the related resource is not initialized.

enumerator OUT_OF_RANGE = 2

The index or value passed to the function is out of range.

enumerator UNSUPPORTED = 3

This function is not yet supported.

enumerator INVALID_ARGUMENT = 4

One or more arguments passed to the function are invalid.

enumerator ALREADY_EXISTS = 5

This error occurs when attempting to create an item that already exists.

enumerator PERMISSION_DENIED = 6

Permission to perform the function denied.

enumerator UNAVAILABLE = 7

The requested service or resource is temporarily unavailable.

enumerator UNAUTHENTICATED = 8

Authentication is required to access the resource.

enumerator RESOURCE_EXHAUSTED = 9

This error occurs when the resource limit, such as memory or disk space, has been reached or exceeded. You can free up resources to accommodate the function.

enumerator TIMEOUT = 10

A timeout occurred while the function is waiting to be processed.

enumerator ERR_KERNEL = 11

Internal error.

enumerator ERR_FATAL = 12

A critical unrecoverable error occurred during model inference. The IPU core must be reset using the Houmo SMI Tool. See "Houmo SMI Tool User Guide" for details.

enumerator SESSION_EXPIRED = 13

The server session has expired, typically because the server restarted and its epoch has changed. All local handles (Models, Buffers, Streams) are stale and must be released before reconnecting.

enumerator RECOVERING = 14

The runtime is currently in a recovery/reset phase (between RpcServerResetBegin and RpcServerResetEnd). All regular operations are temporarily suspended. Retry after the reset completes.