Functions | Variables
Core

Functions

 __attribute__ ((visibility("default"))) ie_version_t ie_c_api_version(void)
 Returns number of version that is exported. Use the ie_version_free() to free memory. More...
 

Variables

ie_core_t ** core
 
const char * device_name
 
const char ie_core_versions_tversions
 
const char * xml
 
const char const char * weights_file
 
const char const char ie_network_t ** network
 
const uint8_t * xml_content
 
const uint8_t size_t xml_content_size
 
const uint8_t size_t const ie_blob_t * weight_blob
 
const ie_network_t const char const ie_config_tconfig
 
const ie_network_t const char const ie_config_t ie_executable_network_t ** exe_network
 
const ie_config_tie_core_config
 
const char * plugin_name
 
const char * xml_config_file
 
const char * extension_path
 
const char const char * metric_name
 
const char const char ie_param_tparam_result
 
const char const char * config_name
 
ie_available_devices_tavai_devices
 

Detailed Description

Set of functions dedicated to working with registered plugins and loading network to the registered devices.

Function Documentation

◆ __attribute__()

__attribute__ ( (visibility("default"))  )

Returns number of version that is exported. Use the ie_version_free() to free memory.

Gets precision of blob's tensor.

Gets layout of blob's tensor.

Gets dimensions of blob's tensor.

Gets read-only access to the allocated memory.

Gets access to the allocated memory .

Releases previously allocated data.

Gets the size of the current Blob in bytes.

Gets the total number of elements, which is a product of all the dimensions.

Creates I420 blob from three planes Y, U and V.

Creates a NV12 blob from two planes Y and UV.

Creates a blob describing given roi_t instance based on the given blob with pre-allocated memory.

Creates a blob with the given tensor descriptor from the pointer to the pre-allocated memory.

Creates a blob with the specified dimensions, layout and to allocate memory.

Releases momory occupied by input_name or output_name.

Releases memory occupied by input_shapes.

Gets dimensions/shape of the output data with reversed order.

Changes the layout of the output data named "output_name".

Gets a layout of the output data.

Changes the precision of the output data named "output_name".

Gets a precision of the output data named "output_name".

Gets number of output for the network.

Run shape inference with new input shapes for the network.

Helper method collect all input shapes with input names of corresponding input data. Use the ie_network_input_shapes_free() method to free memory.

Changes the color format of the input data.

Gets color format of the input data.

Sets resize algorithm to be used during pre-processing.

Gets pre-configured resize algorithm.

Changes the layout of the input data named "input_name". This function should be called before loading the network to the device.

Gets a layout of the input data.

Changes the precision of the input data provided by the user. This function should be called before loading the network to the device.

Gets a precision of the input data provided by user.

Gets name corresponding to the "number". Use the ie_network_name_free() method to free memory.

Gets number of inputs for the network.

Get name of network.

When netowrk is loaded into the Infernece Engine, it is not required anymore and should be released.

Sets new batch size for certain infer request when dynamic batching is enabled in executable network that created this request.

Waits for the result to become available. Blocks until specified timeout elapses or the result becomes available, whichever comes first.

Sets a callback function that will be called on success or failure of asynchronous request.

Starts asynchronous inference of the infer request and fill outputs.

Starts synchronous inference of the infer request and fill outputs.

Sets input/output data to inference.

Gets input/output data for inference.

Releases memory occupied by ie_infer_request_t instance.

Gets configuration for current executable network. The method is responsible to extract information which affects executable network execution.

Sets configuration for current executable network. Currently, the method can be used when the network run on the Multi device and the configuration paramter is only can be "MULTI_DEVICE_PRIORITIES".

Gets general runtime metric for an executable network. It can be network name, actual device ID on which executable network is running or all other properties which cannot be changed dynamically.

Creates an inference request instance used to infer the network. The created request has allocated input and output blobs (that can be changed later). Use the ie_infer_request_free() method to free memory.

Releases memory occupied by ExecutableNetwork.

Releases memory occpuied by ie_available_devices_t.

Gets available devices for neural network inference.

Gets configuration dedicated to device behaviour. The method is targeted to extract information which can be set via SetConfig method.

Gets general runtime metric for dedicated hardware. The method is needed to request common device properties which are executable network agnostic. It can be device name, temperature, other devices-specific values.

Loads extension library to the device with a specified device name.

