mxnet
c_api.h
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one
3  * or more contributor license agreements. See the NOTICE file
4  * distributed with this work for additional information
5  * regarding copyright ownership. The ASF licenses this file
6  * to you under the Apache License, Version 2.0 (the
7  * "License"); you may not use this file except in compliance
8  * with the License. You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing,
13  * software distributed under the License is distributed on an
14  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15  * KIND, either express or implied. See the License for the
16  * specific language governing permissions and limitations
17  * under the License.
18  */
19 
25 #ifndef MXNET_C_API_H_
26 #define MXNET_C_API_H_
27 
29 #ifdef __cplusplus
30 extern "C" {
31 #endif // __cplusplus
32 
34 #ifdef __cplusplus
35 #define DEFAULT(x) = x
36 #else
37 #define DEFAULT(x)
38 #endif // __cplusplus
39 
40 #include <stdint.h>
41 
42 #include <stdint.h>
43 #include <stddef.h>
44 #include <stdbool.h>
45 
47 #ifdef _WIN32
48 #ifdef MXNET_EXPORTS
49 #define MXNET_DLL __declspec(dllexport)
50 #else
51 #define MXNET_DLL __declspec(dllimport)
52 #endif
53 #else
54 #define MXNET_DLL
55 #endif
56 
58 typedef unsigned int mx_uint;
60 typedef float mx_float;
62 typedef int64_t dim_t;
63 // all the handles are simply void *
64 // will be casted internally to specific pointers types
65 // these typedefs are mainly used for readablity reasons
67 typedef void *NDArrayHandle;
69 typedef const void *FunctionHandle;
71 typedef void *AtomicSymbolCreator;
73 typedef void *CachedOpHandle;
75 typedef void *SymbolHandle;
77 typedef void *AtomicSymbolHandle;
79 typedef void *ExecutorHandle;
81 typedef void *DataIterCreator;
83 typedef void *DataIterHandle;
85 typedef void *KVStoreHandle;
87 typedef void *RecordIOHandle;
89 typedef void *RtcHandle;
91 typedef void *CudaModuleHandle;
93 typedef void *CudaKernelHandle;
95 typedef void *ProfileHandle;
97 typedef void *DLManagedTensorHandle;
98 
99 typedef void (*ExecutorMonitorCallback)(const char*,
101  void *);
102 
103 struct NativeOpInfo {
104  void (*forward)(int, float**, int*, unsigned**, int*, void*);
105  void (*backward)(int, float**, int*, unsigned**, int*, void*);
106  void (*infer_shape)(int, int*, unsigned**, void*);
107  void (*list_outputs)(char***, void*);
108  void (*list_arguments)(char***, void*);
109  // all functions also pass a payload void* pointer
110  void* p_forward;
111  void* p_backward;
115 };
116 
118  bool (*forward)(int, void**, int*, void*);
119  bool (*backward)(int, void**, int*, void*);
120  bool (*infer_shape)(int, int*, unsigned**, void*);
121  bool (*list_outputs)(char***, void*);
122  bool (*list_arguments)(char***, void*);
123  bool (*declare_backward_dependency)(const int*, const int*, const int*,
124  int*, int**, void*);
125  // all functions also pass a payload void* pointer
126  void* p_forward;
127  void* p_backward;
132 };
133 
134 typedef int (*MXGenericCallback)(void);
135 
138  int (**callbacks)(void);
139  void **contexts;
140 };
141 
146 };
147 
159 };
160 
161 
162 typedef int (*CustomOpFBFunc)(int /*size*/, void** /*ptrs*/, int* /*tags*/,
163  const int* /*reqs*/, const int /*is_train*/,
164  void* /*state*/);
165 typedef int (*CustomOpDelFunc)(void* /*state*/);
166 typedef int (*CustomOpListFunc)(char*** /*args*/, void* /*state*/);
167 typedef int (*CustomOpInferShapeFunc)(int /*num_input*/, int* /*ndims*/,
168  unsigned** /*shapes*/, void* /*state*/);
169 typedef int (*CustomOpInferStorageTypeFunc)(int /*num_input*/, int* /*stypes*/, void* /*state*/);
170 typedef int (*CustomOpBackwardInferStorageTypeFunc)(int /*num_input*/,
171  int * /*stypes*/,
172  int * /*tags*/,
173  void * /*state*/);
174 typedef int (*CustomOpInferTypeFunc)(int /*num_input*/, int* /*types*/, void* /*state*/);
175 typedef int (*CustomOpBwdDepFunc)(const int* /*out_grad*/, const int* /*in_data*/,
176  const int* /*out_data*/, int* /*num_deps*/,
177  int** /*rdeps*/, void* /*state*/);
178 typedef int (*CustomOpCreateFunc)(const char* /*ctx*/, int /*num_inputs*/,
179  unsigned** /*shapes*/, const int* /*ndims*/,
180  const int* /*dtypes*/, struct MXCallbackList* /*ret*/,
181  void* /*state*/);
182 typedef int (*CustomOpPropCreator)(const char* /*op_type*/, const int /*num_kwargs*/,
183  const char** /*keys*/, const char** /*values*/,
184  struct MXCallbackList* /*ret*/);
185 
186 
190 };
191 
192 typedef int (*CustomFunctionBwdFunc)(int /*num_ograds*/, int /*num_igrads*/, void** /*ptrs*/,
193  const int* /*reqs*/, const int /*is_train*/,
194  void* /*state*/);
195 typedef int (*CustomFunctionDelFunc)(void* /*state*/);
196 
206 MXNET_DLL const char *MXGetLastError();
207 
208 //-------------------------------------
209 // Part 0: Global State setups
210 //-------------------------------------
216 MXNET_DLL int MXRandomSeed(int seed);
217 
223 MXNET_DLL int MXRandomSeedContext(int seed, int dev_type, int dev_id);
224 
233 
242 MXNET_DLL int MXSetProcessProfilerConfig(int num_params, const char* const* keys,
243  const char* const* vals,
244  KVStoreHandle kvstoreHandle);
245 
253 MXNET_DLL int MXSetProfilerConfig(int num_params, const char* const* keys, const char* const* vals);
254 
266 MXNET_DLL int MXSetProcessProfilerState(int state, int profile_process,
267  KVStoreHandle kvStoreHandle);
268 
276 MXNET_DLL int MXSetProfilerState(int state);
277 
287 MXNET_DLL int MXDumpProcessProfile(int finished, int profile_process, KVStoreHandle kvStoreHandle);
288 
289 
295 MXNET_DLL int MXDumpProfile(int finished);
296 
304 MXNET_DLL int MXAggregateProfileStatsPrint(const char **out_str, int reset);
305 
314 MXNET_DLL int MXProcessProfilePause(int paused, int profile_process, KVStoreHandle kvStoreHandle);
315 
322 MXNET_DLL int MXProfilePause(int paused);
323 
330 MXNET_DLL int MXProfileCreateDomain(const char *domain, ProfileHandle *out);
331 
339 MXNET_DLL int MXProfileCreateTask(ProfileHandle domain,
340  const char *task_name,
341  ProfileHandle *out);
342 
350 MXNET_DLL int MXProfileCreateFrame(ProfileHandle domain,
351  const char *frame_name,
352  ProfileHandle *out);
353 
360 MXNET_DLL int MXProfileCreateEvent(const char *event_name, ProfileHandle *out);
361 
369 MXNET_DLL int MXProfileCreateCounter(ProfileHandle domain,
370  const char *counter_name,
371  ProfileHandle *out);
372 
378 MXNET_DLL int MXProfileDestroyHandle(ProfileHandle frame_handle);
379 
385 MXNET_DLL int MXProfileDurationStart(ProfileHandle duration_handle);
386 
392 MXNET_DLL int MXProfileDurationStop(ProfileHandle duration_handle);
393 
400 MXNET_DLL int MXProfileSetCounter(ProfileHandle counter_handle, uint64_t value);
401 
408 MXNET_DLL int MXProfileAdjustCounter(ProfileHandle counter_handle, int64_t value);
409 
417 MXNET_DLL int MXProfileSetMarker(ProfileHandle domain,
418  const char *instant_marker_name,
419  const char *scope);
420 
426 MXNET_DLL int MXSetNumOMPThreads(int thread_num);
427 
433 MXNET_DLL int MXEngineSetBulkSize(int bulk_size, int* prev_bulk_size);
434 
440 MXNET_DLL int MXGetGPUCount(int* out);
441 
449 MXNET_DLL int MXGetGPUMemoryInformation(int dev, int *free_mem, int *total_mem);
450 
456 MXNET_DLL int MXGetVersion(int *out);
457 
458 //-------------------------------------
459 // Part 1: NDArray creation and deletion
460 //-------------------------------------
468 MXNET_DLL int MXNDArrayCreateNone(NDArrayHandle *out);
480 MXNET_DLL int MXNDArrayCreate(const mx_uint *shape,
481  mx_uint ndim,
482  int dev_type,
483  int dev_id,
484  int delay_alloc,
485  NDArrayHandle *out);
486 
499 MXNET_DLL int MXNDArrayCreateEx(const mx_uint *shape,
500  mx_uint ndim,
501  int dev_type,
502  int dev_id,
503  int delay_alloc,
504  int dtype,
505  NDArrayHandle *out);
506 
507 
525 MXNET_DLL int MXNDArrayCreateSparseEx(int storage_type,
526  const mx_uint *shape,
527  mx_uint ndim,
528  int dev_type,
529  int dev_id,
530  int delay_alloc,
531  int dtype,
532  mx_uint num_aux,
533  int *aux_type,
534  mx_uint *aux_ndims,
535  const mx_uint *aux_shape,
536  NDArrayHandle *out);
537 
545 MXNET_DLL int MXNDArrayLoadFromRawBytes(const void *buf,
546  size_t size,
547  NDArrayHandle *out);
555 MXNET_DLL int MXNDArraySaveRawBytes(NDArrayHandle handle,
556  size_t *out_size,
557  const char **out_buf);
566 MXNET_DLL int MXNDArraySave(const char* fname,
567  mx_uint num_args,
568  NDArrayHandle* args,
569  const char** keys);
579 MXNET_DLL int MXNDArrayLoad(const char* fname,
580  mx_uint *out_size,
581  NDArrayHandle** out_arr,
582  mx_uint *out_name_size,
583  const char*** out_names);
584 
599 MXNET_DLL int MXNDArrayLoadFromBuffer(const void *ndarray_buffer,
600  size_t size,
601  mx_uint *out_size,
602  NDArrayHandle** out_arr,
603  mx_uint *out_name_size,
604  const char*** out_names);
605 
617 MXNET_DLL int MXNDArraySyncCopyFromCPU(NDArrayHandle handle,
618  const void *data,
619  size_t size);
631 MXNET_DLL int MXNDArraySyncCopyToCPU(NDArrayHandle handle,
632  void *data,
633  size_t size);
641 MXNET_DLL int MXNDArraySyncCopyFromNDArray(NDArrayHandle handle_dst,
642  const NDArrayHandle handle_src,
643  const int i);
644 
650 MXNET_DLL int MXNDArraySyncCheckFormat(NDArrayHandle handle, const bool full_check);
657 MXNET_DLL int MXNDArrayWaitToRead(NDArrayHandle handle);
664 MXNET_DLL int MXNDArrayWaitToWrite(NDArrayHandle handle);
676 MXNET_DLL int MXNDArrayFree(NDArrayHandle handle);
685 MXNET_DLL int MXNDArraySlice(NDArrayHandle handle,
686  mx_uint slice_begin,
687  mx_uint slice_end,
688  NDArrayHandle *out);
689 
697 MXNET_DLL int MXNDArrayAt(NDArrayHandle handle,
698  mx_uint idx,
699  NDArrayHandle *out);
700 
704 MXNET_DLL int MXNDArrayGetStorageType(NDArrayHandle handle,
705  int *out_storage_type);
706 
715 MXNET_DLL int MXNDArrayReshape(NDArrayHandle handle,
716  int ndim,
717  int *dims,
718  NDArrayHandle *out);
719 
728 MXNET_DLL int MXNDArrayReshape64(NDArrayHandle handle,
729  int ndim,
730  dim_t *dims,
731  bool reverse,
732  NDArrayHandle *out);
740 MXNET_DLL int MXNDArrayGetShape(NDArrayHandle handle,
741  mx_uint *out_dim,
742  const mx_uint **out_pdata);
749 MXNET_DLL int MXNDArrayGetData(NDArrayHandle handle,
750  void **out_pdata);
760 MXNET_DLL int MXNDArrayToDLPack(NDArrayHandle handle,
761  DLManagedTensorHandle *out_dlpack);
762 
776 MXNET_DLL int MXNDArrayFromDLPack(DLManagedTensorHandle dlpack,
777  NDArrayHandle *out_handle);
783 MXNET_DLL int MXNDArrayCallDLPackDeleter(DLManagedTensorHandle dlpack);
784 
791 MXNET_DLL int MXNDArrayGetDType(NDArrayHandle handle,
792  int *out_dtype);
793 
801 MXNET_DLL int MXNDArrayGetAuxType(NDArrayHandle handle,
802  mx_uint i,
803  int *out_type);
804 
810 MXNET_DLL int MXNDArrayGetAuxNDArray(NDArrayHandle handle,
811  mx_uint i,
812  NDArrayHandle *out);
813 
819 MXNET_DLL int MXNDArrayGetDataNDArray(NDArrayHandle handle,
820  NDArrayHandle *out);
828 MXNET_DLL int MXNDArrayGetContext(NDArrayHandle handle,
829  int *out_dev_type,
830  int *out_dev_id);
836 MXNET_DLL int MXNDArrayGetGrad(NDArrayHandle handle, NDArrayHandle *out);
842 MXNET_DLL int MXNDArrayDetach(NDArrayHandle handle, NDArrayHandle *out);
849 MXNET_DLL int MXNDArraySetGradState(NDArrayHandle handle, int state);
856 MXNET_DLL int MXNDArrayGetGradState(NDArrayHandle handle, int *out);
857 //--------------------------------
858 // Part 2: functions on NDArray
859 //--------------------------------
867 MXNET_DLL int MXListFunctions(mx_uint *out_size,
868  FunctionHandle **out_array);
875 MXNET_DLL int MXGetFunction(const char *name,
876  FunctionHandle *out);
889 MXNET_DLL int MXFuncGetInfo(FunctionHandle fun,
890  const char **name,
891  const char **description,
892  mx_uint *num_args,
893  const char ***arg_names,
894  const char ***arg_type_infos,
895  const char ***arg_descriptions,
896  const char **return_type DEFAULT(NULL));
907 MXNET_DLL int MXFuncDescribe(FunctionHandle fun,
908  mx_uint *num_use_vars,
909  mx_uint *num_scalars,
910  mx_uint *num_mutate_vars,
911  int *type_mask);
922 MXNET_DLL int MXFuncInvoke(FunctionHandle fun,
923  NDArrayHandle *use_vars,
924  mx_float *scalar_args,
925  NDArrayHandle *mutate_vars);
939 MXNET_DLL int MXFuncInvokeEx(FunctionHandle fun,
940  NDArrayHandle *use_vars,
941  mx_float *scalar_args,
942  NDArrayHandle *mutate_vars,
943  int num_params,
944  char **param_keys,
945  char **param_vals);
958 MXNET_DLL int MXImperativeInvoke(AtomicSymbolCreator creator,
959  int num_inputs,
960  NDArrayHandle *inputs,
961  int *num_outputs,
962  NDArrayHandle **outputs,
963  int num_params,
964  const char **param_keys,
965  const char **param_vals);
979 MXNET_DLL int MXImperativeInvokeEx(AtomicSymbolCreator creator,
980  int num_inputs,
981  NDArrayHandle *inputs,
982  int *num_outputs,
983  NDArrayHandle **outputs,
984  int num_params,
985  const char **param_keys,
986  const char **param_vals,
987  const int **out_stypes);
994 MXNET_DLL int MXAutogradSetIsRecording(int is_recording, int* prev);
1001 MXNET_DLL int MXAutogradSetIsTraining(int is_training, int* prev);
1007 MXNET_DLL int MXAutogradIsRecording(bool* curr);
1013 MXNET_DLL int MXAutogradIsTraining(bool* curr);
1020 MXNET_DLL int MXAutogradMarkVariables(mx_uint num_var,
1021  NDArrayHandle *var_handles,
1022  mx_uint *reqs_array,
1023  NDArrayHandle *grad_handles);
1030 MXNET_DLL int MXAutogradComputeGradient(mx_uint num_output,
1031  NDArrayHandle* output_handles);
1040 MXNET_DLL int MXAutogradBackward(mx_uint num_output,
1041  NDArrayHandle* output_handles,
1042  NDArrayHandle* ograd_handles,
1043  int retain_graph);
1055 MXNET_DLL int MXAutogradBackwardEx(mx_uint num_output,
1056  NDArrayHandle *output_handles,
1057  NDArrayHandle *ograd_handles,
1058  mx_uint num_variables,
1059  NDArrayHandle *var_handles,
1060  int retain_graph,
1061  int create_graph,
1062  int is_train,
1063  NDArrayHandle **grad_handles,
1064  int **grad_stypes);
1065 /*
1066  * \brief get the graph constructed by autograd.
1067  * \param handle ndarray handle
1068  * \param out output symbol handle
1069  */
1070 MXNET_DLL int MXAutogradGetSymbol(NDArrayHandle handle, SymbolHandle *out);
1074 MXNET_DLL int MXCreateCachedOp(SymbolHandle handle, CachedOpHandle *out);
1078 MXNET_DLL int MXCreateCachedOpEx(SymbolHandle handle,
1079  int num_flags,
1080  const char** keys,
1081  const char** vals,
1082  CachedOpHandle *out);
1086 MXNET_DLL int MXFreeCachedOp(CachedOpHandle handle);
1090 MXNET_DLL int MXInvokeCachedOp(CachedOpHandle handle,
1091  int num_inputs,
1092  NDArrayHandle *inputs,
1093  int *num_outputs,
1094  NDArrayHandle **outputs);
1105 MXNET_DLL int MXInvokeCachedOpEx(CachedOpHandle handle,
1106  int num_inputs,
1107  NDArrayHandle *inputs,
1108  int *num_outputs,
1109  NDArrayHandle **outputs,
1110  const int** out_stypes);
1114 MXNET_DLL int MXInvokeCachedOp(CachedOpHandle handle,
1115  int num_inputs,
1116  NDArrayHandle *inputs,
1117  int *num_outputs,
1118  NDArrayHandle **outputs);
1119 //--------------------------------------------
1120 // Part 3: symbolic configuration generation
1121 //--------------------------------------------
1128 MXNET_DLL int MXListAllOpNames(mx_uint *out_size,
1129  const char ***out_array);
1136 MXNET_DLL int MXSymbolListAtomicSymbolCreators(mx_uint *out_size,
1137  AtomicSymbolCreator **out_array);
1138 
1144 MXNET_DLL int MXSymbolGetAtomicSymbolName(AtomicSymbolCreator creator,
1145  const char **name);
1146 
1153 MXNET_DLL int MXSymbolGetInputSymbols(SymbolHandle sym, SymbolHandle **inputs,
1154  int *input_size);
1155 
1165 MXNET_DLL int MXSymbolCutSubgraph(SymbolHandle sym, SymbolHandle **inputs,
1166  int *input_size);
1167 
1185 MXNET_DLL int MXSymbolGetAtomicSymbolInfo(AtomicSymbolCreator creator,
1186  const char **name,
1187  const char **description,
1188  mx_uint *num_args,
1189  const char ***arg_names,
1190  const char ***arg_type_infos,
1191  const char ***arg_descriptions,
1192  const char **key_var_num_args,
1193  const char **return_type DEFAULT(NULL));
1203 MXNET_DLL int MXSymbolCreateAtomicSymbol(AtomicSymbolCreator creator,
1204  mx_uint num_param,
1205  const char **keys,
1206  const char **vals,
1207  SymbolHandle *out);
1214 MXNET_DLL int MXSymbolCreateVariable(const char *name, SymbolHandle *out);
1222 MXNET_DLL int MXSymbolCreateGroup(mx_uint num_symbols,
1223  SymbolHandle *symbols,
1224  SymbolHandle *out);
1231 MXNET_DLL int MXSymbolCreateFromFile(const char *fname, SymbolHandle *out);
1238 MXNET_DLL int MXSymbolCreateFromJSON(const char *json, SymbolHandle *out);
1245 MXNET_DLL int MXSymbolSaveToFile(SymbolHandle symbol, const char *fname);
1252 MXNET_DLL int MXSymbolSaveToJSON(SymbolHandle symbol, const char **out_json);
1258 MXNET_DLL int MXSymbolFree(SymbolHandle symbol);
1265 MXNET_DLL int MXSymbolCopy(SymbolHandle symbol, SymbolHandle *out);
1272 MXNET_DLL int MXSymbolPrint(SymbolHandle symbol, const char **out_str);
1280 MXNET_DLL int MXSymbolGetName(SymbolHandle symbol,
1281  const char** out,
1282  int *success);
1291 MXNET_DLL int MXSymbolGetAttr(SymbolHandle symbol,
1292  const char* key,
1293  const char** out,
1294  int *success);
1311 MXNET_DLL int MXSymbolSetAttr(SymbolHandle symbol,
1312  const char* key,
1313  const char* value);
1321 MXNET_DLL int MXSymbolListAttr(SymbolHandle symbol,
1322  mx_uint *out_size,
1323  const char*** out);
1331 MXNET_DLL int MXSymbolListAttrShallow(SymbolHandle symbol,
1332  mx_uint *out_size,
1333  const char*** out);
1341 MXNET_DLL int MXSymbolListArguments(SymbolHandle symbol,
1342  mx_uint *out_size,
1343  const char ***out_str_array);
1351 MXNET_DLL int MXSymbolListOutputs(SymbolHandle symbol,
1352  mx_uint *out_size,
1353  const char ***out_str_array);
1354 
1361 MXNET_DLL int MXSymbolGetNumOutputs(SymbolHandle symbol,
1362  mx_uint *output_count);
1363 
1370 MXNET_DLL int MXSymbolGetInternals(SymbolHandle symbol,
1371  SymbolHandle *out);
1378 MXNET_DLL int MXSymbolGetChildren(SymbolHandle symbol,
1379  SymbolHandle *out);
1387 MXNET_DLL int MXSymbolGetOutput(SymbolHandle symbol,
1388  mx_uint index,
1389  SymbolHandle *out);
1390 
1398 MXNET_DLL int MXSymbolListAuxiliaryStates(SymbolHandle symbol,
1399  mx_uint *out_size,
1400  const char ***out_str_array);
1415 MXNET_DLL int MXSymbolCompose(SymbolHandle sym,
1416  const char *name,
1417  mx_uint num_args,
1418  const char** keys,
1419  SymbolHandle* args);
1429 MXNET_DLL int MXSymbolGrad(SymbolHandle sym,
1430  mx_uint num_wrt,
1431  const char** wrt,
1432  SymbolHandle* out);
1455 MXNET_DLL int MXSymbolInferShape(SymbolHandle sym,
1456  mx_uint num_args,
1457  const char** keys,
1458  const mx_uint *arg_ind_ptr,
1459  const mx_uint *arg_shape_data,
1460  mx_uint *in_shape_size,
1461  const mx_uint **in_shape_ndim,
1462  const mx_uint ***in_shape_data,
1463  mx_uint *out_shape_size,
1464  const mx_uint **out_shape_ndim,
1465  const mx_uint ***out_shape_data,
1466  mx_uint *aux_shape_size,
1467  const mx_uint **aux_shape_ndim,
1468  const mx_uint ***aux_shape_data,
1469  int *complete);
1494 MXNET_DLL int MXSymbolInferShapePartial(SymbolHandle sym,
1495  mx_uint num_args,
1496  const char** keys,
1497  const mx_uint *arg_ind_ptr,
1498  const mx_uint *arg_shape_data,
1499  mx_uint *in_shape_size,
1500  const mx_uint **in_shape_ndim,
1501  const mx_uint ***in_shape_data,
1502  mx_uint *out_shape_size,
1503  const mx_uint **out_shape_ndim,
1504  const mx_uint ***out_shape_data,
1505  mx_uint *aux_shape_size,
1506  const mx_uint **aux_shape_ndim,
1507  const mx_uint ***aux_shape_data,
1508  int *complete);
1509 
1528 MXNET_DLL int MXSymbolInferType(SymbolHandle sym,
1529  mx_uint num_args,
1530  const char** keys,
1531  const int *arg_type_data,
1532  mx_uint *in_type_size,
1533  const int **in_type_data,
1534  mx_uint *out_type_size,
1535  const int **out_type_data,
1536  mx_uint *aux_type_size,
1537  const int **aux_type_data,
1538  int *complete);
1539 
1551 MXNET_DLL int MXQuantizeSymbol(SymbolHandle sym_handle, SymbolHandle *ret_sym_handle,
1552  const mx_uint num_excluded_symbols,
1553  const char **excluded_symbols,
1554  const mx_uint num_offline, const char **offline_params,
1555  const char *quantized_dtype, const bool calib_quantize);
1556 
1566 MXNET_DLL int MXSetCalibTableToQuantizedSymbol(SymbolHandle qsym_handle,
1567  const mx_uint num_layers,
1568  const char** layer_names,
1569  const float* low_quantiles,
1570  const float* high_quantiles,
1571  SymbolHandle* ret_sym_handle);
1572 
1579 MXNET_DLL int MXGenBackendSubgraph(SymbolHandle sym_handle, const char *backend,
1580  SymbolHandle *ret_sym_handle);
1581 
1582 //--------------------------------------------
1583 // Part 4: Executor interface
1584 //--------------------------------------------
1590 MXNET_DLL int MXExecutorFree(ExecutorHandle handle);
1597 MXNET_DLL int MXExecutorPrint(ExecutorHandle handle, const char **out_str);
1605 MXNET_DLL int MXExecutorForward(ExecutorHandle handle, int is_train);
1615 MXNET_DLL int MXExecutorBackward(ExecutorHandle handle,
1616  mx_uint len,
1617  NDArrayHandle *head_grads);
1628 MXNET_DLL int MXExecutorBackwardEx(ExecutorHandle handle,
1629  mx_uint len,
1630  NDArrayHandle *head_grads,
1631  int is_train);
1640 MXNET_DLL int MXExecutorOutputs(ExecutorHandle handle,
1641  mx_uint *out_size,
1642  NDArrayHandle **out);
1643 
1659 MXNET_DLL int MXExecutorBind(SymbolHandle symbol_handle,
1660  int dev_type,
1661  int dev_id,
1662  mx_uint len,
1663  NDArrayHandle *in_args,
1664  NDArrayHandle *arg_grad_store,
1665  mx_uint *grad_req_type,
1666  mx_uint aux_states_len,
1667  NDArrayHandle *aux_states,
1668  ExecutorHandle *out);
1690 MXNET_DLL int MXExecutorBindX(SymbolHandle symbol_handle,
1691  int dev_type,
1692  int dev_id,
1693  mx_uint num_map_keys,
1694  const char** map_keys,
1695  const int* map_dev_types,
1696  const int* map_dev_ids,
1697  mx_uint len,
1698  NDArrayHandle *in_args,
1699  NDArrayHandle *arg_grad_store,
1700  mx_uint *grad_req_type,
1701  mx_uint aux_states_len,
1702  NDArrayHandle *aux_states,
1703  ExecutorHandle *out);
1726 MXNET_DLL int MXExecutorBindEX(SymbolHandle symbol_handle,
1727  int dev_type,
1728  int dev_id,
1729  mx_uint num_map_keys,
1730  const char** map_keys,
1731  const int* map_dev_types,
1732  const int* map_dev_ids,
1733  mx_uint len,
1734  NDArrayHandle *in_args,
1735  NDArrayHandle *arg_grad_store,
1736  mx_uint *grad_req_type,
1737  mx_uint aux_states_len,
1738  NDArrayHandle *aux_states,
1739  ExecutorHandle shared_exec,
1740  ExecutorHandle *out);
1741 
1742 MXNET_DLL int MXExecutorSimpleBind(SymbolHandle symbol_handle,
1743  int dev_type,
1744  int dev_id,
1745  const mx_uint num_g2c_keys,
1746  const char** g2c_keys,
1747  const int* g2c_dev_types,
1748  const int* g2c_dev_ids,
1749  const mx_uint provided_grad_req_list_len,
1750  const char** provided_grad_req_names,
1751  const char** provided_grad_req_types,
1752  const mx_uint num_provided_arg_shapes,
1753  const char** provided_arg_shape_names,
1754  const mx_uint* provided_arg_shape_data,
1755  const mx_uint* provided_arg_shape_idx,
1756  const mx_uint num_provided_arg_dtypes,
1757  const char** provided_arg_dtype_names,
1758  const int* provided_arg_dtypes,
1759  const mx_uint num_provided_arg_stypes,
1760  const char** provided_arg_stype_names,
1761  const int* provided_arg_stypes,
1762  const mx_uint num_shared_arg_names,
1763  const char** shared_arg_name_list,
1764  int* shared_buffer_len,
1765  const char** shared_buffer_name_list,
1766  NDArrayHandle* shared_buffer_handle_list,
1767  const char*** updated_shared_buffer_name_list,
1768  NDArrayHandle** updated_shared_buffer_handle_list,
1769  mx_uint* num_in_args,
1770  NDArrayHandle** in_args,
1771  NDArrayHandle** arg_grads,
1772  mx_uint* num_aux_states,
1773  NDArrayHandle** aux_states,
1774  ExecutorHandle shared_exec_handle,
1775  ExecutorHandle* out);
1776 
1798 MXNET_DLL int MXExecutorReshape(int partial_shaping,
1799  int allow_up_sizing,
1800  int dev_type,
1801  int dev_id,
1802  mx_uint num_map_keys,
1803  const char** map_keys,
1804  const int* map_dev_types,
1805  const int* map_dev_ids,
1806  const mx_uint num_provided_arg_shapes,
1807  const char** provided_arg_shape_names,
1808  const mx_uint* provided_arg_shape_data,
1809  const mx_uint* provided_arg_shape_idx,
1810  mx_uint* num_in_args,
1811  NDArrayHandle** in_args,
1812  NDArrayHandle** arg_grads,
1813  mx_uint* num_aux_states,
1814  NDArrayHandle** aux_states,
1815  ExecutorHandle shared_exec,
1816  ExecutorHandle *out);
1817 
1821 MXNET_DLL int MXExecutorGetOptimizedSymbol(ExecutorHandle handle,
1822  SymbolHandle *out);
1823 
1827 MXNET_DLL int MXExecutorSetMonitorCallback(ExecutorHandle handle,
1828  ExecutorMonitorCallback callback,
1829  void* callback_handle);
1830 //--------------------------------------------
1831 // Part 5: IO Interface
1832 //--------------------------------------------
1839 MXNET_DLL int MXListDataIters(mx_uint *out_size,
1840  DataIterCreator **out_array);
1851 MXNET_DLL int MXDataIterCreateIter(DataIterCreator handle,
1852  mx_uint num_param,
1853  const char **keys,
1854  const char **vals,
1855  DataIterHandle *out);
1867 MXNET_DLL int MXDataIterGetIterInfo(DataIterCreator creator,
1868  const char **name,
1869  const char **description,
1870  mx_uint *num_args,
1871  const char ***arg_names,
1872  const char ***arg_type_infos,
1873  const char ***arg_descriptions);
1879 MXNET_DLL int MXDataIterFree(DataIterHandle handle);
1886 MXNET_DLL int MXDataIterNext(DataIterHandle handle,
1887  int *out);
1893 MXNET_DLL int MXDataIterBeforeFirst(DataIterHandle handle);
1894 
1901 MXNET_DLL int MXDataIterGetData(DataIterHandle handle,
1902  NDArrayHandle *out);
1910 MXNET_DLL int MXDataIterGetIndex(DataIterHandle handle,
1911  uint64_t **out_index,
1912  uint64_t *out_size);
1919 MXNET_DLL int MXDataIterGetPadNum(DataIterHandle handle,
1920  int *pad);
1921 
1928 MXNET_DLL int MXDataIterGetLabel(DataIterHandle handle,
1929  NDArrayHandle *out);
1930 //--------------------------------------------
1931 // Part 6: basic KVStore interface
1932 //--------------------------------------------
1939 MXNET_DLL int MXInitPSEnv(mx_uint num_vars,
1940  const char **keys,
1941  const char **vals);
1942 
1943 
1950 MXNET_DLL int MXKVStoreCreate(const char *type,
1951  KVStoreHandle *out);
1952 
1960 MXNET_DLL int MXKVStoreSetGradientCompression(KVStoreHandle handle,
1961  mx_uint num_params,
1962  const char** keys,
1963  const char** vals);
1964 
1970 MXNET_DLL int MXKVStoreFree(KVStoreHandle handle);
1979 MXNET_DLL int MXKVStoreInit(KVStoreHandle handle,
1980  mx_uint num,
1981  const int* keys,
1982  NDArrayHandle* vals);
1983 
1992 MXNET_DLL int MXKVStoreInitEx(KVStoreHandle handle,
1993  mx_uint num,
1994  const char** keys,
1995  NDArrayHandle* vals);
1996 
2006 MXNET_DLL int MXKVStorePush(KVStoreHandle handle,
2007  mx_uint num,
2008  const int* keys,
2009  NDArrayHandle* vals,
2010  int priority);
2020 MXNET_DLL int MXKVStorePushEx(KVStoreHandle handle,
2021  mx_uint num,
2022  const char** keys,
2023  NDArrayHandle* vals,
2024  int priority);
2035 MXNET_DLL int MXKVStorePullWithSparse(KVStoreHandle handle,
2036  mx_uint num,
2037  const int* keys,
2038  NDArrayHandle* vals,
2039  int priority,
2040  bool ignore_sparse);
2051 MXNET_DLL int MXKVStorePullWithSparseEx(KVStoreHandle handle,
2052  mx_uint num,
2053  const char** keys,
2054  NDArrayHandle* vals,
2055  int priority,
2056  bool ignore_sparse);
2066 MXNET_DLL int MXKVStorePull(KVStoreHandle handle,
2067  mx_uint num,
2068  const int* keys,
2069  NDArrayHandle* vals,
2070  int priority);
2080 MXNET_DLL int MXKVStorePullEx(KVStoreHandle handle,
2081  mx_uint num,
2082  const char** keys,
2083  NDArrayHandle* vals,
2084  int priority);
2085 
2098 MXNET_DLL int MXKVStorePullRowSparse(KVStoreHandle handle,
2099  mx_uint num,
2100  const int* keys,
2101  NDArrayHandle* vals,
2102  const NDArrayHandle* row_ids,
2103  int priority);
2116 MXNET_DLL int MXKVStorePullRowSparseEx(KVStoreHandle handle,
2117  mx_uint num,
2118  const char** keys,
2119  NDArrayHandle* vals,
2120  const NDArrayHandle* row_ids,
2121  int priority);
2122 
2131 typedef void (MXKVStoreUpdater)(int key,
2132  NDArrayHandle recv,
2133  NDArrayHandle local,
2134  void *handle);
2143 typedef void (MXKVStoreStrUpdater)(const char* key,
2144  NDArrayHandle recv,
2145  NDArrayHandle local,
2146  void *handle);
2154 MXNET_DLL int MXKVStoreSetUpdater(KVStoreHandle handle,
2155  MXKVStoreUpdater updater,
2156  void *updater_handle);
2165 MXNET_DLL int MXKVStoreSetUpdaterEx(KVStoreHandle handle,
2166  MXKVStoreUpdater updater,
2167  MXKVStoreStrUpdater str_updater,
2168  void *updater_handle);
2175 MXNET_DLL int MXKVStoreGetType(KVStoreHandle handle,
2176  const char** type);
2177 //--------------------------------------------
2178 // Part 6: advanced KVStore for multi-machines
2179 //--------------------------------------------
2180 
2188 MXNET_DLL int MXKVStoreGetRank(KVStoreHandle handle,
2189  int *ret);
2190 
2200 MXNET_DLL int MXKVStoreGetGroupSize(KVStoreHandle handle,
2201  int *ret);
2202 
2208 MXNET_DLL int MXKVStoreIsWorkerNode(int *ret);
2209 
2210 
2216 MXNET_DLL int MXKVStoreIsServerNode(int *ret);
2217 
2218 
2224 MXNET_DLL int MXKVStoreIsSchedulerNode(int *ret);
2225 
2232 MXNET_DLL int MXKVStoreBarrier(KVStoreHandle handle);
2233 
2241 MXNET_DLL int MXKVStoreSetBarrierBeforeExit(KVStoreHandle handle,
2242  const int barrier_before_exit);
2243 
2250 typedef void (MXKVStoreServerController)(int head,
2251  const char *body,
2252  void *controller_handle);
2253 
2261 MXNET_DLL int MXKVStoreRunServer(KVStoreHandle handle,
2262  MXKVStoreServerController controller,
2263  void *controller_handle);
2264 
2272 MXNET_DLL int MXKVStoreSendCommmandToServers(KVStoreHandle handle,
2273  int cmd_id,
2274  const char* cmd_body);
2275 
2286 MXNET_DLL int MXKVStoreGetNumDeadNode(KVStoreHandle handle,
2287  const int node_id,
2288  int *number,
2289  const int timeout_sec DEFAULT(60));
2290 
2297 MXNET_DLL int MXRecordIOWriterCreate(const char *uri, RecordIOHandle *out);
2298 
2304 MXNET_DLL int MXRecordIOWriterFree(RecordIOHandle handle);
2305 
2313 MXNET_DLL int MXRecordIOWriterWriteRecord(RecordIOHandle handle,
2314  const char *buf, size_t size);
2315 
2322 MXNET_DLL int MXRecordIOWriterTell(RecordIOHandle handle, size_t *pos);
2323 
2330 MXNET_DLL int MXRecordIOReaderCreate(const char *uri, RecordIOHandle *out);
2331 
2337 MXNET_DLL int MXRecordIOReaderFree(RecordIOHandle handle);
2338 
2346 MXNET_DLL int MXRecordIOReaderReadRecord(RecordIOHandle handle,
2347  char const **buf, size_t *size);
2348 
2355 MXNET_DLL int MXRecordIOReaderSeek(RecordIOHandle handle, size_t pos);
2356 
2363 MXNET_DLL int MXRecordIOReaderTell(RecordIOHandle handle, size_t *pos);
2364 
2368 MXNET_DLL int MXRtcCreate(char* name, mx_uint num_input, mx_uint num_output,
2369  char** input_names, char** output_names,
2370  NDArrayHandle* inputs, NDArrayHandle* outputs,
2371  char* kernel, RtcHandle *out);
2372 
2376 MXNET_DLL int MXRtcPush(RtcHandle handle, mx_uint num_input, mx_uint num_output,
2377  NDArrayHandle* inputs, NDArrayHandle* outputs,
2378  mx_uint gridDimX,
2379  mx_uint gridDimY,
2380  mx_uint gridDimZ,
2381  mx_uint blockDimX,
2382  mx_uint blockDimY,
2383  mx_uint blockDimZ);
2384 
2388 MXNET_DLL int MXRtcFree(RtcHandle handle);
2389 /*
2390  * \brief register custom operators from frontend.
2391  * \param op_type name of custom op
2392  * \param creator
2393  */
2394 MXNET_DLL int MXCustomOpRegister(const char* op_type, CustomOpPropCreator creator);
2395 /*
2396  * \brief record custom function for backward later.
2397  * \param num_inputs number of input NDArrays.
2398  * \param inputs handle to input NDArrays.
2399  * \param num_outputs number of output NDArrays.
2400  * \param outputs handle to output NDArrays.
2401  * \param callbacks callbacks for backward function.
2402  */
2403 MXNET_DLL int MXCustomFunctionRecord(int num_inputs, NDArrayHandle *inputs,
2404  int num_outputs, NDArrayHandle *outputs,
2405  struct MXCallbackList *callbacks);
2406 /*
2407  * \brief create cuda rtc module
2408  * \param source cuda source code
2409  * \param num_options number of compiler flags
2410  * \param options compiler flags
2411  * \param num_exports number of exported function names
2412  * \param exported function names
2413  * \param out handle to created module
2414  */
2415 MXNET_DLL int MXRtcCudaModuleCreate(const char* source, int num_options,
2416  const char** options, int num_exports,
2417  const char** exports, CudaModuleHandle *out);
2418 /*
2419  * \brief delete cuda rtc module
2420  * \param handle handle to cuda module
2421  */
2422 MXNET_DLL int MXRtcCudaModuleFree(CudaModuleHandle handle);
2423 /*
2424  * \brief get kernel from module
2425  * \param handle handle to cuda module
2426  * \param name name of kernel function
2427  * \param num_args number of arguments
2428  * \param is_ndarray whether argument is ndarray
2429  * \param is_const whether argument is constant
2430  * \param arg_types data type of arguments
2431  * \param out created kernel
2432  */
2433 MXNET_DLL int MXRtcCudaKernelCreate(CudaModuleHandle handle, const char* name,
2434  int num_args, int* is_ndarray, int* is_const,
2435  int* arg_types, CudaKernelHandle *out);
2436 /*
2437  * \brief delete kernel
2438  * \param handle handle to previously created kernel
2439  */
2440 MXNET_DLL int MXRtcCudaKernelFree(CudaKernelHandle handle);
2441 /*
2442  * \brief launch cuda kernel
2443  * \param handle handle to kernel
2444  * \param dev_id (GPU) device id
2445  * \param args pointer to arguments
2446  * \param grid_dim_x grid dimension x
2447  * \param grid_dim_y grid dimension y
2448  * \param grid_dim_z grid dimension z
2449  * \param block_dim_x block dimension x
2450  * \param block_dim_y block dimension y
2451  * \param block_dim_z block dimension z
2452  * \param shared_mem size of dynamically allocated shared memory
2453  */
2454 MXNET_DLL int MXRtcCudaKernelCall(CudaKernelHandle handle, int dev_id, void** args,
2455  mx_uint grid_dim_x, mx_uint grid_dim_y,
2456  mx_uint grid_dim_z, mx_uint block_dim_x,
2457  mx_uint block_dim_y, mx_uint block_dim_z,
2458  mx_uint shared_mem);
2465 MXNET_DLL int MXNDArrayGetSharedMemHandle(NDArrayHandle handle, int* shared_pid,
2466  int* shared_id);
2476 MXNET_DLL int MXNDArrayCreateFromSharedMem(int shared_pid, int shared_id, const mx_uint *shape,
2477  mx_uint ndim, int dtype, NDArrayHandle *out);
2478 
2479 
2480 #ifdef __cplusplus
2481 }
2482 #endif // __cplusplus
2483 
2484 #endif // MXNET_C_API_H_
MXNET_DLL int MXKVStoreSendCommmandToServers(KVStoreHandle handle, int cmd_id, const char *cmd_body)
Send a command to all server nodes.
int(* CustomFunctionDelFunc)(void *)
Definition: c_api.h:195
MXNET_DLL int MXNDArrayDetach(NDArrayHandle handle, NDArrayHandle *out)
detach and ndarray from computation graph by clearing entry_
MXNET_DLL int MXListAllOpNames(mx_uint *out_size, const char ***out_array)
list all the available operator names, include entries.
MXNET_DLL int MXNDArrayCreateFromSharedMem(int shared_pid, int shared_id, const mx_uint *shape, mx_uint ndim, int dtype, NDArrayHandle *out)
Reconstruct NDArray from shared memory handle.
MXNET_DLL int MXNDArrayGetAuxType(NDArrayHandle handle, mx_uint i, int *out_type)
get the type of the ith aux data in NDArray
MXNET_DLL int MXNDArrayCallDLPackDeleter(DLManagedTensorHandle dlpack)
Delete a dlpack tensor.
MXNET_DLL int MXGetGPUCount(int *out)
Get the number of GPUs.
MXNET_DLL int MXKVStoreSetUpdater(KVStoreHandle handle, MXKVStoreUpdater updater, void *updater_handle)
register a push updater
MXNET_DLL int MXKVStoreBarrier(KVStoreHandle handle)
global barrier among all worker machines
MXNET_DLL int MXSymbolGetNumOutputs(SymbolHandle symbol, mx_uint *output_count)
Get number of outputs of the symbol.
void * DataIterHandle
handle to a DataIterator
Definition: c_api.h:83
MXNET_DLL int MXSymbolListAtomicSymbolCreators(mx_uint *out_size, AtomicSymbolCreator **out_array)
list all the available AtomicSymbolEntry
Definition: c_api.h:143
MXNET_DLL int MXDataIterCreateIter(DataIterCreator handle, mx_uint num_param, const char **keys, const char **vals, DataIterHandle *out)
Init an iterator, init with parameters the array size of passed in arguments.
MXNET_DLL int MXProfileSetCounter(ProfileHandle counter_handle, uint64_t value)
Set a counter, given its handle.
MXNET_DLL int MXDataIterNext(DataIterHandle handle, int *out)
Move iterator to next position.
MXNET_DLL int MXNDArrayReshape(NDArrayHandle handle, int ndim, int *dims, NDArrayHandle *out)
Reshape the NDArray.
void * p_infer_shape
Definition: c_api.h:128
MXNET_DLL int MXAutogradMarkVariables(mx_uint num_var, NDArrayHandle *var_handles, mx_uint *reqs_array, NDArrayHandle *grad_handles)
mark NDArrays as variables to compute gradient for autograd
Definition: c_api.h:153
MXNET_DLL int MXExecutorPrint(ExecutorHandle handle, const char **out_str)
Print the content of execution plan, used for debug.
MXNET_DLL int MXKVStoreRunServer(KVStoreHandle handle, MXKVStoreServerController controller, void *controller_handle)
Run as server (or scheduler)
MXNET_DLL int MXSetProfilerConfig(int num_params, const char *const *keys, const char *const *vals)
Set up configuration of profiler for worker/current process.
void(* list_arguments)(char ***, void *)
Definition: c_api.h:108
MXNET_DLL int MXSymbolSaveToJSON(SymbolHandle symbol, const char **out_json)
Save a symbol into a json string.
MXNET_DLL int MXSymbolInferShape(SymbolHandle sym, mx_uint num_args, const char **keys, const mx_uint *arg_ind_ptr, const mx_uint *arg_shape_data, mx_uint *in_shape_size, const mx_uint **in_shape_ndim, const mx_uint ***in_shape_data, mx_uint *out_shape_size, const mx_uint **out_shape_ndim, const mx_uint ***out_shape_data, mx_uint *aux_shape_size, const mx_uint **aux_shape_ndim, const mx_uint ***aux_shape_data, int *complete)
infer shape of unknown input shapes given the known one. The shapes are packed into a CSR matrix repr...
MXNET_DLL int MXSymbolGetAttr(SymbolHandle symbol, const char *key, const char **out, int *success)
Get string attribute from symbol.
MXNET_DLL int MXRtcCreate(char *name, mx_uint num_input, mx_uint num_output, char **input_names, char **output_names, NDArrayHandle *inputs, NDArrayHandle *outputs, char *kernel, RtcHandle *out)
Create a MXRtc object.
MXNET_DLL int MXSymbolGetAtomicSymbolName(AtomicSymbolCreator creator, const char **name)
Get the name of an atomic symbol.
MXNET_DLL int MXExecutorGetOptimizedSymbol(ExecutorHandle handle, SymbolHandle *out)
get optimized graph from graph executor
MXNET_DLL int MXProfileCreateEvent(const char *event_name, ProfileHandle *out)
Create profile event.
MXNET_DLL int MXKVStorePull(KVStoreHandle handle, mx_uint num, const int *keys, NDArrayHandle *vals, int priority)
pull a list of (key, value) pairs from the kvstore
MXNET_DLL int MXNDArrayWaitToRead(NDArrayHandle handle)
Wait until all the pending writes with respect NDArray are finished. Always call this before read dat...
MXNET_DLL int MXExecutorBind(SymbolHandle symbol_handle, int dev_type, int dev_id, mx_uint len, NDArrayHandle *in_args, NDArrayHandle *arg_grad_store, mx_uint *grad_req_type, mx_uint aux_states_len, NDArrayHandle *aux_states, ExecutorHandle *out)
Generate Executor from symbol.
void * p_forward
Definition: c_api.h:126
MXNET_DLL int MXKVStorePullRowSparse(KVStoreHandle handle, mx_uint num, const int *keys, NDArrayHandle *vals, const NDArrayHandle *row_ids, int priority)
pull a list of (key, value) pairs from the kvstore, where each key is an integer. The NDArray pulled ...
MXNET_DLL int MXDumpProfile(int finished)
Save profile and stop profiler for worker/current process.
MXNET_DLL int MXDataIterFree(DataIterHandle handle)
Free the handle to the IO module.
MXNET_DLL int MXKVStoreSetUpdaterEx(KVStoreHandle handle, MXKVStoreUpdater updater, MXKVStoreStrUpdater str_updater, void *updater_handle)
register a push updater with int keys and one with string keys
MXNET_DLL int MXInvokeCachedOp(CachedOpHandle handle, int num_inputs, NDArrayHandle *inputs, int *num_outputs, NDArrayHandle **outputs)
invoke cached operator
MXNET_DLL int MXFreeCachedOp(CachedOpHandle handle)
free cached operator
void * RecordIOHandle
handle to RecordIO
Definition: c_api.h:87
CustomOpCallbacks
Definition: c_api.h:142
MXNET_DLL int MXSymbolGetChildren(SymbolHandle symbol, SymbolHandle *out)
Get a symbol that contains only direct children.
MXNET_DLL int MXRecordIOReaderFree(RecordIOHandle handle)
Delete a RecordIO reader object.
MXNET_DLL int MXExecutorOutputs(ExecutorHandle handle, mx_uint *out_size, NDArrayHandle **out)
Get executor&#39;s head NDArray.
MXNET_DLL int MXNDArrayGetContext(NDArrayHandle handle, int *out_dev_type, int *out_dev_id)
get the context of the NDArray
MXNET_DLL int MXFuncDescribe(FunctionHandle fun, mx_uint *num_use_vars, mx_uint *num_scalars, mx_uint *num_mutate_vars, int *type_mask)
get the argument requirements of the function
MXNET_DLL int MXProfileCreateTask(ProfileHandle domain, const char *task_name, ProfileHandle *out)
Create profile task.
MXNET_DLL int MXKVStoreIsServerNode(int *ret)
return whether or not this process is a server node.
MXNET_DLL int MXNDArraySlice(NDArrayHandle handle, mx_uint slice_begin, mx_uint slice_end, NDArrayHandle *out)
Slice the NDArray along axis 0.
void * ExecutorHandle
handle to an Executor
Definition: c_api.h:79
CustomFunctionCallbacks
Definition: c_api.h:187
MXNET_DLL int MXSymbolSaveToFile(SymbolHandle symbol, const char *fname)
Save a symbol into a json file.
void * AtomicSymbolHandle
handle to a AtomicSymbol
Definition: c_api.h:77
MXNET_DLL int MXProfilePause(int paused)
Pause profiler tuning collection for worker/current process.
void * p_backward
Definition: c_api.h:111
MXNET_DLL int MXFuncGetInfo(FunctionHandle fun, const char **name, const char **description, mx_uint *num_args, const char ***arg_names, const char ***arg_type_infos, const char ***arg_descriptions, const char **return_type DEFAULT(NULL))
Get the information of the function handle.
MXNET_DLL int MXAutogradSetIsTraining(int is_training, int *prev)
set whether to record operator for autograd
MXNET_DLL int MXNDArrayFree(NDArrayHandle handle)
free the narray handle
MXNET_DLL int MXSymbolCreateFromJSON(const char *json, SymbolHandle *out)
Load a symbol from a json string.
CustomOpPropCallbacks
Definition: c_api.h:148
int(* CustomOpInferTypeFunc)(int, int *, void *)
Definition: c_api.h:174
MXNET_DLL int MXKVStoreIsSchedulerNode(int *ret)
return whether or not this process is a scheduler node.
MXNET_DLL int MXInvokeCachedOpEx(CachedOpHandle handle, int num_inputs, NDArrayHandle *inputs, int *num_outputs, NDArrayHandle **outputs, const int **out_stypes)
invoke a cached op
MXNET_DLL int MXSymbolGetAtomicSymbolInfo(AtomicSymbolCreator creator, const char **name, const char **description, mx_uint *num_args, const char ***arg_names, const char ***arg_type_infos, const char ***arg_descriptions, const char **key_var_num_args, const char **return_type DEFAULT(NULL))
Get the detailed information about atomic symbol.
#define DEFAULT(x)
Inhibit C++ name-mangling for MXNet functions.
Definition: c_api.h:37
MXNET_DLL int MXNDArrayLoadFromBuffer(const void *ndarray_buffer, size_t size, mx_uint *out_size, NDArrayHandle **out_arr, mx_uint *out_name_size, const char ***out_names)
Load list / dictionary of narrays from file content loaded into memory. This will load a list of ndar...
MXNET_DLL int MXSetProfilerState(int state)
Set up state of profiler for current process.
MXNET_DLL int MXImperativeInvoke(AtomicSymbolCreator creator, int num_inputs, NDArrayHandle *inputs, int *num_outputs, NDArrayHandle **outputs, int num_params, const char **param_keys, const char **param_vals)
invoke a nnvm op and imperative function
MXNET_DLL int MXProfileDestroyHandle(ProfileHandle frame_handle)
Destroy a frame.
MXNET_DLL int MXNDArrayReshape64(NDArrayHandle handle, int ndim, dim_t *dims, bool reverse, NDArrayHandle *out)
Reshape the NDArray.
MXNET_DLL int MXSymbolListAttr(SymbolHandle symbol, mx_uint *out_size, const char ***out)
Get all attributes from symbol, including all descendents.
MXNET_DLL int MXRtcCudaKernelFree(CudaKernelHandle handle)
MXNET_DLL int MXExecutorReshape(int partial_shaping, int allow_up_sizing, int dev_type, int dev_id, mx_uint num_map_keys, const char **map_keys, const int *map_dev_types, const int *map_dev_ids, const mx_uint num_provided_arg_shapes, const char **provided_arg_shape_names, const mx_uint *provided_arg_shape_data, const mx_uint *provided_arg_shape_idx, mx_uint *num_in_args, NDArrayHandle **in_args, NDArrayHandle **arg_grads, mx_uint *num_aux_states, NDArrayHandle **aux_states, ExecutorHandle shared_exec, ExecutorHandle *out)
Return a new executor with the same symbol and shared memory, but different input/output shapes...
MXNET_DLL int MXNDArrayAt(NDArrayHandle handle, mx_uint idx, NDArrayHandle *out)
Index the NDArray along axis 0.
MXNET_DLL int MXNDArrayGetAuxNDArray(NDArrayHandle handle, mx_uint i, NDArrayHandle *out)
Get a deep copy of the ith aux data blob in the form of an NDArray of default storage type...
MXNET_DLL int MXProfileCreateCounter(ProfileHandle domain, const char *counter_name, ProfileHandle *out)
Create profile counter.
MXNET_DLL int MXNDArrayLoad(const char *fname, mx_uint *out_size, NDArrayHandle **out_arr, mx_uint *out_name_size, const char ***out_names)
Load list of narray from the file.
MXNET_DLL int MXRtcCudaKernelCreate(CudaModuleHandle handle, const char *name, int num_args, int *is_ndarray, int *is_const, int *arg_types, CudaKernelHandle *out)
MXNET_DLL int MXNDArraySyncCopyFromCPU(NDArrayHandle handle, const void *data, size_t size)
Perform a synchronize copy from a continugous CPU memory region.
MXNET_DLL int MXSymbolCreateFromFile(const char *fname, SymbolHandle *out)
Load a symbol from a json file.
MXNET_DLL int MXQuantizeSymbol(SymbolHandle sym_handle, SymbolHandle *ret_sym_handle, const mx_uint num_excluded_symbols, const char **excluded_symbols, const mx_uint num_offline, const char **offline_params, const char *quantized_dtype, const bool calib_quantize)
Convert a symbol into a quantized symbol where FP32 operators are replaced with INT8.
MXNET_DLL int MXKVStorePushEx(KVStoreHandle handle, mx_uint num, const char **keys, NDArrayHandle *vals, int priority)
Push a list of (key,value) pairs to kvstore, where each key is a string.
void( MXKVStoreStrUpdater)(const char *key, NDArrayHandle recv, NDArrayHandle local, void *handle)
user-defined updater for the kvstore with string keys It&#39;s this updater&#39;s responsibility to delete re...
Definition: c_api.h:2143
Definition: c_api.h:117
MXNET_DLL int MXNDArrayCreateSparseEx(int storage_type, const mx_uint *shape, mx_uint ndim, int dev_type, int dev_id, int delay_alloc, int dtype, mx_uint num_aux, int *aux_type, mx_uint *aux_ndims, const mx_uint *aux_shape, NDArrayHandle *out)
create an empty sparse NDArray with specified shape and data type
MXNET_DLL int MXExecutorSimpleBind(SymbolHandle symbol_handle, int dev_type, int dev_id, const mx_uint num_g2c_keys, const char **g2c_keys, const int *g2c_dev_types, const int *g2c_dev_ids, const mx_uint provided_grad_req_list_len, const char **provided_grad_req_names, const char **provided_grad_req_types, const mx_uint num_provided_arg_shapes, const char **provided_arg_shape_names, const mx_uint *provided_arg_shape_data, const mx_uint *provided_arg_shape_idx, const mx_uint num_provided_arg_dtypes, const char **provided_arg_dtype_names, const int *provided_arg_dtypes, const mx_uint num_provided_arg_stypes, const char **provided_arg_stype_names, const int *provided_arg_stypes, const mx_uint num_shared_arg_names, const char **shared_arg_name_list, int *shared_buffer_len, const char **shared_buffer_name_list, NDArrayHandle *shared_buffer_handle_list, const char ***updated_shared_buffer_name_list, NDArrayHandle **updated_shared_buffer_handle_list, mx_uint *num_in_args, NDArrayHandle **in_args, NDArrayHandle **arg_grads, mx_uint *num_aux_states, NDArrayHandle **aux_states, ExecutorHandle shared_exec_handle, ExecutorHandle *out)
void(* ExecutorMonitorCallback)(const char *, NDArrayHandle, void *)
Definition: c_api.h:99
void * p_forward
Definition: c_api.h:110
MXNET_DLL int MXNDArrayCreateEx(const mx_uint *shape, mx_uint ndim, int dev_type, int dev_id, int delay_alloc, int dtype, NDArrayHandle *out)
create a NDArray with specified shape and data type
MXNET_DLL int MXEngineSetBulkSize(int bulk_size, int *prev_bulk_size)
set bulk execution limit
int(* CustomOpBackwardInferStorageTypeFunc)(int, int *, int *, void *)
Definition: c_api.h:170
void * p_list_arguments
Definition: c_api.h:114
MXNET_DLL int MXKVStoreCreate(const char *type, KVStoreHandle *out)
Create a kvstore.
int(* CustomOpDelFunc)(void *)
Definition: c_api.h:165
void * p_declare_backward_dependency
Definition: c_api.h:131
MXNET_DLL int MXNDArrayCreateNone(NDArrayHandle *out)
create a NDArray handle that is not initialized can be used to pass in as mutate variables to hold th...
MXNET_DLL int MXGenBackendSubgraph(SymbolHandle sym_handle, const char *backend, SymbolHandle *ret_sym_handle)
Run subgraph pass based on the backend provided.
MXNET_DLL int MXKVStoreFree(KVStoreHandle handle)
Delete a KVStore handle.
void * DLManagedTensorHandle
handle to DLManagedTensor
Definition: c_api.h:97
void * p_list_arguments
Definition: c_api.h:130
MXNET_DLL int MXCustomOpRegister(const char *op_type, CustomOpPropCreator creator)
MXNET_DLL int MXExecutorBackwardEx(ExecutorHandle handle, mx_uint len, NDArrayHandle *head_grads, int is_train)
Excecutor run backward.
void * SymbolHandle
handle to a symbol that can be bind as operator
Definition: c_api.h:75
MXNET_DLL int MXProfileCreateDomain(const char *domain, ProfileHandle *out)
Create profiling domain.
void * CudaModuleHandle
handle to rtc cuda module
Definition: c_api.h:91
MXNET_DLL int MXSymbolCopy(SymbolHandle symbol, SymbolHandle *out)
Copy the symbol to another handle.
MXNET_DLL int MXGetVersion(int *out)
get the MXNet library version as an integer
int(** callbacks)(void)
Definition: c_api.h:138
void * CachedOpHandle
handle to cached operator
Definition: c_api.h:73
MXNET_DLL int MXSymbolSetAttr(SymbolHandle symbol, const char *key, const char *value)
Set string attribute from symbol. NOTE: Setting attribute to a symbol can affect the semantics(mutabl...
MXNET_DLL int MXSetNumOMPThreads(int thread_num)
Set the number of OMP threads to use.
MXNET_DLL int MXDumpProcessProfile(int finished, int profile_process, KVStoreHandle kvStoreHandle)
Save profile and stop profiler.
MXNET_DLL int MXDataIterBeforeFirst(DataIterHandle handle)
Call iterator.Reset.
MXNET_DLL int MXSymbolInferShapePartial(SymbolHandle sym, mx_uint num_args, const char **keys, const mx_uint *arg_ind_ptr, const mx_uint *arg_shape_data, mx_uint *in_shape_size, const mx_uint **in_shape_ndim, const mx_uint ***in_shape_data, mx_uint *out_shape_size, const mx_uint **out_shape_ndim, const mx_uint ***out_shape_data, mx_uint *aux_shape_size, const mx_uint **aux_shape_ndim, const mx_uint ***aux_shape_data, int *complete)
partially infer shape of unknown input shapes given the known one.
MXNET_DLL int MXSymbolListOutputs(SymbolHandle symbol, mx_uint *out_size, const char ***out_str_array)
List returns in the symbol.
MXNET_DLL int MXListDataIters(mx_uint *out_size, DataIterCreator **out_array)
List all the available iterator entries.
MXNET_DLL int MXProfileSetMarker(ProfileHandle domain, const char *instant_marker_name, const char *scope)
Mark a single instant in time.
MXNET_DLL int MXNDArrayGetShape(NDArrayHandle handle, mx_uint *out_dim, const mx_uint **out_pdata)
get the shape of the array
MXNET_DLL int MXCreateCachedOpEx(SymbolHandle handle, int num_flags, const char **keys, const char **vals, CachedOpHandle *out)
create cached operator
MXNET_DLL int MXDataIterGetPadNum(DataIterHandle handle, int *pad)
Get the padding number in current data batch.
MXNET_DLL int MXAutogradComputeGradient(mx_uint num_output, NDArrayHandle *output_handles)
compute the gradient of outputs w.r.t variabels
MXNET_DLL int MXNDArrayGetSharedMemHandle(NDArrayHandle handle, int *shared_pid, int *shared_id)
Get shared memory handle from NDArray.
MXNET_DLL int MXFuncInvokeEx(FunctionHandle fun, NDArrayHandle *use_vars, mx_float *scalar_args, NDArrayHandle *mutate_vars, int num_params, char **param_keys, char **param_vals)
invoke a function, the array size of passed in arguments must match the values in the ...
MXNET_DLL int MXRtcCudaModuleCreate(const char *source, int num_options, const char **options, int num_exports, const char **exports, CudaModuleHandle *out)
int num_callbacks
Definition: c_api.h:137
MXNET_DLL int MXRandomSeed(int seed)
Seed all global random number generators in mxnet.
Definition: c_api.h:157
MXNET_DLL int MXSymbolGetOutput(SymbolHandle symbol, mx_uint index, SymbolHandle *out)
Get index-th outputs of the symbol.
MXNET_DLL int MXNDArrayGetDType(NDArrayHandle handle, int *out_dtype)
get the type of the data in NDArray
MXNET_DLL int MXAutogradIsTraining(bool *curr)
get whether training mode is on
MXNET_DLL int MXAutogradBackwardEx(mx_uint num_output, NDArrayHandle *output_handles, NDArrayHandle *ograd_handles, mx_uint num_variables, NDArrayHandle *var_handles, int retain_graph, int create_graph, int is_train, NDArrayHandle **grad_handles, int **grad_stypes)
compute the gradient of outputs w.r.t variabels
void(* forward)(int, float **, int *, unsigned **, int *, void *)
Definition: c_api.h:104
int(* MXGenericCallback)(void)
Definition: c_api.h:134
MXNET_DLL int MXSetCalibTableToQuantizedSymbol(SymbolHandle qsym_handle, const mx_uint num_layers, const char **layer_names, const float *low_quantiles, const float *high_quantiles, SymbolHandle *ret_sym_handle)
Set calibration table to node attributes in the sym.
MXNET_DLL int MXSymbolGetInputSymbols(SymbolHandle sym, SymbolHandle **inputs, int *input_size)
Get the input symbols of the graph.
Definition: c_api.h:188
MXNET_DLL int MXSymbolGetInternals(SymbolHandle symbol, SymbolHandle *out)
Get a symbol that contains all the internals.
MXNET_DLL int MXNDArrayGetDataNDArray(NDArrayHandle handle, NDArrayHandle *out)
Get a deep copy of the data blob in the form of an NDArray of default storage type. This function blocks. Do not use it in performance critical code.
MXNET_DLL int MXInitPSEnv(mx_uint num_vars, const char **keys, const char **vals)
Initialized ps-lite environment variables.
MXNET_DLL int MXRandomSeedContext(int seed, int dev_type, int dev_id)
Seed the global random number generator of the given device.
MXNET_DLL int MXDataIterGetData(DataIterHandle handle, NDArrayHandle *out)
Get the handle to the NDArray of underlying data.
MXNET_DLL int MXRtcFree(RtcHandle handle)
Delete a MXRtc object.
MXNET_DLL int MXNDArrayFromDLPack(DLManagedTensorHandle dlpack, NDArrayHandle *out_handle)
Create a NDArray backed by a dlpack tensor.
MXNET_DLL int MXNDArraySyncCopyToCPU(NDArrayHandle handle, void *data, size_t size)
Perform a synchronize copyto a continugous CPU memory region.
MXNET_DLL int MXAutogradSetIsRecording(int is_recording, int *prev)
set whether to record operator for autograd
void( MXKVStoreServerController)(int head, const char *body, void *controller_handle)
the prototype of a server controller
Definition: c_api.h:2250
Definition: c_api.h:144
void * KVStoreHandle
handle to KVStore
Definition: c_api.h:85
void * NDArrayHandle
handle to NDArray
Definition: c_api.h:67
MXNET_DLL int MXNotifyShutdown()
Notify the engine about a shutdown, This can help engine to print less messages into display...
void * p_list_outputs
Definition: c_api.h:129
MXNET_DLL int MXDataIterGetIndex(DataIterHandle handle, uint64_t **out_index, uint64_t *out_size)
Get the image index by array.
MXNET_DLL int MXDataIterGetLabel(DataIterHandle handle, NDArrayHandle *out)
Get the handle to the NDArray of underlying label.
Definition: c_api.h:150
int(* CustomOpCreateFunc)(const char *, int, unsigned **, const int *, const int *, struct MXCallbackList *, void *)
Definition: c_api.h:178
int(* CustomOpFBFunc)(int, void **, int *, const int *, const int, void *)
Definition: c_api.h:162
MXNET_DLL int MXNDArraySyncCopyFromNDArray(NDArrayHandle handle_dst, const NDArrayHandle handle_src, const int i)
Copy src.data() to dst.data() if i = -1, else dst.aux_data(i) if i >= 0 This function blocks...
MXNET_DLL int MXSymbolCreateGroup(mx_uint num_symbols, SymbolHandle *symbols, SymbolHandle *out)
Create a Symbol by grouping list of symbols together.
MXNET_DLL int MXNDArrayCreate(const mx_uint *shape, mx_uint ndim, int dev_type, int dev_id, int delay_alloc, NDArrayHandle *out)
create a NDArray with specified shape
MXNET_DLL int MXKVStoreSetBarrierBeforeExit(KVStoreHandle handle, const int barrier_before_exit)
whether to do barrier when finalize
MXNET_DLL int MXFuncInvoke(FunctionHandle fun, NDArrayHandle *use_vars, mx_float *scalar_args, NDArrayHandle *mutate_vars)
invoke a function, the array size of passed in arguments must match the values in the ...
MXNET_DLL int MXSymbolListArguments(SymbolHandle symbol, mx_uint *out_size, const char ***out_str_array)
List arguments in the symbol.
MXNET_DLL int MXNDArrayGetStorageType(NDArrayHandle handle, int *out_storage_type)
get the storage type of the array
MXNET_DLL int MXRecordIOWriterCreate(const char *uri, RecordIOHandle *out)
Create a RecordIO writer object.
void * p_infer_shape
Definition: c_api.h:112
MXNET_DLL int MXKVStorePullRowSparseEx(KVStoreHandle handle, mx_uint num, const char **keys, NDArrayHandle *vals, const NDArrayHandle *row_ids, int priority)
pull a list of (key, value) pairs from the kvstore, where each key is a string. The NDArray pulled ba...
MXNET_DLL int MXNDArrayWaitAll()
wait until all delayed operations in the system is completed
MXNET_DLL int MXKVStorePullEx(KVStoreHandle handle, mx_uint num, const char **keys, NDArrayHandle *vals, int priority)
pull a list of (key, value) pairs from the kvstore, where each key is a string
MXNET_DLL int MXRecordIOReaderCreate(const char *uri, RecordIOHandle *out)
Create a RecordIO reader object.
MXNET_DLL int MXProfileDurationStop(ProfileHandle duration_handle)
Stop timing the duration of a profile duration object such as an event, task or frame.
MXNET_DLL int MXKVStoreGetNumDeadNode(KVStoreHandle handle, const int node_id, int *number, const int timeout_sec DEFAULT(60))
Get the number of ps dead node(s) specified by {node_id}.
MXNET_DLL int MXProfileAdjustCounter(ProfileHandle counter_handle, int64_t value)
Adjust a counter by the given amount, given its handle.
unsigned int mx_uint
manually define unsigned int
Definition: c_api.h:58
Definition: c_api.h:145
MXNET_DLL int MXAggregateProfileStatsPrint(const char **out_str, int reset)
Print aggregate stats to the a string.
MXNET_DLL int MXRecordIOWriterTell(RecordIOHandle handle, size_t *pos)
Get the current writer pointer position.
Definition: c_api.h:156
MXNET_DLL int MXRecordIOReaderTell(RecordIOHandle handle, size_t *pos)
Get the current writer pointer position.
MXNET_DLL int MXNDArraySaveRawBytes(NDArrayHandle handle, size_t *out_size, const char **out_buf)
save the NDArray into raw bytes.
MXNET_DLL int MXSymbolGetName(SymbolHandle symbol, const char **out, int *success)
Get string name from symbol.
MXNET_DLL int MXKVStoreSetGradientCompression(KVStoreHandle handle, mx_uint num_params, const char **keys, const char **vals)
Set parameters to use low-bit compressed gradients.
void * p_backward
Definition: c_api.h:127
Definition: c_api.h:149
MXNET_DLL int MXSymbolCutSubgraph(SymbolHandle sym, SymbolHandle **inputs, int *input_size)
Cut a subgraph whose nodes are marked with a subgraph attribute. The input graph will be modified...
MXNET_DLL int MXExecutorBindEX(SymbolHandle symbol_handle, int dev_type, int dev_id, mx_uint num_map_keys, const char **map_keys, const int *map_dev_types, const int *map_dev_ids, mx_uint len, NDArrayHandle *in_args, NDArrayHandle *arg_grad_store, mx_uint *grad_req_type, mx_uint aux_states_len, NDArrayHandle *aux_states, ExecutorHandle shared_exec, ExecutorHandle *out)
Generate Executor from symbol, This is advanced function, allow specify group2ctx map...
MXNET_DLL int MXKVStorePullWithSparse(KVStoreHandle handle, mx_uint num, const int *keys, NDArrayHandle *vals, int priority, bool ignore_sparse)
pull a list of (key, value) pairs from the kvstore
MXNET_DLL int MXAutogradIsRecording(bool *curr)
get whether autograd recording is on
Definition: c_api.h:189
MXNET_DLL int MXRecordIOWriterFree(RecordIOHandle handle)
Delete a RecordIO writer object.
MXNET_DLL int MXExecutorBackward(ExecutorHandle handle, mx_uint len, NDArrayHandle *head_grads)
Excecutor run backward.
MXNET_DLL int MXKVStoreGetRank(KVStoreHandle handle, int *ret)
return The rank of this node in its group, which is in [0, GroupSize).
MXNET_DLL int MXCustomFunctionRecord(int num_inputs, NDArrayHandle *inputs, int num_outputs, NDArrayHandle *outputs, struct MXCallbackList *callbacks)
int64_t dim_t
data type to store dim size
Definition: c_api.h:62
MXNET_DLL int MXKVStoreGetGroupSize(KVStoreHandle handle, int *ret)
return The number of nodes in this group, which is
MXNET_DLL int MXRecordIOWriterWriteRecord(RecordIOHandle handle, const char *buf, size_t size)
Write a record to a RecordIO object.
int(* CustomOpPropCreator)(const char *, const int, const char **, const char **, struct MXCallbackList *)
Definition: c_api.h:182
MXNET_DLL int MXSetProcessProfilerState(int state, int profile_process, KVStoreHandle kvStoreHandle)
Set up state of profiler for either worker or server process.
MXNET_DLL int MXSymbolCreateVariable(const char *name, SymbolHandle *out)
Create a Variable Symbol.
MXNET_DLL int MXProfileDurationStart(ProfileHandle duration_handle)
Start timing the duration of a profile duration object such as an event, task or frame.
MXNET_DLL int MXExecutorSetMonitorCallback(ExecutorHandle handle, ExecutorMonitorCallback callback, void *callback_handle)
set a call back to notify the completion of operation
int(* CustomFunctionBwdFunc)(int, int, void **, const int *, const int, void *)
Definition: c_api.h:192
MXNET_DLL int MXAutogradBackward(mx_uint num_output, NDArrayHandle *output_handles, NDArrayHandle *ograd_handles, int retain_graph)
compute the gradient of outputs w.r.t variabels
void * CudaKernelHandle
handle to rtc cuda kernel
Definition: c_api.h:93
MXNET_DLL int MXKVStoreIsWorkerNode(int *ret)
return whether or not this process is a worker node.
MXNET_DLL int MXSymbolPrint(SymbolHandle symbol, const char **out_str)
Print the content of symbol, used for debug.
MXNET_DLL int MXSymbolCompose(SymbolHandle sym, const char *name, mx_uint num_args, const char **keys, SymbolHandle *args)
Compose the symbol on other symbols.
MXNET_DLL int MXSymbolGrad(SymbolHandle sym, mx_uint num_wrt, const char **wrt, SymbolHandle *out)
Get the gradient graph of the symbol.
float mx_float
manually define float
Definition: c_api.h:60
MXNET_DLL int MXNDArrayToDLPack(NDArrayHandle handle, DLManagedTensorHandle *out_dlpack)
Create a reference view of NDArray that represents as DLManagedTensor Notice: MXNet uses asynchronous...
MXNET_DLL int MXCreateCachedOp(SymbolHandle handle, CachedOpHandle *out)
create cached operator
MXNET_DLL int MXRecordIOReaderSeek(RecordIOHandle handle, size_t pos)
Set the current reader pointer position.
#define MXNET_DLL
MXNET_DLL prefix for windows.
Definition: c_api.h:54
MXNET_DLL int MXSymbolCreateAtomicSymbol(AtomicSymbolCreator creator, mx_uint num_param, const char **keys, const char **vals, SymbolHandle *out)
Create an AtomicSymbol.
MXNET_DLL int MXNDArraySetGradState(NDArrayHandle handle, int state)
set the flag for gradient array state.
MXNET_DLL int MXNDArraySyncCheckFormat(NDArrayHandle handle, const bool full_check)
check whether the NDArray format is valid
MXNET_DLL int MXProcessProfilePause(int paused, int profile_process, KVStoreHandle kvStoreHandle)
Pause profiler tuning collection.
MXNET_DLL const char * MXGetLastError()
return str message of the last error all function in this file will return 0 when success and -1 when...
MXNET_DLL int MXNDArrayGetGradState(NDArrayHandle handle, int *out)
set the flag for gradient array state.
void ** contexts
Definition: c_api.h:139
void * AtomicSymbolCreator
handle to a function that takes param and creates symbol
Definition: c_api.h:71
MXNET_DLL int MXKVStoreInitEx(KVStoreHandle handle, mx_uint num, const char **keys, NDArrayHandle *vals)
Init a list of (key,value) pairs in kvstore, where each key is a string.
MXNET_DLL int MXAutogradGetSymbol(NDArrayHandle handle, SymbolHandle *out)
MXNET_DLL int MXExecutorBindX(SymbolHandle symbol_handle, int dev_type, int dev_id, mx_uint num_map_keys, const char **map_keys, const int *map_dev_types, const int *map_dev_ids, mx_uint len, NDArrayHandle *in_args, NDArrayHandle *arg_grad_store, mx_uint *grad_req_type, mx_uint aux_states_len, NDArrayHandle *aux_states, ExecutorHandle *out)
Generate Executor from symbol, This is advanced function, allow specify group2ctx map...
void(* infer_shape)(int, int *, unsigned **, void *)
Definition: c_api.h:106
void * ProfileHandle
handle to a Profile object (domain, duration, counter, etc.)
Definition: c_api.h:95
MXNET_DLL int MXKVStorePullWithSparseEx(KVStoreHandle handle, mx_uint num, const char **keys, NDArrayHandle *vals, int priority, bool ignore_sparse)
pull a list of (key, value) pairs from the kvstore, where each key is a string
void * p_list_outputs
Definition: c_api.h:113
MXNET_DLL int MXNDArraySave(const char *fname, mx_uint num_args, NDArrayHandle *args, const char **keys)
Save list of narray into the file.
MXNET_DLL int MXNDArrayLoadFromRawBytes(const void *buf, size_t size, NDArrayHandle *out)
create a NDArray handle that is loaded from raw bytes.
MXNET_DLL int MXRtcPush(RtcHandle handle, mx_uint num_input, mx_uint num_output, NDArrayHandle *inputs, NDArrayHandle *outputs, mx_uint gridDimX, mx_uint gridDimY, mx_uint gridDimZ, mx_uint blockDimX, mx_uint blockDimY, mx_uint blockDimZ)
Run cuda kernel.
void( MXKVStoreUpdater)(int key, NDArrayHandle recv, NDArrayHandle local, void *handle)
user-defined updater for the kvstore It&#39;s this updater&#39;s responsibility to delete recv and local ...
Definition: c_api.h:2131
MXNET_DLL int MXSymbolListAuxiliaryStates(SymbolHandle symbol, mx_uint *out_size, const char ***out_str_array)
List auxiliary states in the symbol.
MXNET_DLL int MXGetFunction(const char *name, FunctionHandle *out)
get the function handle by name
MXNET_DLL int MXSymbolListAttrShallow(SymbolHandle symbol, mx_uint *out_size, const char ***out)
Get all attributes from symbol, excluding descendents.
void * DataIterCreator
handle a dataiter creator
Definition: c_api.h:81
MXNET_DLL int MXDataIterGetIterInfo(DataIterCreator creator, const char **name, const char **description, mx_uint *num_args, const char ***arg_names, const char ***arg_type_infos, const char ***arg_descriptions)
Get the detailed information about data iterator.
MXNET_DLL int MXKVStoreGetType(KVStoreHandle handle, const char **type)
get the type of the kvstore
void * RtcHandle
handle to MXRtc
Definition: c_api.h:89
MXNET_DLL int MXNDArrayGetGrad(NDArrayHandle handle, NDArrayHandle *out)
return gradient buffer attached to this NDArray
int(* CustomOpBwdDepFunc)(const int *, const int *, const int *, int *, int **, void *)
Definition: c_api.h:175
MXNET_DLL int MXSymbolInferType(SymbolHandle sym, mx_uint num_args, const char **keys, const int *arg_type_data, mx_uint *in_type_size, const int **in_type_data, mx_uint *out_type_size, const int **out_type_data, mx_uint *aux_type_size, const int **aux_type_data, int *complete)
infer type of unknown input types given the known one. The types are packed into a CSR matrix represe...
Definition: c_api.h:151
MXNET_DLL int MXKVStoreInit(KVStoreHandle handle, mx_uint num, const int *keys, NDArrayHandle *vals)
Init a list of (key,value) pairs in kvstore.
void(* backward)(int, float **, int *, unsigned **, int *, void *)
Definition: c_api.h:105
int(* CustomOpInferStorageTypeFunc)(int, int *, void *)
Definition: c_api.h:169
Definition: c_api.h:136
MXNET_DLL int MXImperativeInvokeEx(AtomicSymbolCreator creator, int num_inputs, NDArrayHandle *inputs, int *num_outputs, NDArrayHandle **outputs, int num_params, const char **param_keys, const char **param_vals, const int **out_stypes)
invoke a nnvm op and imperative function
MXNET_DLL int MXRtcCudaModuleFree(CudaModuleHandle handle)
const void * FunctionHandle
handle to a mxnet narray function that changes NDArray
Definition: c_api.h:69
MXNET_DLL int MXSetProcessProfilerConfig(int num_params, const char *const *keys, const char *const *vals, KVStoreHandle kvstoreHandle)
Set up configuration of profiler for the process passed as profile_process in keys.
Definition: c_api.h:103
MXNET_DLL int MXRecordIOReaderReadRecord(RecordIOHandle handle, char const **buf, size_t *size)
Write a record to a RecordIO object.
MXNET_DLL int MXProfileCreateFrame(ProfileHandle domain, const char *frame_name, ProfileHandle *out)
Create profile frame.
MXNET_DLL int MXKVStorePush(KVStoreHandle handle, mx_uint num, const int *keys, NDArrayHandle *vals, int priority)
Push a list of (key,value) pairs to kvstore.
MXNET_DLL int MXListFunctions(mx_uint *out_size, FunctionHandle **out_array)
list all the available functions handles most user can use it to list all the needed functions ...
void(* list_outputs)(char ***, void *)
Definition: c_api.h:107
Definition: c_api.h:152
Definition: c_api.h:155
MXNET_DLL int MXRtcCudaKernelCall(CudaKernelHandle handle, int dev_id, void **args, mx_uint grid_dim_x, mx_uint grid_dim_y, mx_uint grid_dim_z, mx_uint block_dim_x, mx_uint block_dim_y, mx_uint block_dim_z, mx_uint shared_mem)
int(* CustomOpInferShapeFunc)(int, int *, unsigned **, void *)
Definition: c_api.h:167
MXNET_DLL int MXSymbolFree(SymbolHandle symbol)
Free the symbol handle.
MXNET_DLL int MXExecutorFree(ExecutorHandle handle)
Delete the executor.
MXNET_DLL int MXNDArrayWaitToWrite(NDArrayHandle handle)
Wait until all the pending read/write with respect NDArray are finished. Always call this before writ...
int(* CustomOpListFunc)(char ***, void *)
Definition: c_api.h:166
MXNET_DLL int MXGetGPUMemoryInformation(int dev, int *free_mem, int *total_mem)
get the free and total available memory on a GPU
MXNET_DLL int MXExecutorForward(ExecutorHandle handle, int is_train)
Executor forward method.
MXNET_DLL int MXNDArrayGetData(NDArrayHandle handle, void **out_pdata)
get the content of the data in NDArray