C API
You can use the following C APIs to run inference with MAX Engine.
For a walkthrough, see how to run inference with C.
API headers
Each of the following pages represents one of the C API header files:
-
M_newCompileConfig()M_cloneCompileConfig()M_setModelPath()M_newModelSource()M_setModelSource()M_compileModel()M_waitForCompilation()M_compileModelSync()M_initModel()M_getInputNames()M_getOutputNames()M_getTensorNameAt()M_getModelInputSpecByName()M_getModelOutputSpecByName()M_waitForModel()M_executeModelSync()M_getNumModelInputs()M_getNumModelOutputs()M_validateInputTensorSpec()M_freeModel()M_freeCompiledModel()M_freeCompileConfig()M_freeModelSource()M_exportCompiledModel()
-
M_newTensorSpec()M_isDynamicRanked()M_getDimAt()M_getRank()M_getDtype()M_getName()M_newAsyncTensorMap()M_copyAsyncTensorMap()M_getTensorMapSize()M_borrowTensorInto()M_createBorrowedTensor()M_getTensorByNameFrom()M_tensorMapKeys()M_deleteTensorMapKeys()M_getTensorFromValue()M_getTensorNumElements()M_getTensorType()M_getTensorData()M_getTensorSpec()M_getTensorMapIterator()M_advanceTensorMapIterator()M_getNameFromMapIterator()M_getTensorFromMapIterator()M_isEndOfTensorMap()M_freeTensor()M_freeTensorNameArray()M_freeTensorSpec()M_freeAsyncTensorMap()M_freeTensorMapIterator()
-
M_StatusM_RuntimeConfigM_RuntimeContextM_UInt64CounterM_DoubleCounterM_UInt64HistogramM_DoubleHistogramM_Int64GaugeM_DoubleGaugeM_CustomMetricReaderM_CompileConfigM_DeviceConfigM_AsyncCompiledModelM_AsyncModelM_AsyncTensorM_TensorNameArrayM_TensorSpecM_AsyncTensorMapM_TensorMapIteratorM_AsyncValueM_ConfigM_AsyncDictM_AsyncListM_AsyncTupleM_AsyncNoneM_MaxContextM_ModelSourceM_WeightsRegistryM_DevicesListM_DeviceRefsListM_DtypeM_UNKNOWNmIsIntegermIsFloatmIsComplexmIsSignedkIntWidthShiftM_INT1M_UINT1M_INT2M_UINT2M_INT4M_UINT4M_INT8M_UINT8M_INT16M_UINT16M_INT32M_UINT32M_INT64M_UINT64M_INT128M_UINT128M_FLOAT8_E3M4M_FLOAT8_E4M3M_FLOAT8_E4M3FNM_FLOAT8_E4M3FNUZM_FLOAT8_E5M2M_FLOAT8_E5M2FNUZM_FLOAT16M_BFLOAT16M_FLOAT32M_FLOAT64M_TF32M_BOOLM_AllocatorTypekSystemkCachingM_ValueTypeM_STRING_VALUEM_DOUBLE_VALUEM_LONG_VALUEM_BOOL_VALUEM_TENSOR_VALUEM_LIST_VALUEM_TUPLE_VALUEM_DICT_VALUEM_NONE_VALUEM_UNKNOWN_VALUEM_MOJO_VALUEM_PYTHON_MOJO_VALUEM_FrameworkFormatM_MAX_GRAPH_FRAMEWORK_FORMATM_TORCHSCRIPT_MODULE_FRAMEWORK_FORMATM_TORCHSCRIPT_FUNCTION_FRAMEWORK_FORMATM_TORCH_MLIR_FRAMEWORK_FORMATM_ResultOutputStyleM_COMPACTM_FULLM_BINARYM_BINARY_MAX_CHECKPOINTM_NONE
-
M_getValueByNameFrom()M_getValueFromMapIterator()M_freeValue()M_getStringFromValue()M_createStringAsyncValue()M_getDoubleFromValue()M_createDoubleAsyncValue()M_getLongFromValue()M_createLongAsyncValue()M_getBoolFromValue()M_createBoolAsyncValue()M_borrowValueInto()M_getValueType()M_getDictFromValue()M_createDictAsyncValue()M_insertIntoDict()M_getListFromValue()M_createListAsyncValue()M_appendToList()M_getTupleFromValue()M_borrowIntoTuple()M_createTupleAsyncValue()M_getDictSize()M_getListSize()M_getTupleSize()M_getDictKey()M_getDictValue()M_getListValue()M_getTupleValue()M_createNoneAsyncValue()M_freeDict()M_freeList()M_freeTuple()M_freeNone()
Async API usage
Our C API allows for compiling and executing models asynchronously. In general, effective use of asynchronous APIs may be difficult, but rewarding for performance. To help with this, we’re going to explain some important concepts and mental models to keep in mind with the API.
Our APIs are async-safe unless stated otherwise, typically with a Sync in the
function identifier name. For example, we have M_executeModel and
M_executeModelSync().
Types
Our API describes the underlying async-holding types with a “value or error” concept. Conceptually, this means that the type is in one of three states:
Constructed- the value is not yet there, but there is no errorAvailable- the value is there and ready for useError- the value is not there and there is an error
Synchronization points
When using async APIs, it is a good idea to be mindful of the synchronization
point APIs currently provided below. This is useful for discerning between the
Constructed and Available states mentioned above. After calling the
synchronization point, the input will never be in a Constructed state: it will
always resolve to either being Available or Error.
M_waitForCompilation()M_waitForModel()M_waitForTensors
Errors
Errors surface immediately when using our synchronous APIs. Otherwise, in the
case of async APIs, errors will not surface until the next synchronization
point. You can query the error message by calling M_getError().
Was this page helpful?
Thank you! We'll create more content like this.
Thank you for helping us improve!