Unregisters a plugin with a specified device name.

Registers plugins specified in an ".xml" configuration file.

Registers a new device and a plugin which implement this device inside Inference Engine.

Sets configuration for device.

Creates an executable network from a network object. Users can create as many networks as they need and use them simultaneously (up to the limitation of the hardware resources). Use the ie_exec_network_free() method to free memory.

Reads the model from an xml string and a blob of the bin part of the IR. Use the ie_network_free() method to free memory.

Reads the model from the .xml and .bin files of the IR. Use the ie_network_free() method to free memory.

Releases memory occupied by ie_core_versions.

Gets version information of the device specified. Use the ie_core_versions_free() method to free memory.

Releases memory occupied by core.

Constructs Inference Engine Core instance using XML configuration file with devices description. See RegisterPlugins for more details. Use the ie_core_free() method to free memory.

Release the memory allocated by ie_param_t.

Release the memory allocated by ie_c_api_version.

Returns
Version number of the API.
Parameters
versionA pointer to the ie_version_t to free memory.
versionA pointer to the ie_param_t to free memory.
xml_config_fileA path to .xml file with devices to load from. If XML configuration file is not specified, then default Inference Engine devices are loaded from the default plugin.xml file.
coreA pointer to the newly created ie_core_t.
Returns
Status code of the operation: OK(0) for success.
Parameters
coreA pointer to the core to free memory.
coreA pointer to ie_core_t instance.
device_nameName to indentify device.
versionsA pointer to versions corresponding to device_name.
Returns
Status code of the operation: OK(0) for success.
Parameters
versA pointer to the ie_core_versions to free memory.
coreA pointer to ie_core_t instance.
xml.xml file's path of the IR.
weights_file.bin file's path of the IR, if path is empty, will try to read bin file with the same name as xml and if bin file with the same name was not found, will load IR without weights.
networkA pointer to the newly created network.
Returns
Status code of the operation: OK(0) for success.
Parameters
coreA pointer to ie_core_t instance.
xml_contentXml content of the IR.
xml_content_sizeNumber of bytes in the xml content of the IR.
weight_blobBlob containing the bin part of the IR.
networkA pointer to the newly created network.
Returns
Status code of the operation: OK(0) for success.
Parameters
coreA pointer to ie_core_t instance.
networkA pointer to ie_network instance.
device_nameName of device to load network to.
configDevice configuration.
exe_networkA pointer to the newly created executable network.
Returns
Status code of the operation: OK(0) for success.
Parameters
coreA pointer to ie_core_t instance.
ie_core_configDevice configuration.
device_nameAn optinal name of a device. If device name is not specified, the config is set for all the registered devices.
Returns
Status code of the operation: OK(0) for success.
Parameters
coreA pointer to ie_core_t instance.
plugin_nameA name of a plugin. Depending on a platform, plugin_name is wrapped with a shared library suffix and a prefix to identify a full name of the library.
device_nameA device name to register plugin for. If not specified, the method registers a plugin with the default name.
Returns
Status code of the operation: OK(0) for success.
Parameters
coreA pointer to ie_core_t instance.
xml_config_fileA full path to ".xml" file containing plugins configuration.
Returns
Status code of the operation: OK(0) for success.
Parameters
coreA pointer to ie_core_t instance.
device_nameA device name of the device to unregister.
Returns
Status code of the operation: OK(0) for success.
Parameters
coreA pointer to ie_core_t instance.
extension_pathPath to the extensions library file to load to a device.
device_nameA device name of a device to load the extensions to.
Returns
Status code of the operation: OK(0) for success.
Parameters
coreA pointer to ie_core_t instance.
device_nameA name of a device to get a metric value.
metric_nameA metric name to request.
param_resultA metric value corresponding to the metric_name.
Returns
Status code of the operation: OK(0) for success.
Parameters
coreA pointer to ie_core_t instance.
device_nameA name of a device to get a configuration value.
config_nameName of a configuration.
param_resultA configuration value corresponding to the config_name.
Returns
Status code of the operation: OK(0) for success.
Parameters
coreA pointer to ie_core_t instance.
avai_devicesThe devices are returned as { CPU, FPGA.0, FPGA.1, MYRIAD } If there more than one device of specific type, they are enumerated with .# suffix
Returns
Status code of the operation: OK(0) for success.
Parameters
avai_devicesA pointer to the ie_available_devices_t to free memory.
ie_exec_networkA pointer to the ExecutableNetwork to free memory.
ie_exec_networkA pointer to ie_executable_network_t instance.
requestA pointer to the newly created ie_infer_request_t instance
Returns
Status code of the operation: OK(0) for success.
Parameters
ie_exec_networkA pointer to ie_executable_network_t instance.
metric_nameA metric name to request.
param_resultA metric value corresponding to the metric_name.
Returns
Status code of the operation: OK(0) for success.
Parameters
ie_exec_networkA pointer to ie_executable_network_t instance.
param_configA pointer to device configuration..
Returns
Status code of the operation: OK(0) for success.
Parameters
ie_exec_networkA pointer to ie_executable_network_t instance.
metric_configA configuration parameter name to request.
param_resultA configuration value corresponding to a configuration paramter name.
Returns
Status code of the operation: OK(0) for success.
Parameters
infer_requestA pointer to the ie_infer_request_t to free memory.
infer_requestA pointer to ie_infer_request_t instance.
nameName of input or output blob.
blobA pointer to input or output blob. The type of Blob must match the network input precision and size.
Returns
Status code of the operation: OK(0) for success.
Parameters
infer_requestA pointer to ie_infer_request_t instance.
nameName of input or output blob.
blobReference to input or output blob. The type of a blob must match the network input precision and size.
Returns
Status code of the operation: OK(0) for success.
Parameters
infer_requestA pointer to ie_infer_request_t instance.
Returns
Status code of the operation: OK(0) for success.
Parameters
infer_requestA pointer to ie_infer_request_t instance.
callbackA function to be called.
Returns
Status code of the operation: OK(0) for success.
Parameters
infer_requestA pointer to ie_infer_request_t instance.
timeoutMaximum duration in milliseconds to block for
Note
There are special cases when timeout is equal some value of the WaitMode enum:
  • 0 - Immediately returns the inference status. It does not block or interrupt execution.
  • -1 - waits until inference result becomes available
