ailia  1.6.0.0
ailia.h
Go to the documentation of this file.
1 
15 #ifndef INCLUDED_AILIA
16 #define INCLUDED_AILIA
17 #include <wchar.h>
18 
19 /* 呼び出し規約 */
20 
21 #if defined(_WIN64) || defined(_M_X64) || defined(__amd64__) || defined(__x86_64__) || defined(__APPLE__) || \
22  defined(__ANDROID__) || defined(ANDROID) || defined(__linux__) || defined(NN_NINTENDO_SDK)
23 #define AILIA_API
24 #else
25 #define AILIA_API __stdcall
26 #endif
27 
28 #include "ailia_call.h"
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 /****************************************************************
34  * ライブラリ状態定義
35  **/
36 
46 #define AILIA_STATUS_SUCCESS (0)
58 #define AILIA_STATUS_INVALID_ARGUMENT (-1)
70 #define AILIA_STATUS_ERROR_FILE_API (-2)
82 #define AILIA_STATUS_INVALID_VERSION (-3)
94 #define AILIA_STATUS_BROKEN (-4)
106 #define AILIA_STATUS_MEMORY_INSUFFICIENT (-5)
118 #define AILIA_STATUS_THREAD_ERROR (-6)
130 #define AILIA_STATUS_INVALID_STATE (-7)
144 #define AILIA_STATUS_UNSUPPORTED_NET (-9)
148 #define AILIA_STATUS_UNSUPPORT_NET (-9)
162 #define AILIA_STATUS_INVALID_LAYER (-10)
174 #define AILIA_STATUS_INVALID_PARAMINFO (-11)
187 #define AILIA_STATUS_NOT_FOUND (-12)
201 #define AILIA_STATUS_GPU_UNSUPPORTED_LAYER (-13)
205 #define AILIA_STATUS_GPU_UNSUPPORT_LAYER (-13)
217 #define AILIA_STATUS_GPU_ERROR (-14)
231 #define AILIA_STATUS_UNIMPLEMENTED (-15)
245 #define AILIA_STATUS_PERMISSION_DENIED (-16)
257 #define AILIA_STATUS_EXPIRED (-17)
271 #define AILIA_STATUS_UNSETTLED_SHAPE (-18)
284 #define AILIA_STATUS_DATA_HIDDEN (-19)
285 #define AILIA_STATUS_DATA_REMOVED AILIA_STATUS_DATA_HIDDEN
298 #define AILIA_STATUS_LICENSE_NOT_FOUND (-20)
312 #define AILIA_STATUS_LICENSE_BROKEN (-21)
327 #define AILIA_STATUS_LICENSE_EXPIRED (-22)
340 #define AILIA_STATUS_NDIMENSION_SHAPE (-23)
354 #define AILIA_STATUS_OTHER_ERROR (-128)
355 
356 /****************************************************************
357  * ネットワークオブジェクトのインスタンス
358  **/
359 
360 struct AILIANetwork;
361 
362 /****************************************************************
363  * 形状情報
364  **/
365 
366 #define AILIA_SHAPE_VERSION (1)
367 
368 typedef struct _AILIAShape {
376  unsigned int x;
384  unsigned int y;
392  unsigned int z;
400  unsigned int w;
408  unsigned int dim;
410 
411 /****************************************************************
412  * スレッド数
413  **/
414 
415 #define AILIA_MULTITHREAD_AUTO (0)
416 
417 /****************************************************************
418  * 推論実行環境自動設定
419  **/
420 
421 #define AILIA_ENVIRONMENT_ID_AUTO (-1)
422 
423 /****************************************************************
424  * 推論時の内部データ(Blob)の型
425  * ailiaGetBlobDataType で取得可能
426  **/
427 
428 #define AILIA_DATATYPE_UNDEFINED 0
429 #define AILIA_DATATYPE_FLOAT 1
430 #define AILIA_DATATYPE_UINT8 2
431 #define AILIA_DATATYPE_INT8 3
432 #define AILIA_DATATYPE_UINT16 4
433 #define AILIA_DATATYPE_INT16 5
434 #define AILIA_DATATYPE_INT32 6
435 #define AILIA_DATATYPE_INT64 7
436 #define AILIA_DATATYPE_BOOL 9
437 #define AILIA_DATATYPE_FLOAT16 10
438 #define AILIA_DATATYPE_DOUBLE 11
439 #define AILIA_DATATYPE_UINT32 12
440 #define AILIA_DATATYPE_UINT64 13
441 #define AILIA_DATATYPE_BFLOAT16 16
442 
443 /****************************************************************
444  * 推論API
445  **/
446 
475 int AILIA_API ailiaCreate(struct AILIANetwork** net, int env_id, int num_thread);
476 
496 int AILIA_API ailiaOpenStreamFileA(struct AILIANetwork* net, const char* path);
497 int AILIA_API ailiaOpenStreamFileW(struct AILIANetwork* net, const wchar_t* path);
498 
522 int AILIA_API ailiaOpenStreamEx(struct AILIANetwork* net, const void* fopen_args, ailiaFileCallback callback, int version);
523 
545 int AILIA_API ailiaOpenStreamMem(struct AILIANetwork* net, const void* buf, unsigned int buf_size);
546 
566 int AILIA_API ailiaOpenWeightFileA(struct AILIANetwork* net, const char* path);
567 int AILIA_API ailiaOpenWeightFileW(struct AILIANetwork* net, const wchar_t* path);
568 
592 int AILIA_API ailiaOpenWeightEx(struct AILIANetwork* net, const void* fopen_args, ailiaFileCallback callback, int version);
593 
615 int AILIA_API ailiaOpenWeightMem(struct AILIANetwork* net, const void* buf, unsigned int buf_size);
616 
626 void AILIA_API ailiaDestroy(struct AILIANetwork* net);
627 
659 int AILIA_API ailiaSetInputShape(struct AILIANetwork* net, const AILIAShape* shape, unsigned int version);
660 
688 int AILIA_API ailiaSetInputShapeND(struct AILIANetwork* net, const unsigned int* shape, unsigned int dim);
689 
718 int AILIA_API ailiaGetInputShape(struct AILIANetwork* net, AILIAShape* shape, unsigned int version);
719 
739 int AILIA_API ailiaGetInputDim(struct AILIANetwork* net, unsigned int* dim);
740 
766 int AILIA_API ailiaGetInputShapeND(struct AILIANetwork* net, unsigned int* shape, unsigned int dim);
767 
792 int AILIA_API ailiaGetOutputShape(struct AILIANetwork* net, AILIAShape* shape, unsigned int version);
793 
813 int AILIA_API ailiaGetOutputDim(struct AILIANetwork* net, unsigned int* dim);
814 
836 int AILIA_API ailiaGetOutputShapeND(struct AILIANetwork* net, unsigned int* shape, unsigned int dim);
837 
865 int AILIA_API
866 ailiaPredict(struct AILIANetwork* net, void* dest, unsigned int dest_size, const void* src, unsigned int src_size);
867 
868 /****************************************************************
869  * 状態取得API
870  **/
871 
896 int AILIA_API ailiaGetBlobCount(struct AILIANetwork* net, unsigned int* blob_count);
897 
925 int AILIA_API ailiaGetBlobShape(struct AILIANetwork* net, AILIAShape* shape, unsigned int blob_idx, unsigned int version);
926 
948 int AILIA_API ailiaGetBlobDim(struct AILIANetwork* net, unsigned int* dim, unsigned int blob_idx);
949 
973 int AILIA_API ailiaGetBlobShapeND(struct AILIANetwork* net, unsigned int* shape, unsigned int dim, unsigned int blob_idx);
974 
999 int AILIA_API ailiaGetBlobData(struct AILIANetwork* net, void* dest, unsigned int dest_size, unsigned int blob_idx);
1000 
1022 int AILIA_API ailiaGetBlobDataType(struct AILIANetwork* net, int* type, unsigned int blob_idx);
1023 
1048 int AILIA_API ailiaFindBlobIndexByName(struct AILIANetwork* net, unsigned int* blob_idx, const char* name);
1049 
1074 int AILIA_API ailiaGetBlobNameLengthByIndex(struct AILIANetwork* net, const unsigned int blob_idx, unsigned int* buffer_size);
1075 
1102 int AILIA_API ailiaFindBlobNameByIndex(struct AILIANetwork* net, char* buffer, const unsigned int buffer_size, const unsigned int blob_idx);
1103 
1123 int AILIA_API ailiaGetSummaryLength(struct AILIANetwork* net, unsigned int* buffer_size);
1124 
1148 int AILIA_API ailiaSummary(struct AILIANetwork* net, char* const buffer, const unsigned int buffer_size);
1149 
1150 /****************************************************************
1151  * 複数入力指定・推論API
1152  **/
1153 
1178 int AILIA_API ailiaGetInputBlobCount(struct AILIANetwork* net, unsigned int* input_blob_count);
1179 
1203 int AILIA_API ailiaGetBlobIndexByInputIndex(struct AILIANetwork* net, unsigned int* blob_idx, unsigned int input_blob_idx);
1204 
1233 int AILIA_API ailiaSetInputBlobData(struct AILIANetwork* net, const void* src, unsigned int src_size, unsigned int blob_idx);
1234 
1266 int AILIA_API ailiaSetInputBlobShape(struct AILIANetwork* net, const AILIAShape* shape, unsigned int blob_idx, unsigned int version);
1267 
1297 int AILIA_API ailiaSetInputBlobShapeND(struct AILIANetwork* net, const unsigned* shape, const unsigned dim, unsigned int blob_idx);
1298 
1330 int AILIA_API ailiaCopyBlobData(struct AILIANetwork* dst_net, unsigned int dst_blob_idx, struct AILIANetwork* src_net, unsigned int src_blob_idx);
1331 
1353 int AILIA_API ailiaUpdate(struct AILIANetwork* net);
1354 
1374 int AILIA_API ailiaGetOutputBlobCount(struct AILIANetwork* net, unsigned int* output_blob_count);
1375 
1397 int AILIA_API ailiaGetBlobIndexByOutputIndex(struct AILIANetwork* net, unsigned int* blob_idx, unsigned int output_blob_idx);
1398 
1399 /****************************************************************
1400  * リソース解放 API
1401  **/
1402 
1423 
1424 /****************************************************************
1425  * 推論実行環境取得・指定API
1426  **/
1427 
1428 #define AILIA_ENVIRONMENT_VERSION (2)
1429 
1430 #define AILIA_ENVIRONMENT_TYPE_CPU (0)
1431 #define AILIA_ENVIRONMENT_TYPE_BLAS (1)
1432 #define AILIA_ENVIRONMENT_TYPE_GPU (2)
1433 
1434 #define AILIA_ENVIRONMENT_BACKEND_NONE (0)
1435 #define AILIA_ENVIRONMENT_BACKEND_CUDA (2)
1436 #define AILIA_ENVIRONMENT_BACKEND_MPS (3)
1437 #define AILIA_ENVIRONMENT_BACKEND_VULKAN (6)
1438 
1439 #define AILIA_ENVIRONMENT_PROPERTY_NORMAL (0)
1447 #define AILIA_ENVIRONMENT_PROPERTY_LOWPOWER (1)
1455 #define AILIA_ENVIRONMENT_PROPERTY_FP16 (2)
1456 
1457 typedef struct _AILIAEnvironment {
1465  int id;
1473  int type;
1481  const char* name;
1489  int backend;
1497  int props;
1499 
1525 int AILIA_API ailiaSetTemporaryCachePathA(const char* cache_dir);
1526 int AILIA_API ailiaSetTemporaryCachePathW(const wchar_t* cache_dir);
1527 
1541 int AILIA_API ailiaGetEnvironmentCount(unsigned int* env_count);
1542 
1560 int AILIA_API ailiaGetEnvironment(AILIAEnvironment** env, unsigned int env_idx, unsigned int version);
1561 
1579 int AILIA_API ailiaGetSelectedEnvironment(struct AILIANetwork* net, AILIAEnvironment** env, unsigned int version);
1580 
1581 /****************************************************************
1582  * メモリモードAPI
1583  **/
1584 
1592 #define AILIA_MEMORY_NO_OPTIMIZATION (0)
1600 #define AILIA_MEMORY_REDUCE_CONSTANT (1)
1608 #define AILIA_MEMORY_REDUCE_CONSTANT_WITH_INPUT_INITIALIZER (2)
1616 #define AILIA_MEMORY_REDUCE_INTERSTAGE (4)
1626 #define AILIA_MEMORY_REUSE_INTERSTAGE (8)
1648 #define AILIA_MEMORY_REDUCE_CONSTANT_WITH_FILE_MAPPED (16)
1649 
1650 #define AILIA_MEMORY_OPTIMAIZE_DEFAULT (AILIA_MEMORY_REDUCE_CONSTANT)
1651 
1681 int AILIA_API ailiaSetMemoryMode(struct AILIANetwork* net, unsigned int mode);
1682 
1683 /****************************************************************
1684  * 最適化制御API
1685  **/
1686 
1708 int AILIA_API ailiaDisableLayerFusion(struct AILIANetwork* net);
1709 
1710 /****************************************************************
1711  * プロファイルモードAPI
1712  **/
1713 
1721 #define AILIA_PROFILE_DISABLE (0x00)
1730 #define AILIA_PROFILE_AVERAGE (0x01)
1731 
1755 int AILIA_API ailiaSetProfileMode(struct AILIANetwork* net, unsigned int mode);
1756 
1757 /****************************************************************
1758  * 情報取得API
1759  **/
1760 
1782 const char* AILIA_API ailiaGetStatusString(int status_code);
1783 
1805 const char* AILIA_API ailiaGetErrorDetail(struct AILIANetwork* net);
1806 
1822 const char* AILIA_API ailiaGetVersion(void);
1823 
1824 #ifdef UNICODE
1825 #define ailiaOpenStreamFile ailiaOpenStreamFileW
1826 #define ailiaOpenWeightFile ailiaOpenWeightFileW
1827 #define ailiaSetTemporaryCachePath ailiaSetTemporaryCachePathW
1828 #else
1829 #define ailiaOpenStreamFile ailiaOpenStreamFileA
1830 #define ailiaOpenWeightFile ailiaOpenWeightFileA
1831 #define ailiaSetTemporaryCachePath ailiaSetTemporaryCachePathA
1832 #endif
1833 
1834 #ifdef __cplusplus
1835 }
1836 #endif
1837 #endif /* !defined(INCLUDED_AILIA) */
int AILIA_API ailiaOpenWeightMem(struct AILIANetwork *net, const void *buf, unsigned int buf_size)
Reads weights into a network instance. (Read from memory)
#define AILIA_API
Definition: ailia.h:25
int AILIA_API ailiaOpenWeightFileW(struct AILIANetwork *net, const wchar_t *path)
int AILIA_API ailiaOpenWeightFileA(struct AILIANetwork *net, const char *path)
Reads weights into a network instance. (Read from file)
int AILIA_API ailiaOpenWeightEx(struct AILIANetwork *net, const void *fopen_args, ailiaFileCallback callback, int version)
Reads weights into a network instance. (User-defined file access callback)
int AILIA_API ailiaGetSummaryLength(struct AILIANetwork *net, unsigned int *buffer_size)
Gets the size of the buffer needed for the network summary.
int AILIA_API ailiaDisableLayerFusion(struct AILIANetwork *net)
Disalbe layer fusion optimaization for inference.
int AILIA_API ailiaGetBlobNameLengthByIndex(struct AILIANetwork *net, const unsigned int blob_idx, unsigned int *buffer_size)
Gets the size of the buffer needed for output of the name of the internal data (blob).
const char *AILIA_API ailiaGetErrorDetail(struct AILIANetwork *net)
Returns the details of errors.
int AILIA_API ailiaGetBlobData(struct AILIANetwork *net, void *dest, unsigned int dest_size, unsigned int blob_idx)
Gets the internal data (blob) during inference.
int AILIA_API ailiaSetInputBlobShape(struct AILIANetwork *net, const AILIAShape *shape, unsigned int blob_idx, unsigned int version)
Change the shape of the blob given by its index.
int AILIA_API ailiaSetTemporaryCachePathA(const char *cache_dir)
Specifies a temporary cache directory.
int AILIA_API ailiaOpenStreamFileA(struct AILIANetwork *net, const char *path)
Initializes the network instance. (Read from file)
int AILIA_API ailiaGetBlobDim(struct AILIANetwork *net, unsigned int *dim, unsigned int blob_idx)
Gets the dimension of the internal data (blob) during inference.
int AILIA_API ailiaGetBlobShape(struct AILIANetwork *net, AILIAShape *shape, unsigned int blob_idx, unsigned int version)
Gets the shape of the internal data (blob) during inference.
int AILIA_API ailiaGetBlobDataType(struct AILIANetwork *net, int *type, unsigned int blob_idx)
Get the type of Blob.
struct _AILIAEnvironment AILIAEnvironment
const char *AILIA_API ailiaGetVersion(void)
Get the version of the library.
int AILIA_API ailiaGetEnvironmentCount(unsigned int *env_count)
Gets the number of available computational environments (CPU, GPU).
int AILIA_API ailiaGetOutputBlobCount(struct AILIANetwork *net, unsigned int *output_blob_count)
Get the number of output data blobs.
void AILIA_API ailiaDestroy(struct AILIANetwork *net)
It destroys the network instance.
int AILIA_API ailiaSetInputShape(struct AILIANetwork *net, const AILIAShape *shape, unsigned int version)
Changes the shape of the input data during inference.
int AILIA_API ailiaCopyBlobData(struct AILIANetwork *dst_net, unsigned int dst_blob_idx, struct AILIANetwork *src_net, unsigned int src_blob_idx)
Perform copies between blobs that specified.
int AILIA_API ailiaOpenStreamFileW(struct AILIANetwork *net, const wchar_t *path)
int AILIA_API ailiaSetInputBlobShapeND(struct AILIANetwork *net, const unsigned *shape, const unsigned dim, unsigned int blob_idx)
Change the shape of the blob given by its index.
int AILIA_API ailiaFinalize(void)
Release GPU and other resources that have been globally allocated with ailia.
int AILIA_API ailiaSetTemporaryCachePathW(const wchar_t *cache_dir)
const char *AILIA_API ailiaGetStatusString(int status_code)
Returns the string describing given status code.
int AILIA_API ailiaGetOutputShape(struct AILIANetwork *net, AILIAShape *shape, unsigned int version)
Gets the shape of the output data during inference.
int AILIA_API ailiaGetBlobShapeND(struct AILIANetwork *net, unsigned int *shape, unsigned int dim, unsigned int blob_idx)
Gets the amount of internal data (blob) during inference.
int AILIA_API ailiaSetMemoryMode(struct AILIANetwork *net, unsigned int mode)
Set the memory usage policy for inference.
int AILIA_API ailiaGetEnvironment(AILIAEnvironment **env, unsigned int env_idx, unsigned int version)
Gets the list of computational environments.
int AILIA_API ailiaGetInputBlobCount(struct AILIANetwork *net, unsigned int *input_blob_count)
Get the number of input data blobs.
int AILIA_API ailiaFindBlobIndexByName(struct AILIANetwork *net, unsigned int *blob_idx, const char *name)
Searches by name for the index of the internal data (blob) during inference and returns it.
int AILIA_API ailiaPredict(struct AILIANetwork *net, void *dest, unsigned int dest_size, const void *src, unsigned int src_size)
Performs the inferences and provides the inference result.
int AILIA_API ailiaGetOutputDim(struct AILIANetwork *net, unsigned int *dim)
Gets the dimension of the output data during inference.
struct _AILIAShape AILIAShape
int AILIA_API ailiaSetInputBlobData(struct AILIANetwork *net, const void *src, unsigned int src_size, unsigned int blob_idx)
Provides the specified blob with the input data.
int AILIA_API ailiaGetInputShape(struct AILIANetwork *net, AILIAShape *shape, unsigned int version)
Gets the shape of the input data during inference.
int AILIA_API ailiaOpenStreamEx(struct AILIANetwork *net, const void *fopen_args, ailiaFileCallback callback, int version)
Initializes the network instance. (User-defined file access callback)
int AILIA_API ailiaUpdate(struct AILIANetwork *net)
Makes inferences with the input data specified in advance.
int AILIA_API ailiaCreate(struct AILIANetwork **net, int env_id, int num_thread)
Creates a network instance.
int AILIA_API ailiaGetInputDim(struct AILIANetwork *net, unsigned int *dim)
Gets the dimension of the input data during inference.
int AILIA_API ailiaGetOutputShapeND(struct AILIANetwork *net, unsigned int *shape, unsigned int dim)
Gets the shape of the output data during inference.
int AILIA_API ailiaFindBlobNameByIndex(struct AILIANetwork *net, char *buffer, const unsigned int buffer_size, const unsigned int blob_idx)
Searches by index for the name of the internal data (blob) during inference and returns it.
int AILIA_API ailiaSummary(struct AILIANetwork *net, char *const buffer, const unsigned int buffer_size)
Shows the name and shape of each blob.
int AILIA_API ailiaOpenStreamMem(struct AILIANetwork *net, const void *buf, unsigned int buf_size)
Initializes the network instance. (Read from memory)
int AILIA_API ailiaSetProfileMode(struct AILIANetwork *net, unsigned int mode)
Set the profile mode.
int AILIA_API ailiaGetBlobIndexByInputIndex(struct AILIANetwork *net, unsigned int *blob_idx, unsigned int input_blob_idx)
Get the blob index of the input data.
int AILIA_API ailiaGetBlobCount(struct AILIANetwork *net, unsigned int *blob_count)
Gets the amount of internal data (blob) during inference.
int AILIA_API ailiaGetInputShapeND(struct AILIANetwork *net, unsigned int *shape, unsigned int dim)
Gets the shape of the input data during inference.
int AILIA_API ailiaGetBlobIndexByOutputIndex(struct AILIANetwork *net, unsigned int *blob_idx, unsigned int output_blob_idx)
Get the blob index of the input data blob.
int AILIA_API ailiaGetSelectedEnvironment(struct AILIANetwork *net, AILIAEnvironment **env, unsigned int version)
Gets the selected computational environment.
int AILIA_API ailiaSetInputShapeND(struct AILIANetwork *net, const unsigned int *shape, unsigned int dim)
Changes the shape of the input data during inference.
user-defined callback
Definition: ailia.h:1457
const char * name
Definition: ailia.h:1481
int backend
Definition: ailia.h:1489
int type
Definition: ailia.h:1473
int id
Definition: ailia.h:1465
int props
Definition: ailia.h:1497
Definition: ailia.h:368
unsigned int w
Definition: ailia.h:400
unsigned int z
Definition: ailia.h:392
unsigned int y
Definition: ailia.h:384
unsigned int x
Definition: ailia.h:376
unsigned int dim
Definition: ailia.h:408
Definition: ailia_call.h:202