mxnet
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
c_predict_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 
26 #ifndef MXNET_C_PREDICT_API_H_
27 #define MXNET_C_PREDICT_API_H_
28 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif // __cplusplus
33 
34 #ifdef _WIN32
35 #ifdef MXNET_EXPORTS
36 #define MXNET_DLL __declspec(dllexport)
37 #else
38 #define MXNET_DLL __declspec(dllimport)
39 #endif
40 #else
41 #define MXNET_DLL
42 #endif
43 
45 typedef unsigned int mx_uint;
47 typedef float mx_float;
49 typedef void *PredictorHandle;
51 typedef void *NDListHandle;
52 
57 MXNET_DLL const char* MXGetLastError();
58 
78 MXNET_DLL int MXPredCreate(const char* symbol_json_str,
79  const void* param_bytes,
80  int param_size,
81  int dev_type, int dev_id,
82  mx_uint num_input_nodes,
83  const char** input_keys,
84  const mx_uint* input_shape_indptr,
85  const mx_uint* input_shape_data,
86  PredictorHandle* out);
87 
111 MXNET_DLL int MXPredCreatePartialOut(const char* symbol_json_str,
112  const void* param_bytes,
113  int param_size,
114  int dev_type, int dev_id,
115  mx_uint num_input_nodes,
116  const char** input_keys,
117  const mx_uint* input_shape_indptr,
118  const mx_uint* input_shape_data,
119  mx_uint num_output_nodes,
120  const char** output_keys,
121  PredictorHandle* out);
131 MXNET_DLL int MXPredGetOutputShape(PredictorHandle handle,
132  mx_uint index,
133  mx_uint** shape_data,
134  mx_uint* shape_ndim);
144 MXNET_DLL int MXPredSetInput(PredictorHandle handle,
145  const char* key,
146  const mx_float* data,
147  mx_uint size);
153 MXNET_DLL int MXPredForward(PredictorHandle handle);
170 MXNET_DLL int MXPredPartialForward(PredictorHandle handle, int step, int* step_left);
179 MXNET_DLL int MXPredGetOutput(PredictorHandle handle,
180  mx_uint index,
181  mx_float* data,
182  mx_uint size);
188 MXNET_DLL int MXPredFree(PredictorHandle handle);
198 MXNET_DLL int MXNDListCreate(const char* nd_file_bytes,
199  int nd_file_size,
200  NDListHandle *out,
201  mx_uint* out_length);
212 MXNET_DLL int MXNDListGet(NDListHandle handle,
213  mx_uint index,
214  const char** out_key,
215  const mx_float** out_data,
216  const mx_uint** out_shape,
217  mx_uint* out_ndim);
223 MXNET_DLL int MXNDListFree(NDListHandle handle);
224 
225 #ifdef __cplusplus
226 }
227 #endif // __cplusplus
228 
229 #endif // MXNET_C_PREDICT_API_H_
MXNET_DLL int MXPredForward(PredictorHandle handle)
Run a forward pass to get the output.
MXNET_DLL int MXNDListCreate(const char *nd_file_bytes, int nd_file_size, NDListHandle *out, mx_uint *out_length)
Create a NDArray List by loading from ndarray file. This can be used to load mean image file...
MXNET_DLL int MXPredSetInput(PredictorHandle handle, const char *key, const mx_float *data, mx_uint size)
Set the input data of predictor.
MXNET_DLL int MXPredCreatePartialOut(const char *symbol_json_str, const void *param_bytes, int param_size, int dev_type, int dev_id, mx_uint num_input_nodes, const char **input_keys, const mx_uint *input_shape_indptr, const mx_uint *input_shape_data, mx_uint num_output_nodes, const char **output_keys, PredictorHandle *out)
create a predictor wich customized outputs
MXNET_DLL int MXNDListFree(NDListHandle handle)
Free a MXAPINDList.
void * PredictorHandle
handle to Predictor
Definition: c_predict_api.h:49
MXNET_DLL int MXPredFree(PredictorHandle handle)
Free a predictor handle.
unsigned int mx_uint
manually define unsigned int
Definition: c_predict_api.h:45
float mx_float
manually define float
Definition: c_predict_api.h:47
void * NDListHandle
handle to NDArray list
Definition: c_predict_api.h:51
MXNET_DLL const char * MXGetLastError()
Get the last error happeneed.
MXNET_DLL int MXPredGetOutputShape(PredictorHandle handle, mx_uint index, mx_uint **shape_data, mx_uint *shape_ndim)
Get the shape of output node. The returned shape_data and shape_ndim is only valid before next call t...
MXNET_DLL int MXPredCreate(const char *symbol_json_str, const void *param_bytes, int param_size, int dev_type, int dev_id, mx_uint num_input_nodes, const char **input_keys, const mx_uint *input_shape_indptr, const mx_uint *input_shape_data, PredictorHandle *out)
create a predictor
#define MXNET_DLL
Inhibit C++ name-mangling for MXNet functions.
Definition: c_predict_api.h:41
MXNET_DLL int MXPredPartialForward(PredictorHandle handle, int step, int *step_left)
Run a interactive forward pass to get the output. This is helpful for displaying progress of predicti...
MXNET_DLL int MXPredGetOutput(PredictorHandle handle, mx_uint index, mx_float *data, mx_uint size)
Get the output value of prediction.
MXNET_DLL int MXNDListGet(NDListHandle handle, mx_uint index, const char **out_key, const mx_float **out_data, const mx_uint **out_shape, mx_uint *out_ndim)
Get an element from list.