Returns
Status code of the operation: OK(0) for success.
Parameters
infer_requestA pointer to ie_infer_request_t instance.
sizeNew batch size to be used by all the following inference calls for this request.
Returns
Status code of the operation: OK(0) for success.
Parameters
networkThe pointer to the instance of the ie_network_t to free.
nameName of the network.
Returns
Status code of the operation: OK(0) for success.
Parameters
networkA pointer to the instance of the ie_network_t to get number of input information.
size_resultA number of the instance's input information.
Returns
Status code of the operation: OK(0) for success.
Parameters
networkA pointer to theinstance of the ie_network_t to get input information.
numberAn id of input information .
nameInput name corresponding to the number.
Returns
status Status code of the operation: OK(0) for success.
Parameters
networkA pointer to ie_network_t instance.
input_nameName of input data.
prec_resultA pointer to the precision used for input blob creation.
Returns
Status code of the operation: OK(0) for success.
Parameters
networkA pointer to ie_network_t instance.
input_nameName of input data.
pA new precision of the input data to set (eg. precision_e.FP16).
Returns
Status code of the operation: OK(0) for success.
Parameters
networkA pointer to ie_network_t instance.
input_nameName of input data.
layout_resultA pointer to the layout used for input blob creation.
Returns
Status code of the operation: OK(0) for success.
Parameters
networkA pointer to ie_network_t instance.
input_nameName of input data.
lA new layout of the input data to set.
Returns
Status code of the operation: OK(0) for success.

@Gets dimensions/shape of the input data with reversed order.

