menoh.h

Go to the documentation of this file.

#ifndef MENOH_C_INTERFACE_H
#define MENOH_C_INTERFACE_H

#include <stdint.h>

#ifndef DOXYGEN_SHOULD_SKIP_THIS

#if(defined(_WIN32) || defined(__WIN32__)) && !defined(__GNUC__)
#define MENOH_API __declspec(dllexport)
#else
#define MENOH_API
#endif

#define MENOH_SUPPORTED_ONNX_OPSET_VERSION 8

#ifndef MENOH_ERROR_MESSAGE_MAX_LENGTH
#define MENOH_ERROR_MESSAGE_MAX_LENGTH 1024
#endif

#if MENOH_ERROR_MESSAGE_MAX_LENGTH < 1024
#undef MENOH_ERROR_MESSAGE_MAX_LENGTH
#define MENOH_ERROR_MESSAGE_MAX_LENGTH 1024
#endif

#if defined(__cplusplus) && __cplusplus >= 201402L
#define MENOH_DEPRECATED_ATTRIBUTE(message) [[deprecated(message)]]
#elif(defined(_WIN32) || defined(__WIN32__)) && !defined(__GNUC__)
#define MENOH_DEPRECATED_ATTRIBUTE(message) __declspec(deprecated(message))
#elif defined(__GNUC__)
#define MENOH_DEPRECATED_ATTRIBUTE(message) __attribute__((deprecated(message)))
#else
#define MENOH_DEPRECATED_ATTRIBUTE(message)
#endif

#endif // DOXYGEN_SHOULD_SKIP_THIS

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

enum menoh_dtype_constant {
    menoh_dtype_float,
};
typedef int32_t menoh_dtype;

enum menoh_error_code_constant {
    menoh_error_code_success,
    menoh_error_code_std_error,
    menoh_error_code_unknown_error,
    menoh_error_code_invalid_filename,
    menoh_error_code_unsupported_onnx_opset_version,
    menoh_error_code_onnx_parse_error,
    menoh_error_code_invalid_dtype,
    menoh_error_code_invalid_attribute_type,
    menoh_error_code_unsupported_operator_attribute,
    menoh_error_code_dimension_mismatch,
    menoh_error_code_variable_not_found,
    menoh_error_code_index_out_of_range,
    menoh_error_code_json_parse_error,
    menoh_error_code_invalid_backend_name,
    menoh_error_code_unsupported_operator,
    menoh_error_code_failed_to_configure_operator,
    menoh_error_code_backend_error,
    menoh_error_code_same_named_variable_already_exist,
    menoh_error_code_unsupported_input_dims,
    menoh_error_code_same_named_parameter_already_exist,
    menoh_error_code_same_named_attribute_already_exist,
    menoh_error_code_invalid_backend_config_error,
};
typedef int32_t menoh_error_code;
MENOH_API const char* menoh_get_last_error_message();
struct menoh_model_data;
typedef struct menoh_model_data* menoh_model_data_handle;
void MENOH_API menoh_delete_model_data(menoh_model_data_handle model_data);
menoh_error_code MENOH_API menoh_make_model_data_from_onnx(
  const char* onnx_filename, menoh_model_data_handle* dst_handle);
menoh_error_code MENOH_API menoh_make_model_data_from_onnx_data_on_memory(
  const uint8_t* onnx_data, int32_t size, menoh_model_data_handle* dst_handle);
menoh_error_code MENOH_API
menoh_make_model_data(menoh_model_data_handle* dst_handle);
menoh_error_code MENOH_API menoh_model_data_add_parameter(
  menoh_model_data_handle model_data, const char* parameter_name,
  menoh_dtype dtype, int32_t dims_size, const int32_t* dims,
  void* buffer_handle);
menoh_error_code MENOH_API menoh_model_data_add_new_node(
  menoh_model_data_handle model_data, const char* op_type);
menoh_error_code MENOH_API menoh_model_data_add_input_name_to_current_node(
  menoh_model_data_handle model_data, const char* input_name);
menoh_error_code MENOH_API menoh_model_data_add_output_name_to_current_node(
  menoh_model_data_handle model_data, const char* output_name);
menoh_error_code MENOH_API menoh_model_data_add_attribute_int_to_current_node(
  menoh_model_data_handle model_data, const char* attribute_name,
  int32_t value);
menoh_error_code MENOH_API menoh_model_data_add_attribute_float_to_current_node(
  menoh_model_data_handle model_data, const char* attribute_name, float value);
menoh_error_code MENOH_API menoh_model_data_add_attribute_ints_to_current_node(
  menoh_model_data_handle model_data, const char* attribute_name, int32_t size,
  const int32_t* value);
menoh_error_code MENOH_API
menoh_model_data_add_attribute_floats_to_current_node(
  menoh_model_data_handle model_data, const char* attribute_name, int32_t size,
  const float* value);
