API Reference Manual  1.45.0
api/spec/ml_types.h File Reference

ODP Machine Learning (ML) types. More...

#include <odp/visibility_begin.h>
#include <odp/api/event_types.h>
#include <odp/api/queue_types.h>
#include <odp/api/std_types.h>
#include <odp/visibility_end.h>
Include dependency graph for api/spec/ml_types.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  odp_ml_compl_pool_capability_t
 ML completion event pool capabilities. More...
 
struct  odp_ml_compl_pool_param_t
 ML completion event pool parameters. More...
 
struct  odp_ml_capability_t
 Machine learning capabilities. More...
 
struct  odp_ml_config_t
 Machine learning configuration parameters. More...
 
struct  odp_ml_shape_info_t
 Model input / output data shape information. More...
 
struct  odp_ml_input_info_t
 Model input information. More...
 
struct  odp_ml_output_info_t
 Model output information. More...
 
struct  odp_ml_model_info_t
 Model information. More...
 
struct  odp_ml_data_format_t
 Model input / output data format. More...
 
struct  odp_ml_model_param_t
 Machine learning model parameters. More...
 
struct  odp_ml_run_result_t
 Results of model run operation. More...
 
struct  odp_ml_load_result_t
 Result of model load / unload operation. More...
 
struct  odp_ml_compl_param_t
 ML completion parameters. More...
 
struct  odp_ml_data_seg_t
 Model input / output data segment. More...
 
struct  odp_ml_data_t
 Model input / output data for a model inference run. More...
 
struct  odp_ml_run_param_t
 Parameters for model run. More...
 
struct  odp_ml_extra_stat_info_t
 ML extra statistics counter information. More...
 

Macros

#define ODP_ML_MAX_DIMS   8
 Maximum number of dimensions in input / output data shape.
 
#define ODP_ML_DIM_DYNAMIC   0
 Dimension size is dynamic.
 
#define ODP_ML_COMPL_MODE_SYNC   0x1u
 Synchronous operation.
 
#define ODP_ML_COMPL_MODE_POLL   0x2u
 Asynchronous poll mode operation. More...
 
#define ODP_ML_COMPL_MODE_EVENT   0x4u
 Asynchronous event mode operation. More...
 

Typedefs

typedef uint32_t odp_ml_compl_mode_t
 ML completion mode.
 
typedef struct odp_ml_compl_pool_capability_t odp_ml_compl_pool_capability_t
 ML completion event pool capabilities. More...
 
typedef struct odp_ml_compl_pool_param_t odp_ml_compl_pool_param_t
 ML completion event pool parameters. More...
 
typedef struct odp_ml_capability_t odp_ml_capability_t
 Machine learning capabilities.
 
typedef struct odp_ml_config_t odp_ml_config_t
 Machine learning configuration parameters.
 
typedef struct odp_ml_shape_info_t odp_ml_shape_info_t
 Model input / output data shape information.
 
typedef struct odp_ml_input_info_t odp_ml_input_info_t
 Model input information.
 
typedef struct odp_ml_output_info_t odp_ml_output_info_t
 Model output information.
 
typedef struct odp_ml_model_info_t odp_ml_model_info_t
 Model information.
 
typedef struct odp_ml_data_format_t odp_ml_data_format_t
 Model input / output data format.
 
typedef struct odp_ml_model_param_t odp_ml_model_param_t
 Machine learning model parameters. More...
 
typedef struct odp_ml_run_result_t odp_ml_run_result_t
 Results of model run operation.
 
typedef struct odp_ml_load_result_t odp_ml_load_result_t
 Result of model load / unload operation.
 
typedef struct odp_ml_compl_param_t odp_ml_compl_param_t
 ML completion parameters. More...
 
typedef struct odp_ml_data_seg_t odp_ml_data_seg_t
 Model input / output data segment.
 
typedef struct odp_ml_data_t odp_ml_data_t
 Model input / output data for a model inference run.
 
typedef struct odp_ml_run_param_t odp_ml_run_param_t
 Parameters for model run. More...
 
typedef struct odp_ml_extra_stat_info_t odp_ml_extra_stat_info_t
 ML extra statistics counter information.
 

Enumerations

enum  odp_ml_data_type_t {
  ODP_ML_DATA_TYPE_NONE = 0 , ODP_ML_DATA_TYPE_INT8 , ODP_ML_DATA_TYPE_UINT8 , ODP_ML_DATA_TYPE_INT16 ,
  ODP_ML_DATA_TYPE_UINT16 , ODP_ML_DATA_TYPE_INT24 , ODP_ML_DATA_TYPE_UINT24 , ODP_ML_DATA_TYPE_INT32 ,
  ODP_ML_DATA_TYPE_UINT32 , ODP_ML_DATA_TYPE_INT64 , ODP_ML_DATA_TYPE_UINT64 , ODP_ML_DATA_TYPE_FP16 ,
  ODP_ML_DATA_TYPE_BFP16 , ODP_ML_DATA_TYPE_FP32 , ODP_ML_DATA_TYPE_FP64
}
 Model input / output data type enumeration. More...
 
enum  odp_ml_shape_type_t { ODP_ML_SHAPE_NONE = 0 , ODP_ML_SHAPE_STATIC , ODP_ML_SHAPE_BATCH }
 Model input / output data shape type. More...
 

Detailed Description

ODP Machine Learning (ML) types.

Definition in file api/spec/ml_types.h.