Parameters
networkA pointer to ie_network_t instance.
input_nameName of input data.
dims_resultA pointer to the dimensions used for input blob creation.
Returns
Status code of the operation: OK(0) for success.
Parameters
networkA pointer to ie_network_t instance.
input_nameName of input data. @parm resize_alg_result The pointer to the resize algorithm used for input blob creation.
Returns
Status code of the operation: OK(0) for success.
Parameters
networkA pointer to ie_network_t instance.
input_nameName of input data.
resize_algoResize algorithm.
Returns
Status code of the operation: OK(0) for success.
Parameters
networkA pointer to ie_network_t instance.
input_nameName of input data.
colformat_resultThe pointer to the color format used for input blob creation. @reutrn Status code of the operation: OK(0) for success.
networkA pointer to ie_network_t instance.
input_nameName of input data.
color_formatColor format of the input data. @reutrn Status code of the operation: OK(0) for success.
networkA pointer to the instance of the ie_network_t to get input shapes.
shapesA pointer to the input_shapes.
Returns
Status code of the operation: OK(0) for success.
Parameters
networkA pointer to the instance of the ie_network_t to reshape.
shapesA new input shapes to set for the network.
Returns
Status code of the operation: OK(0) for success.
Parameters
networkA pointer to the instance of the ie_network_t to get number of ouput information.
size_resultA number of the network's output information.
Returns
Status code of the operation: OK(0) for success.
Parameters
networkA pointer to theinstance of the ie_network_t to get output information.
numberAn id of output information .
nameOutput name corresponding to the number.
Returns
Status code of the operation: OK(0) for success.
Parameters
networkA pointer to ie_network_t instance.
output_nameName of output data.
prec_resultA pointer to the precision used for output blob creation.
Returns
Status code of the operation: OK(0) for success.
Parameters
networkA pointer to ie_network_t instance.
output_nameName of output data.
pA new precision of the output data to set (eg. precision_e.FP16).
Returns
Status code of the operation: OK(0) for success.
Parameters
networkA pointer to ie_network_t instance.
output_nameName of output data.
layout_resultA pointer to the layout used for output blob creation.
Returns
Status code of the operation: OK(0) for success.
Parameters
networkA pointer to ie_network_t instance.
output_nameName of output data.
lA new layout of the output data to set.
Returns
Status code of the operation: OK(0) for success.
Parameters
networkA pointer to ie_network_t instance.
output_nameName of output data.
dims_resultA pointer to the dimensions used for output blob creation.
Returns
Status code of the operation: OK(0) for success.
Parameters
inputShapesA pointer to the input_shapes to free memory.
nameA pointer to the input_name or output_name to free memory.
tensorDescTensor descriptor for Blob creation.
blobA pointer to the newly created blob.
Returns
Status code of the operation: OK(0) for success.
Parameters
tensorDescTensor descriptor for Blob creation.
ptrPointer to the pre-allocated memory.
sizeLength of the pre-allocated array.
blobA pointer to the newly created blob.
Returns
Status code of the operation: OK(0) for success.
Parameters
inputBloboriginal blob with pre-allocated memory.
roiA roi_tinstance inside of the original blob.
blobA pointer to the newly created blob.
Returns
Status code of the operation: OK(0) for success.
Parameters
yA pointer to the ie_blob_t instance that represents Y plane in NV12 color format.
uvA pointer to the ie_blob_t instance that represents UV plane in NV12 color format.
nv12BlobA pointer to the newly created blob.
Returns
Status code of the operation: OK(0) for success.
Parameters
yA pointer to the ie_blob_t instance that represents Y plane in I420 color format.
uA pointer to the ie_blob_t instance that represents U plane in I420 color format.
vA pointer to the ie_blob_t instance that represents V plane in I420 color format.
i420BlobA pointer to the newly created blob.
Returns
Status code of the operation: OK(0) for success.
Parameters
blobA pointer to the blob.
size_resultThe total number of elements.
Returns
Status code of the operation: OK(0) for success.
Parameters
blobA pointer to the blob.
bsize_resultThe size of the current blob in bytes.
Returns
Status code of the operation: OK(0) for success.
Parameters
blobA pointer to the blob to free memory.
blobA pointer to the blob.
blob_bufferA pointer to the copied data from the given blob.
Returns
Status code of the operation: OK(0) for success.
Parameters
blobA pointer to the blob.
blob_cbufferA pointer to the coped data from the given pointer to the blob and the data is read-only.
Returns
Status code of the operation: OK(0) for success
Parameters
blobA pointer to the blob.
dims_resultA pointer to the dimensions of blob's tensor.
Returns
Status code of the operation: OK(0) for success.
Parameters
blobA pointer to the blob.
layout_resultA pointer to the layout of blob's tensor.
Returns
Status code of the operation: OK(0) for success.
Parameters
blobA pointer to the blob.
prec_resultA pointer to the precision of blob's tensor.
Returns
Status code of the operation: OK(0) for success.

@Releases the memory occupied by the ie_blob_t pointer.

Parameters
blobA pointer to the blob pointer to release memory.