struct menoh_variable_profile_table_builder;
typedef struct menoh_variable_profile_table_builder*
  menoh_variable_profile_table_builder_handle;

menoh_error_code MENOH_API menoh_make_variable_profile_table_builder(
  menoh_variable_profile_table_builder_handle* dst_handle);
void MENOH_API menoh_delete_variable_profile_table_builder(
  menoh_variable_profile_table_builder_handle builder);

menoh_error_code MENOH_API
menoh_variable_profile_table_builder_add_input_profile(
  menoh_variable_profile_table_builder_handle builder, const char* name,
  menoh_dtype dtype, int32_t dims_size, const int32_t* dims);

MENOH_DEPRECATED_ATTRIBUTE(
  "please use menoh_variable_profile_table_builder_add_input_profile() instead")
menoh_error_code MENOH_API
menoh_variable_profile_table_builder_add_input_profile_dims_2(
  menoh_variable_profile_table_builder_handle builder, const char* name,
  menoh_dtype dtype, int32_t num, int32_t size);

MENOH_DEPRECATED_ATTRIBUTE(
  "please use menoh_variable_profile_table_builder_add_input_profile() instead")
menoh_error_code MENOH_API
menoh_variable_profile_table_builder_add_input_profile_dims_4(
  menoh_variable_profile_table_builder_handle builder, const char* name,
  menoh_dtype dtype, int32_t num, int32_t channel, int32_t height,
  int32_t width);

menoh_error_code MENOH_API menoh_variable_profile_table_builder_add_output_name(
  menoh_variable_profile_table_builder_handle builder, const char* name);

MENOH_DEPRECATED_ATTRIBUTE(
  "please use menoh_variable_profile_table_builder_add_output_name() instead. "
  "dtype is totally ignored.")
menoh_error_code MENOH_API
menoh_variable_profile_table_builder_add_output_profile(
  menoh_variable_profile_table_builder_handle builder, const char* name,
  menoh_dtype dtype);

struct menoh_variable_profile_table;
typedef struct menoh_variable_profile_table*
  menoh_variable_profile_table_handle;

menoh_error_code MENOH_API menoh_build_variable_profile_table(
  const menoh_variable_profile_table_builder_handle builder,
  const menoh_model_data_handle model_data,
  menoh_variable_profile_table_handle* dst_handle);
void MENOH_API menoh_delete_variable_profile_table(
  menoh_variable_profile_table_handle variable_profile_table);

menoh_error_code MENOH_API menoh_variable_profile_table_get_dtype(
  const menoh_variable_profile_table_handle variable_profile_table,
  const char* variable_name, menoh_dtype* dst_dtype);

menoh_error_code MENOH_API menoh_variable_profile_table_get_dims_size(
  const menoh_variable_profile_table_handle variable_profile_table,
  const char* variable_name, int32_t* dst_size);

menoh_error_code MENOH_API menoh_variable_profile_table_get_dims_at(
  const menoh_variable_profile_table_handle variable_profile_table,
  const char* variable_name, int32_t index, int32_t* dst_size);

menoh_error_code MENOH_API menoh_model_data_optimize(
  menoh_model_data_handle model_data,
  const menoh_variable_profile_table_handle variable_profile_table);

struct menoh_model_builder;
typedef struct menoh_model_builder* menoh_model_builder_handle;

menoh_error_code MENOH_API menoh_make_model_builder(
  const menoh_variable_profile_table_handle variable_profile_table,
  menoh_model_builder_handle* dst_handle);
void MENOH_API
menoh_delete_model_builder(menoh_model_builder_handle model_builder);

menoh_error_code MENOH_API menoh_model_builder_attach_external_buffer(
  menoh_model_builder_handle builder, const char* variable_name,
  void* buffer_handle);

struct menoh_model;
typedef struct menoh_model* menoh_model_handle;

menoh_error_code MENOH_API menoh_build_model(
  const menoh_model_builder_handle builder,
  const menoh_model_data_handle model_data, const char* backend_name,
  const char* backend_config, menoh_model_handle* dst_model_handle);
void MENOH_API menoh_delete_model(menoh_model_handle model);

menoh_error_code MENOH_API menoh_model_get_variable_buffer_handle(
  const menoh_model_handle model, const char* variable_name, void** dst_data);

menoh_error_code MENOH_API menoh_model_get_variable_dtype(
  const menoh_model_handle model, const char* variable_name,
  menoh_dtype* dst_dtype);

menoh_error_code MENOH_API menoh_model_get_variable_dims_size(
  const menoh_model_handle model, const char* variable_name, int32_t* dst_size);

menoh_error_code MENOH_API menoh_model_get_variable_dims_at(
  const menoh_model_handle model, const char* variable_name, int32_t index,
  int32_t* dst_size);

menoh_error_code MENOH_API menoh_model_run(menoh_model_handle model);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif // MENOH_C_INTERFACE_H