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;
99 typedef const void *ContextHandle;
101 typedef const void *EngineFnPropertyHandle;
103 typedef void *EngineVarHandle;
104 
106 typedef void (*EngineAsyncFunc)(void*, void*, void*);
108 typedef void (*EngineSyncFunc)(void*, void*);
110 typedef void (*EngineFuncParamDeleter)(void*);
111 typedef void (*ExecutorMonitorCallback)(const char*,
113  void*);
114 
115 struct NativeOpInfo {
116  void (*forward)(int, float**, int*, unsigned**, int*, void*);
117  void (*backward)(int, float**, int*, unsigned**, int*, void*);
118  void (*infer_shape)(int, int*, unsigned**, void*);
119  void (*list_outputs)(char***, void*);
120  void (*list_arguments)(char***, void*);
121  // all functions also pass a payload void* pointer
122  void* p_forward;
123  void* p_backward;
127 };
128 
130  bool (*forward)(int, void**, int*, void*);
131  bool (*backward)(int, void**, int*, void*);
132  bool (*infer_shape)(int, int*, unsigned**, void*);
133  bool (*list_outputs)(char***, void*);
134  bool (*list_arguments)(char***, void*);
135  bool (*declare_backward_dependency)(const int*, const int*, const int*,
136  int*, int**, void*);
137  // all functions also pass a payload void* pointer
138  void* p_forward;
139  void* p_backward;
144 };
145 
146 typedef int (*MXGenericCallback)(void);
147 
150  int (**callbacks)(void);
151  void **contexts;
152 };
153 
158 };
159 
171 };
172 
173 
174 typedef int (*CustomOpFBFunc)(int /*size*/, void** /*ptrs*/, int* /*tags*/,
175  const int* /*reqs*/, const int /*is_train*/,
176  void* /*state*/);
177 typedef int (*CustomOpDelFunc)(void* /*state*/);
178 typedef int (*CustomOpListFunc)(char*** /*args*/, void* /*state*/);
179 typedef int (*CustomOpInferShapeFunc)(int /*num_input*/, int* /*ndims*/,
180  unsigned** /*shapes*/, void* /*state*/);
181 typedef int (*CustomOpInferStorageTypeFunc)(int /*num_input*/, int* /*stypes*/, void* /*state*/);
182 typedef int (*CustomOpBackwardInferStorageTypeFunc)(int /*num_input*/,
183  int * /*stypes*/,
184  int * /*tags*/,
185  void * /*state*/);
186 typedef int (*CustomOpInferTypeFunc)(int /*num_input*/, int* /*types*/, void* /*state*/);
187 typedef int (*CustomOpBwdDepFunc)(const int* /*out_grad*/, const int* /*in_data*/,
188  const int* /*out_data*/, int* /*num_deps*/,
189  int** /*rdeps*/, void* /*state*/);
190 typedef int (*CustomOpCreateFunc)(const char* /*ctx*/, int /*num_inputs*/,
191  unsigned** /*shapes*/, const int* /*ndims*/,
192  const int* /*dtypes*/, struct MXCallbackList* /*ret*/,
193  void* /*state*/);
194 typedef int (*CustomOpPropCreator)(const char* /*op_type*/, const int /*num_kwargs*/,
195  const char** /*keys*/, const char** /*values*/,
196  struct MXCallbackList* /*ret*/);
197 
198 
202 };
203 
204 typedef int (*CustomFunctionBwdFunc)(int /*num_ograds*/, int /*num_igrads*/, void** /*ptrs*/,
205  const int* /*reqs*/, const int /*is_train*/,
206  void* /*state*/);
207 typedef int (*CustomFunctionDelFunc)(void* /*state*/);
208 
218 MXNET_DLL const char *MXGetLastError();
219 
220 //-------------------------------------
221 // Part 0: Global State setups
222 //-------------------------------------
228 MXNET_DLL int MXRandomSeed(int seed);
229 
235 MXNET_DLL int MXRandomSeedContext(int seed, int dev_type, int dev_id);
236 
245 
254 MXNET_DLL int MXSetProcessProfilerConfig(int num_params, const char* const* keys,
255  const char* const* vals,
256  KVStoreHandle kvstoreHandle);
257 
265 MXNET_DLL int MXSetProfilerConfig(int num_params, const char* const* keys, const char* const* vals);
266 
278 MXNET_DLL int MXSetProcessProfilerState(int state, int profile_process,
279  KVStoreHandle kvStoreHandle);
280 
288 MXNET_DLL int MXSetProfilerState(int state);
289 
299 MXNET_DLL int MXDumpProcessProfile(int finished, int profile_process, KVStoreHandle kvStoreHandle);
300 
301 
307 MXNET_DLL int MXDumpProfile(int finished);
308 
316 MXNET_DLL int MXAggregateProfileStatsPrint(const char **out_str, int reset);
317 
326 MXNET_DLL int MXProcessProfilePause(int paused, int profile_process, KVStoreHandle kvStoreHandle);
327 
334 MXNET_DLL int MXProfilePause(int paused);
335 
342 MXNET_DLL int MXProfileCreateDomain(const char *domain, ProfileHandle *out);
343 
351 MXNET_DLL int MXProfileCreateTask(ProfileHandle domain,
352  const char *task_name,
353  ProfileHandle *out);
354 
362 MXNET_DLL int MXProfileCreateFrame(ProfileHandle domain,
363  const char *frame_name,
364  ProfileHandle *out);
365 
372 MXNET_DLL int MXProfileCreateEvent(const char *event_name, ProfileHandle *out);
373 
381 MXNET_DLL int MXProfileCreateCounter(ProfileHandle domain,
382  const char *counter_name,
383  ProfileHandle *out);
384 
390 MXNET_DLL int MXProfileDestroyHandle(ProfileHandle frame_handle);
391 
397 MXNET_DLL int MXProfileDurationStart(ProfileHandle duration_handle);
398 
404 MXNET_DLL int MXProfileDurationStop(ProfileHandle duration_handle);
405 
412 MXNET_DLL int MXProfileSetCounter(ProfileHandle counter_handle, uint64_t value);
413 
420 MXNET_DLL int MXProfileAdjustCounter(ProfileHandle counter_handle, int64_t value);
421 
429 MXNET_DLL int MXProfileSetMarker(ProfileHandle domain,
430  const char *instant_marker_name,
431  const char *scope);
432 
438 MXNET_DLL int MXSetNumOMPThreads(int thread_num);
439 
445 MXNET_DLL int MXEngineSetBulkSize(int bulk_size, int* prev_bulk_size);
446 
452 MXNET_DLL int MXGetGPUCount(int* out);
453 
462 MXNET_DLL int MXGetGPUMemoryInformation(int dev, int *free_mem, int *total_mem);
463 
471 MXNET_DLL int MXGetGPUMemoryInformation64(int dev, uint64_t *free_mem, uint64_t *total_mem);
472 
478 MXNET_DLL int MXGetVersion(int *out);
479 
480 //-------------------------------------
481 // Part 1: NDArray creation and deletion
482 //-------------------------------------
490 MXNET_DLL int MXNDArrayCreateNone(NDArrayHandle *out);
502 MXNET_DLL int MXNDArrayCreate(const mx_uint *shape,
503  mx_uint ndim,
504  int dev_type,
505  int dev_id,
506  int delay_alloc,
507  NDArrayHandle *out);
508 
521 MXNET_DLL int MXNDArrayCreateEx(const mx_uint *shape,
522  mx_uint ndim,
523  int dev_type,
524  int dev_id,
525  int delay_alloc,
526  int dtype,
527  NDArrayHandle *out);
528 
529 
547 MXNET_DLL int MXNDArrayCreateSparseEx(int storage_type,
548  const mx_uint *shape,
549  mx_uint ndim,
550  int dev_type,
551  int dev_id,
552  int delay_alloc,
553  int dtype,
554  mx_uint num_aux,
555  int *aux_type,
556  mx_uint *aux_ndims,
557  const mx_uint *aux_shape,
558  NDArrayHandle *out);
559 
567 MXNET_DLL int MXNDArrayLoadFromRawBytes(const void *buf,
568  size_t size,
569  NDArrayHandle *out);
577 MXNET_DLL int MXNDArraySaveRawBytes(NDArrayHandle handle,
578  size_t *out_size,
579  const char **out_buf);
588 MXNET_DLL int MXNDArraySave(const char* fname,
589  mx_uint num_args,
590  NDArrayHandle* args,
591  const char** keys);
601 MXNET_DLL int MXNDArrayLoad(const char* fname,
602  mx_uint *out_size,
603  NDArrayHandle** out_arr,
604  mx_uint *out_name_size,
605  const char*** out_names);
606 
621 MXNET_DLL int MXNDArrayLoadFromBuffer(const void *ndarray_buffer,
622  size_t size,
623  mx_uint *out_size,
624  NDArrayHandle** out_arr,
625  mx_uint *out_name_size,
626  const char*** out_names);
627 
639 MXNET_DLL int MXNDArraySyncCopyFromCPU(NDArrayHandle handle,
640  const void *data,
641  size_t size);
653 MXNET_DLL int MXNDArraySyncCopyToCPU(NDArrayHandle handle,
654  void *data,
655  size_t size);
663 MXNET_DLL int MXNDArraySyncCopyFromNDArray(NDArrayHandle handle_dst,
664  const NDArrayHandle handle_src,
665  const int i);
666 
672 MXNET_DLL int MXNDArraySyncCheckFormat(NDArrayHandle handle, const bool full_check);
679 MXNET_DLL int MXNDArrayWaitToRead(NDArrayHandle handle);
686 MXNET_DLL int MXNDArrayWaitToWrite(NDArrayHandle handle);
698 MXNET_DLL int MXNDArrayFree(NDArrayHandle handle);
707 MXNET_DLL int MXNDArraySlice(NDArrayHandle handle,
708  mx_uint slice_begin,
709  mx_uint slice_end,
710  NDArrayHandle *out);
711 
719 MXNET_DLL int MXNDArrayAt(NDArrayHandle handle,
720  mx_uint idx,
721  NDArrayHandle *out);
722 
726 MXNET_DLL int MXNDArrayGetStorageType(NDArrayHandle handle,
727  int *out_storage_type);
728 
737 MXNET_DLL int MXNDArrayReshape(NDArrayHandle handle,
738  int ndim,
739  int *dims,
740  NDArrayHandle *out);
741 
750 MXNET_DLL int MXNDArrayReshape64(NDArrayHandle handle,
751  int ndim,
752  dim_t *dims,
753  bool reverse,
754  NDArrayHandle *out);
762 MXNET_DLL int MXNDArrayGetShape(NDArrayHandle handle,
763  mx_uint *out_dim,
764  const mx_uint **out_pdata);
771 MXNET_DLL int MXNDArrayGetData(NDArrayHandle handle,
772  void **out_pdata);
782 MXNET_DLL int MXNDArrayToDLPack(NDArrayHandle handle,
783  DLManagedTensorHandle *out_dlpack);
784 
798 MXNET_DLL int MXNDArrayFromDLPack(DLManagedTensorHandle dlpack,
799  NDArrayHandle *out_handle);
805 MXNET_DLL int MXNDArrayCallDLPackDeleter(DLManagedTensorHandle dlpack);
806 
813 MXNET_DLL int MXNDArrayGetDType(NDArrayHandle handle,
814  int *out_dtype);
815 
823 MXNET_DLL int MXNDArrayGetAuxType(NDArrayHandle handle,
824  mx_uint i,
825  int *out_type);
826 
832 MXNET_DLL int MXNDArrayGetAuxNDArray(NDArrayHandle handle,
833  mx_uint i,
834  NDArrayHandle *out);
835 
841 MXNET_DLL int MXNDArrayGetDataNDArray(NDArrayHandle handle,
842  NDArrayHandle *out);
850 MXNET_DLL int MXNDArrayGetContext(NDArrayHandle handle,
851  int *out_dev_type,
852  int *out_dev_id);
858 MXNET_DLL int MXNDArrayGetGrad(NDArrayHandle handle, NDArrayHandle *out);
864 MXNET_DLL int MXNDArrayDetach(NDArrayHandle handle, NDArrayHandle *out);
871 MXNET_DLL int MXNDArraySetGradState(NDArrayHandle handle, int state);
878 MXNET_DLL int MXNDArrayGetGradState(NDArrayHandle handle, int *out);
879 //--------------------------------
880 // Part 2: functions on NDArray
881 //--------------------------------
889 MXNET_DLL int MXListFunctions(mx_uint *out_size,
890  FunctionHandle **out_array);
897 MXNET_DLL int MXGetFunction(const char *name,
898  FunctionHandle *out);
911 MXNET_DLL int MXFuncGetInfo(FunctionHandle fun,
912  const char **name,
913  const char **description,
914  mx_uint *num_args,
915  const char ***arg_names,
916  const char ***arg_type_infos,
917  const char ***arg_descriptions,
918  const char **return_type DEFAULT(NULL));
929 MXNET_DLL int MXFuncDescribe(FunctionHandle fun,
930  mx_uint *num_use_vars,
931  mx_uint *num_scalars,
932  mx_uint *num_mutate_vars,
933  int *type_mask);
944 MXNET_DLL int MXFuncInvoke(FunctionHandle fun,
945  NDArrayHandle *use_vars,
946  mx_float *scalar_args,
947  NDArrayHandle *mutate_vars);
961 MXNET_DLL int MXFuncInvokeEx(FunctionHandle fun,
962  NDArrayHandle *use_vars,
963  mx_float *scalar_args,
964  NDArrayHandle *mutate_vars,
965  int num_params,
966  char **param_keys,
967  char **param_vals);
980 MXNET_DLL int MXImperativeInvoke(AtomicSymbolCreator creator,
981  int num_inputs,
982  NDArrayHandle *inputs,
983  int *num_outputs,
984  NDArrayHandle **outputs,
985  int num_params,
986  const char **param_keys,
987  const char **param_vals);
1001 MXNET_DLL int MXImperativeInvokeEx(AtomicSymbolCreator creator,
1002  int num_inputs,
1003  NDArrayHandle *inputs,
1004  int *num_outputs,
1005  NDArrayHandle **outputs,
1006  int num_params,
1007  const char **param_keys,
1008  const char **param_vals,
1009  const int **out_stypes);
1016 MXNET_DLL int MXAutogradSetIsRecording(int is_recording, int* prev);
1023 MXNET_DLL int MXAutogradSetIsTraining(int is_training, int* prev);
1029 MXNET_DLL int MXAutogradIsRecording(bool* curr);
1035 MXNET_DLL int MXAutogradIsTraining(bool* curr);
1042 MXNET_DLL int MXAutogradMarkVariables(mx_uint num_var,
1043  NDArrayHandle *var_handles,
1044  mx_uint *reqs_array,
1045  NDArrayHandle *grad_handles);
1052 MXNET_DLL int MXAutogradComputeGradient(mx_uint num_output,
1053  NDArrayHandle* output_handles);
1062 MXNET_DLL int MXAutogradBackward(mx_uint num_output,
1063  NDArrayHandle* output_handles,
1064  NDArrayHandle* ograd_handles,
1065  int retain_graph);
1077 MXNET_DLL int MXAutogradBackwardEx(mx_uint num_output,
1078  NDArrayHandle *output_handles,
1079  NDArrayHandle *ograd_handles,
1080  mx_uint num_variables,
1081  NDArrayHandle *var_handles,
1082  int retain_graph,
1083  int create_graph,
1084  int is_train,
1085  NDArrayHandle **grad_handles,
1086  int **grad_stypes);
1087 /*
1088  * \brief get the graph constructed by autograd.
1089  * \param handle ndarray handle
1090  * \param out output symbol handle
1091  */
1092 MXNET_DLL int MXAutogradGetSymbol(NDArrayHandle handle, SymbolHandle *out);
1096 MXNET_DLL int MXCreateCachedOp(SymbolHandle handle, CachedOpHandle *out);
1100 MXNET_DLL int MXCreateCachedOpEx(SymbolHandle handle,
1101  int num_flags,
1102  const char** keys,
1103  const char** vals,
1104  CachedOpHandle *out);
1108 MXNET_DLL int MXFreeCachedOp(CachedOpHandle handle);
1112 MXNET_DLL int MXInvokeCachedOp(CachedOpHandle handle,
1113  int num_inputs,
1114  NDArrayHandle *inputs,
1115  int *num_outputs,
1116  NDArrayHandle **outputs);
1127 MXNET_DLL int MXInvokeCachedOpEx(CachedOpHandle handle,
1128  int num_inputs,
1129  NDArrayHandle *inputs,
1130  int *num_outputs,
1131  NDArrayHandle **outputs,
1132  const int** out_stypes);
1133 
1134 //--------------------------------------------
1135 // Part 3: symbolic configuration generation
1136 //--------------------------------------------
1143 MXNET_DLL int MXListAllOpNames(mx_uint *out_size,
1144  const char ***out_array);
1151 MXNET_DLL int MXSymbolListAtomicSymbolCreators(mx_uint *out_size,
1152  AtomicSymbolCreator **out_array);
1153 
1159 MXNET_DLL int MXSymbolGetAtomicSymbolName(AtomicSymbolCreator creator,
1160  const char **name);
1161 
1168 MXNET_DLL int MXSymbolGetInputSymbols(SymbolHandle sym, SymbolHandle **inputs,
1169  int *input_size);
1170 
1180 MXNET_DLL int MXSymbolCutSubgraph(SymbolHandle sym, SymbolHandle **inputs,
1181  int *input_size);
1182 
1200 MXNET_DLL int MXSymbolGetAtomicSymbolInfo(AtomicSymbolCreator creator,
1201  const char **name,
1202  const char **description,
1203  mx_uint *num_args,
1204  const char ***arg_names,
1205  const char ***arg_type_infos,
1206  const char ***arg_descriptions,
1207  const char **key_var_num_args,
1208  const char **return_type DEFAULT(NULL));
1218 MXNET_DLL int MXSymbolCreateAtomicSymbol(AtomicSymbolCreator creator,
1219  mx_uint num_param,
1220  const char **keys,
1221  const char **vals,
1222  SymbolHandle *out);
1229 MXNET_DLL int MXSymbolCreateVariable(const char *name, SymbolHandle *out);
1237 MXNET_DLL int MXSymbolCreateGroup(mx_uint num_symbols,
1238  SymbolHandle *symbols,
1239  SymbolHandle *out);
1246 MXNET_DLL int MXSymbolCreateFromFile(const char *fname, SymbolHandle *out);
1253 MXNET_DLL int MXSymbolCreateFromJSON(const char *json, SymbolHandle *out);
1260 MXNET_DLL int MXSymbolSaveToFile(SymbolHandle symbol, const char *fname);
1267 MXNET_DLL int MXSymbolSaveToJSON(SymbolHandle symbol, const char **out_json);
1273 MXNET_DLL int MXSymbolFree(SymbolHandle symbol);
1280 MXNET_DLL int MXSymbolCopy(SymbolHandle symbol, SymbolHandle *out);
1287 MXNET_DLL int MXSymbolPrint(SymbolHandle symbol, const char **out_str);
1295 MXNET_DLL int MXSymbolGetName(SymbolHandle symbol,
1296  const char** out,
1297  int *success);
1306 MXNET_DLL int MXSymbolGetAttr(SymbolHandle symbol,
1307  const char* key,
1308  const char** out,
1309  int *success);
1326 MXNET_DLL int MXSymbolSetAttr(SymbolHandle symbol,
1327  const char* key,
1328  const char* value);
1336 MXNET_DLL int MXSymbolListAttr(SymbolHandle symbol,
1337  mx_uint *out_size,
1338  const char*** out);
1346 MXNET_DLL int MXSymbolListAttrShallow(SymbolHandle symbol,
1347  mx_uint *out_size,
1348  const char*** out);
1356 MXNET_DLL int MXSymbolListArguments(SymbolHandle symbol,
1357  mx_uint *out_size,
1358  const char ***out_str_array);
1366 MXNET_DLL int MXSymbolListOutputs(SymbolHandle symbol,
1367  mx_uint *out_size,
1368  const char ***out_str_array);
1369 
1376 MXNET_DLL int MXSymbolGetNumOutputs(SymbolHandle symbol,
1377  mx_uint *output_count);
1378 
1385 MXNET_DLL int MXSymbolGetInternals(SymbolHandle symbol,
1386  SymbolHandle *out);
1393 MXNET_DLL int MXSymbolGetChildren(SymbolHandle symbol,
1394  SymbolHandle *out);
1402 MXNET_DLL int MXSymbolGetOutput(SymbolHandle symbol,
1403  mx_uint index,
1404  SymbolHandle *out);
1405 
1413 MXNET_DLL int MXSymbolListAuxiliaryStates(SymbolHandle symbol,
1414  mx_uint *out_size,
1415  const char ***out_str_array);
1430 MXNET_DLL int MXSymbolCompose(SymbolHandle sym,
1431  const char *name,
1432  mx_uint num_args,
1433  const char** keys,
1434  SymbolHandle* args);
1444 MXNET_DLL int MXSymbolGrad(SymbolHandle sym,
1445  mx_uint num_wrt,
1446  const char** wrt,
1447  SymbolHandle* out);
1470 MXNET_DLL int MXSymbolInferShape(SymbolHandle sym,
1471  mx_uint num_args,
1472  const char** keys,
1473  const mx_uint *arg_ind_ptr,
1474  const mx_uint *arg_shape_data,
1475  mx_uint *in_shape_size,
1476  const mx_uint **in_shape_ndim,
1477  const mx_uint ***in_shape_data,
1478  mx_uint *out_shape_size,
1479  const mx_uint **out_shape_ndim,
1480  const mx_uint ***out_shape_data,
1481  mx_uint *aux_shape_size,
1482  const mx_uint **aux_shape_ndim,
1483  const mx_uint ***aux_shape_data,
1484  int *complete);
1509 MXNET_DLL int MXSymbolInferShapePartial(SymbolHandle sym,
1510  mx_uint num_args,
1511  const char** keys,
1512  const mx_uint *arg_ind_ptr,
1513  const mx_uint *arg_shape_data,
1514  mx_uint *in_shape_size,
1515  const mx_uint **in_shape_ndim,
1516  const mx_uint ***in_shape_data,
1517  mx_uint *out_shape_size,
1518  const mx_uint **out_shape_ndim,
1519  const mx_uint ***out_shape_data,
1520  mx_uint *aux_shape_size,
1521  const mx_uint **aux_shape_ndim,
1522  const mx_uint ***aux_shape_data,
1523  int *complete);
1524 
1543 MXNET_DLL int MXSymbolInferType(SymbolHandle sym,
1544  mx_uint num_args,
1545  const char** keys,
1546  const int *arg_type_data,
1547  mx_uint *in_type_size,
1548  const int **in_type_data,
1549  mx_uint *out_type_size,
1550  const int **out_type_data,
1551  mx_uint *aux_type_size,
1552  const int **aux_type_data,
1553  int *complete);
1554 
1566 MXNET_DLL int MXQuantizeSymbol(SymbolHandle sym_handle, SymbolHandle *ret_sym_handle,
1567  const mx_uint num_excluded_symbols,
1568  const char **excluded_symbols,
1569  const mx_uint num_offline, const char **offline_params,
1570  const char *quantized_dtype, const bool calib_quantize);
1571 
1581 MXNET_DLL int MXSetCalibTableToQuantizedSymbol(SymbolHandle qsym_handle,
1582  const mx_uint num_layers,
1583  const char** layer_names,
1584  const float* low_quantiles,
1585  const float* high_quantiles,
1586  SymbolHandle* ret_sym_handle);
1587 
1594 MXNET_DLL int MXGenBackendSubgraph(SymbolHandle sym_handle, const char *backend,
1595  SymbolHandle *ret_sym_handle);
1596 
1597 //--------------------------------------------
1598 // Part 4: Executor interface
1599 //--------------------------------------------
1605 MXNET_DLL int MXExecutorFree(ExecutorHandle handle);
1612 MXNET_DLL int MXExecutorPrint(ExecutorHandle handle, const char **out_str);
1620 MXNET_DLL int MXExecutorForward(ExecutorHandle handle, int is_train);
1630 MXNET_DLL int MXExecutorBackward(ExecutorHandle handle,
1631  mx_uint len,
1632  NDArrayHandle *head_grads);
1643 MXNET_DLL int MXExecutorBackwardEx(ExecutorHandle handle,
1644  mx_uint len,
1645  NDArrayHandle *head_grads,
1646  int is_train);
1655 MXNET_DLL int MXExecutorOutputs(ExecutorHandle handle,
1656  mx_uint *out_size,
1657  NDArrayHandle **out);
1658 
1674 MXNET_DLL int MXExecutorBind(SymbolHandle symbol_handle,
1675  int dev_type,
1676  int dev_id,
1677  mx_uint len,
1678  NDArrayHandle *in_args,
1679  NDArrayHandle *arg_grad_store,
1680  mx_uint *grad_req_type,
1681  mx_uint aux_states_len,
1682  NDArrayHandle *aux_states,
1683  ExecutorHandle *out);
1705 MXNET_DLL int MXExecutorBindX(SymbolHandle symbol_handle,
1706  int dev_type,
1707  int dev_id,
1708  mx_uint num_map_keys,
1709  const char** map_keys,
1710  const int* map_dev_types,
1711  const int* map_dev_ids,
1712  mx_uint len,
1713  NDArrayHandle *in_args,
1714  NDArrayHandle *arg_grad_store,
1715  mx_uint *grad_req_type,
1716  mx_uint aux_states_len,
1717  NDArrayHandle *aux_states,
1718  ExecutorHandle *out);
1741 MXNET_DLL int MXExecutorBindEX(SymbolHandle symbol_handle,
1742  int dev_type,
1743  int dev_id,
1744  mx_uint num_map_keys,
1745  const char** map_keys,
1746  const int* map_dev_types,
1747  const int* map_dev_ids,
1748  mx_uint len,
1749  NDArrayHandle *in_args,
1750  NDArrayHandle *arg_grad_store,
1751  mx_uint *grad_req_type,
1752  mx_uint aux_states_len,
1753  NDArrayHandle *aux_states,
1754  ExecutorHandle shared_exec,
1755  ExecutorHandle *out);
1756 
1757 MXNET_DLL int MXExecutorSimpleBind(SymbolHandle symbol_handle,
1758  int dev_type,
1759  int dev_id,
1760  const mx_uint num_g2c_keys,
1761  const char** g2c_keys,
1762  const int* g2c_dev_types,
1763  const int* g2c_dev_ids,
1764  const mx_uint provided_grad_req_list_len,
1765  const char** provided_grad_req_names,
1766  const char** provided_grad_req_types,
1767  const mx_uint num_provided_arg_shapes,
1768  const char** provided_arg_shape_names,
1769  const mx_uint* provided_arg_shape_data,
1770  const mx_uint* provided_arg_shape_idx,
1771  const mx_uint num_provided_arg_dtypes,
1772  const char** provided_arg_dtype_names,
1773  const int* provided_arg_dtypes,
1774  const mx_uint num_provided_arg_stypes,
1775  const char** provided_arg_stype_names,
1776  const int* provided_arg_stypes,
1777  const mx_uint num_shared_arg_names,
1778  const char** shared_arg_name_list,
1779  int* shared_buffer_len,
1780  const char** shared_buffer_name_list,
1781  NDArrayHandle* shared_buffer_handle_list,
1782  const char*** updated_shared_buffer_name_list,
1783  NDArrayHandle** updated_shared_buffer_handle_list,
1784  mx_uint* num_in_args,
1785  NDArrayHandle** in_args,
1786  NDArrayHandle** arg_grads,
1787  mx_uint* num_aux_states,
1788  NDArrayHandle** aux_states,
1789  ExecutorHandle shared_exec_handle,
1790  ExecutorHandle* out);
1791 
1813 MXNET_DLL int MXExecutorReshape(int partial_shaping,
1814  int allow_up_sizing,
1815  int dev_type,
1816  int dev_id,
1817  mx_uint num_map_keys,
1818  const char** map_keys,
1819  const int* map_dev_types,
1820  const int* map_dev_ids,
1821  const mx_uint num_provided_arg_shapes,
1822  const char** provided_arg_shape_names,
1823  const mx_uint* provided_arg_shape_data,
1824  const mx_uint* provided_arg_shape_idx,
1825  mx_uint* num_in_args,
1826  NDArrayHandle** in_args,
1827  NDArrayHandle** arg_grads,
1828  mx_uint* num_aux_states,
1829  NDArrayHandle** aux_states,
1830  ExecutorHandle shared_exec,
1831  ExecutorHandle *out);
1832 
1836 MXNET_DLL int MXExecutorGetOptimizedSymbol(ExecutorHandle handle,
1837  SymbolHandle *out);
1838 
1842 MXNET_DLL int MXExecutorSetMonitorCallback(ExecutorHandle handle,
1843  ExecutorMonitorCallback callback,
1844  void* callback_handle);
1845 //--------------------------------------------
1846 // Part 5: IO Interface
1847 //--------------------------------------------
1854 MXNET_DLL int MXListDataIters(mx_uint *out_size,
1855  DataIterCreator **out_array);
1866 MXNET_DLL int MXDataIterCreateIter(DataIterCreator handle,
1867  mx_uint num_param,
1868  const char **keys,
1869  const char **vals,
1870  DataIterHandle *out);
1882 MXNET_DLL int MXDataIterGetIterInfo(DataIterCreator creator,
1883  const char **name,
1884  const char **description,
1885  mx_uint *num_args,
1886  const char ***arg_names,
1887  const char ***arg_type_infos,
1888  const char ***arg_descriptions);
1894 MXNET_DLL int MXDataIterFree(DataIterHandle handle);
1901 MXNET_DLL int MXDataIterNext(DataIterHandle handle,
1902  int *out);
1908 MXNET_DLL int MXDataIterBeforeFirst(DataIterHandle handle);
1909 
1916 MXNET_DLL int MXDataIterGetData(DataIterHandle handle,
1917  NDArrayHandle *out);
1925 MXNET_DLL int MXDataIterGetIndex(DataIterHandle handle,
1926  uint64_t **out_index,
1927  uint64_t *out_size);
1934 MXNET_DLL int MXDataIterGetPadNum(DataIterHandle handle,
1935  int *pad);
1936 
1943 MXNET_DLL int MXDataIterGetLabel(DataIterHandle handle,
1944  NDArrayHandle *out);
1945 //--------------------------------------------
1946 // Part 6: basic KVStore interface
1947 //--------------------------------------------
1954 MXNET_DLL int MXInitPSEnv(mx_uint num_vars,
1955  const char **keys,
1956  const char **vals);
1957 
1958 
1965 MXNET_DLL int MXKVStoreCreate(const char *type,
1966  KVStoreHandle *out);
1967 
1975 MXNET_DLL int MXKVStoreSetGradientCompression(KVStoreHandle handle,
1976  mx_uint num_params,
1977  const char** keys,
1978  const char** vals);
1979 
1985 MXNET_DLL int MXKVStoreFree(KVStoreHandle handle);
1994 MXNET_DLL int MXKVStoreInit(KVStoreHandle handle,
1995  mx_uint num,
1996  const int* keys,
1997  NDArrayHandle* vals);
1998 
2007 MXNET_DLL int MXKVStoreInitEx(KVStoreHandle handle,
2008  mx_uint num,
2009  const char** keys,
2010  NDArrayHandle* vals);
2011 
2021 MXNET_DLL int MXKVStorePush(KVStoreHandle handle,
2022  mx_uint num,
2023  const int* keys,
2024  NDArrayHandle* vals,
2025  int priority);
2035 MXNET_DLL int MXKVStorePushEx(KVStoreHandle handle,
2036  mx_uint num,
2037  const char** keys,
2038  NDArrayHandle* vals,
2039  int priority);
2050 MXNET_DLL int MXKVStorePullWithSparse(KVStoreHandle handle,
2051  mx_uint num,
2052  const int* keys,
2053  NDArrayHandle* vals,
2054  int priority,
2055  bool ignore_sparse);
2066 MXNET_DLL int MXKVStorePullWithSparseEx(KVStoreHandle handle,
2067  mx_uint num,
2068  const char** keys,
2069  NDArrayHandle* vals,
2070  int priority,
2071  bool ignore_sparse);
2081 MXNET_DLL int MXKVStorePull(KVStoreHandle handle,
2082  mx_uint num,
2083  const int* keys,
2084  NDArrayHandle* vals,
2085  int priority);
2095 MXNET_DLL int MXKVStorePullEx(KVStoreHandle handle,
2096  mx_uint num,
2097  const char** keys,
2098  NDArrayHandle* vals,
2099  int priority);
2100 
2113 MXNET_DLL int MXKVStorePullRowSparse(KVStoreHandle handle,
2114  mx_uint num,
2115  const int* keys,
2116  NDArrayHandle* vals,
2117  const NDArrayHandle* row_ids,
2118  int priority);
2131 MXNET_DLL int MXKVStorePullRowSparseEx(KVStoreHandle handle,
2132  mx_uint num,
2133  const char** keys,
2134  NDArrayHandle* vals,
2135  const NDArrayHandle* row_ids,
2136  int priority);
2137 
2146 typedef void (MXKVStoreUpdater)(int key,
2147  NDArrayHandle recv,
2148  NDArrayHandle local,
2149  void *handle);
2158 typedef void (MXKVStoreStrUpdater)(const char* key,
2159  NDArrayHandle recv,
2160  NDArrayHandle local,
2161  void *handle);
2169 MXNET_DLL int MXKVStoreSetUpdater(KVStoreHandle handle,
2170  MXKVStoreUpdater updater,
2171  void *updater_handle);
2180 MXNET_DLL int MXKVStoreSetUpdaterEx(KVStoreHandle handle,
2181  MXKVStoreUpdater updater,
2182  MXKVStoreStrUpdater str_updater,
2183  void *updater_handle);
2190 MXNET_DLL int MXKVStoreGetType(KVStoreHandle handle,
2191  const char** type);
2192 //--------------------------------------------
2193 // Part 6: advanced KVStore for multi-machines
2194 //--------------------------------------------
2195 
2203 MXNET_DLL int MXKVStoreGetRank(KVStoreHandle handle,
2204  int *ret);
2205 
2215 MXNET_DLL int MXKVStoreGetGroupSize(KVStoreHandle handle,
2216  int *ret);
2217 
2223 MXNET_DLL int MXKVStoreIsWorkerNode(int *ret);
2224 
2225 
2231 MXNET_DLL int MXKVStoreIsServerNode(int *ret);
2232 
2233 
2239 MXNET_DLL int MXKVStoreIsSchedulerNode(int *ret);
2240 
2247 MXNET_DLL int MXKVStoreBarrier(KVStoreHandle handle);
2248 
2256 MXNET_DLL int MXKVStoreSetBarrierBeforeExit(KVStoreHandle handle,
2257  const int barrier_before_exit);
2258 
2265 typedef void (MXKVStoreServerController)(int head,
2266  const char *body,
2267  void *controller_handle);
2268 
2276 MXNET_DLL int MXKVStoreRunServer(KVStoreHandle handle,
2277  MXKVStoreServerController controller,
2278  void *controller_handle);
2279 
2287 MXNET_DLL int MXKVStoreSendCommmandToServers(KVStoreHandle handle,
2288  int cmd_id,
2289  const char* cmd_body);
2290 
2301 MXNET_DLL int MXKVStoreGetNumDeadNode(KVStoreHandle handle,
2302  const int node_id,
2303  int *number,
2304  const int timeout_sec DEFAULT(60));
2305 
2312 MXNET_DLL int MXRecordIOWriterCreate(const char *uri, RecordIOHandle *out);
2313 
2319 MXNET_DLL int MXRecordIOWriterFree(RecordIOHandle handle);
2320 
2328 MXNET_DLL int MXRecordIOWriterWriteRecord(RecordIOHandle handle,
2329  const char *buf, size_t size);
2330 
2337 MXNET_DLL int MXRecordIOWriterTell(RecordIOHandle handle, size_t *pos);
2338 
2345 MXNET_DLL int MXRecordIOReaderCreate(const char *uri, RecordIOHandle *out);
2346 
2352 MXNET_DLL int MXRecordIOReaderFree(RecordIOHandle handle);
2353 
2361 MXNET_DLL int MXRecordIOReaderReadRecord(RecordIOHandle handle,
2362  char const **buf, size_t *size);
2363 
2370 MXNET_DLL int MXRecordIOReaderSeek(RecordIOHandle handle, size_t pos);
2371 
2378 MXNET_DLL int MXRecordIOReaderTell(RecordIOHandle handle, size_t *pos);
2379 
2383 MXNET_DLL int MXRtcCreate(char* name, mx_uint num_input, mx_uint num_output,
2384  char** input_names, char** output_names,
2385  NDArrayHandle* inputs, NDArrayHandle* outputs,
2386  char* kernel, RtcHandle *out);
2387 
2391 MXNET_DLL int MXRtcPush(RtcHandle handle, mx_uint num_input, mx_uint num_output,
2392  NDArrayHandle* inputs, NDArrayHandle* outputs,
2393  mx_uint gridDimX,
2394  mx_uint gridDimY,
2395  mx_uint gridDimZ,
2396  mx_uint blockDimX,
2397  mx_uint blockDimY,
2398  mx_uint blockDimZ);
2399 
2403 MXNET_DLL int MXRtcFree(RtcHandle handle);
2404 /*
2405  * \brief register custom operators from frontend.
2406  * \param op_type name of custom op
2407  * \param creator
2408  */
2409 MXNET_DLL int MXCustomOpRegister(const char* op_type, CustomOpPropCreator creator);
2410 /*
2411  * \brief record custom function for backward later.
2412  * \param num_inputs number of input NDArrays.
2413  * \param inputs handle to input NDArrays.
2414  * \param num_outputs number of output NDArrays.
2415  * \param outputs handle to output NDArrays.
2416  * \param callbacks callbacks for backward function.
2417  */
2418 MXNET_DLL int MXCustomFunctionRecord(int num_inputs, NDArrayHandle *inputs,
2419  int num_outputs, NDArrayHandle *outputs,
2420  struct MXCallbackList *callbacks);
2421 /*
2422  * \brief create cuda rtc module
2423  * \param source cuda source code
2424  * \param num_options number of compiler flags
2425  * \param options compiler flags
2426  * \param num_exports number of exported function names
2427  * \param exported function names
2428  * \param out handle to created module
2429  */
2430 MXNET_DLL int MXRtcCudaModuleCreate(const char* source, int num_options,
2431  const char** options, int num_exports,
2432  const char** exports, CudaModuleHandle *out);
2433 /*
2434  * \brief delete cuda rtc module
2435  * \param handle handle to cuda module
2436  */
2437 MXNET_DLL int MXRtcCudaModuleFree(CudaModuleHandle handle);
2438 /*
2439  * \brief get kernel from module
2440  * \param handle handle to cuda module
2441  * \param name name of kernel function
2442  * \param num_args number of arguments
2443  * \param is_ndarray whether argument is ndarray
2444  * \param is_const whether argument is constant
2445  * \param arg_types data type of arguments
2446  * \param out created kernel
2447  */
2448 MXNET_DLL int MXRtcCudaKernelCreate(CudaModuleHandle handle, const char* name,
2449  int num_args, int* is_ndarray, int* is_const,
2450  int* arg_types, CudaKernelHandle *out);
2451 /*
2452  * \brief delete kernel
2453  * \param handle handle to previously created kernel
2454  */
2455 MXNET_DLL int MXRtcCudaKernelFree(CudaKernelHandle handle);
2456 /*
2457  * \brief launch cuda kernel
2458  * \param handle handle to kernel
2459  * \param dev_id (GPU) device id
2460  * \param args pointer to arguments
2461  * \param grid_dim_x grid dimension x
2462  * \param grid_dim_y grid dimension y
2463  * \param grid_dim_z grid dimension z
2464  * \param block_dim_x block dimension x
2465  * \param block_dim_y block dimension y
2466  * \param block_dim_z block dimension z
2467  * \param shared_mem size of dynamically allocated shared memory
2468  */
2469 MXNET_DLL int MXRtcCudaKernelCall(CudaKernelHandle handle, int dev_id, void** args,
2470  mx_uint grid_dim_x, mx_uint grid_dim_y,
2471  mx_uint grid_dim_z, mx_uint block_dim_x,
2472  mx_uint block_dim_y, mx_uint block_dim_z,
2473  mx_uint shared_mem);
2480 MXNET_DLL int MXNDArrayGetSharedMemHandle(NDArrayHandle handle, int* shared_pid,
2481  int* shared_id);
2491 MXNET_DLL int MXNDArrayCreateFromSharedMem(int shared_pid, int shared_id, const mx_uint *shape,
2492  mx_uint ndim, int dtype, NDArrayHandle *out);
2493 
2511 MXNET_DLL int MXEnginePushAsync(EngineAsyncFunc async_func, void* func_param,
2512  EngineFuncParamDeleter deleter, ContextHandle ctx_handle,
2513  EngineVarHandle const_vars_handle, int num_const_vars,
2514  EngineVarHandle mutable_vars_handle, int num_mutable_vars,
2515  EngineFnPropertyHandle prop_handle DEFAULT(NULL),
2516  int priority DEFAULT(0), const char* opr_name DEFAULT(NULL),
2517  bool wait DEFAULT(false));
2518 
2534 MXNET_DLL int MXEnginePushSync(EngineSyncFunc sync_func, void* func_param,
2535  EngineFuncParamDeleter deleter, ContextHandle ctx_handle,
2536  EngineVarHandle const_vars_handle, int num_const_vars,
2537  EngineVarHandle mutable_vars_handle, int num_mutable_vars,
2538  EngineFnPropertyHandle prop_handle DEFAULT(NULL),
2539  int priority DEFAULT(0), const char* opr_name DEFAULT(NULL));
2540 
2541 #ifdef __cplusplus
2542 }
2543 #endif // __cplusplus
2544 
2545 #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:207
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
const void * EngineFnPropertyHandle
handle to Engine FnProperty
Definition: c_api.h:101
Definition: c_api.h:155
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:140
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:165
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:120
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:138
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:154
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:199
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 MXGetGPUMemoryInformation64(int dev, uint64_t *free_mem, uint64_t *total_mem)
get the free and total available memory on a GPU
MXNET_DLL int MXProfilePause(int paused)
Pause profiler tuning collection for worker/current process.
void * p_backward
Definition: c_api.h:123
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:160
int(* CustomOpInferTypeFunc)(int, int *, void *)
Definition: c_api.h:186
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
Symbol reverse(const std::string &symbol_name, Symbol data, Shape axis)
Definition: op.h:778
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:2158
Definition: c_api.h:129
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:111
void * p_forward
Definition: c_api.h:122
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:182
void * p_list_arguments
Definition: c_api.h:126
MXNET_DLL int MXKVStoreCreate(const char *type, KVStoreHandle *out)
Create a kvstore.
int(* CustomOpDelFunc)(void *)
Definition: c_api.h:177
void * p_declare_backward_dependency
Definition: c_api.h:143
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 MXEnginePushSync(EngineSyncFunc sync_func, void *func_param, EngineFuncParamDeleter deleter, ContextHandle ctx_handle, EngineVarHandle const_vars_handle, int num_const_vars, EngineVarHandle mutable_vars_handle, int num_mutable_vars, EngineFnPropertyHandle prop_handle DEFAULT(NULL), int priority DEFAULT(0), const char *opr_name DEFAULT(NULL))
Push a synchronous operation to the engine.
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:142
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:150
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:149
const void * ContextHandle
handle to Context
Definition: c_api.h:99
MXNET_DLL int MXRandomSeed(int seed)
Seed all global random number generators in mxnet.
Definition: c_api.h:169
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:116
int(* MXGenericCallback)(void)
Definition: c_api.h:146
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:200
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:2265
Definition: c_api.h:156
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:141
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:162
int(* CustomOpCreateFunc)(const char *, int, unsigned **, const int *, const int *, struct MXCallbackList *, void *)
Definition: c_api.h:190
MXNET_DLL int MXEnginePushAsync(EngineAsyncFunc async_func, void *func_param, EngineFuncParamDeleter deleter, ContextHandle ctx_handle, EngineVarHandle const_vars_handle, int num_const_vars, EngineVarHandle mutable_vars_handle, int num_mutable_vars, EngineFnPropertyHandle prop_handle DEFAULT(NULL), int priority DEFAULT(0), const char *opr_name DEFAULT(NULL), bool wait DEFAULT(false))
Push an asynchronous operation to the engine.
int(* CustomOpFBFunc)(int, void **, int *, const int *, const int, void *)
Definition: c_api.h:174
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:124
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:157
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:168
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:139
Definition: c_api.h:161
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
void(* EngineSyncFunc)(void *, void *)
Engine synchronous operation.
Definition: c_api.h:108
MXNET_DLL int MXAutogradIsRecording(bool *curr)
get whether autograd recording is on
Definition: c_api.h:201
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:194
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:204
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.
void(* EngineAsyncFunc)(void *, void *, void *)
Engine asynchronous operation.
Definition: c_api.h:106
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:151
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:118
void * ProfileHandle
handle to a Profile object (domain, duration, counter, etc.)
Definition: c_api.h:95
void * EngineVarHandle
handle to Engine VarHandle
Definition: c_api.h:103
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:125
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:2146
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
void(* EngineFuncParamDeleter)(void *)
Callback to free the param for EngineAsyncFunc/EngineSyncFunc.
Definition: c_api.h:110
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:187
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:163
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:117
int(* CustomOpInferStorageTypeFunc)(int, int *, void *)
Definition: c_api.h:181
Definition: c_api.h:148
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:115
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:119
Definition: c_api.h:164
Definition: c_api.h:167
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:179
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:178
MXNET_DLL int MXGetGPUMemoryInformation(int dev, int *free_mem, int *total_mem)
get the free and total available memory on a GPU Note: Deprecated, use MXGetGPUMemoryInformation64 in...
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