Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

Commit

Permalink
Add API docs to INT64 APIs (#16617)
Browse files Browse the repository at this point in the history
* add api

* make doc compatible with c_api.h INT64 docs
  • Loading branch information
ChaiBapchya authored and apeforest committed Jan 22, 2020
1 parent 3de5cae commit 32d3bd8
Showing 1 changed file with 84 additions and 0 deletions.
84 changes: 84 additions & 0 deletions src/c_api/c_api_symbolic.cc
Original file line number Diff line number Diff line change
Expand Up @@ -692,6 +692,27 @@ inline void SymbolInferShape(const char** keys,
*complete = (g.GetAttr<size_t>("shape_num_unknown_nodes") == 0);
}

/*!
* \brief Executor for Symbol Shape Inference
* This api is available when MXNet is built with flag
* USE_INT64_TENSOR_SIZE=0 (by default)
* \param sym symbol handle
* \param num_args number of args
* \param keys keys
* \param arg_ind_ptr arg index pointer
* \param arg_shape_data arg shape data
* \param in_shape_size input shape size
* \param in_shape_ndim input shape number of dims
* \param in_shape_data input shape data
* \param out_shape_size ouput shape size
* \param out_shape_ndim output shape number of dims
* \param out_shape_data output shape data
* \param aux_shape_size shape size of auxiliary states
* \param aux_shape_ndim number of dims of auxiliary states shape
* \param aux_shape_data shape data of auxiliary states
* \param complete indicates completion of Shape Inference
* \return 0 when success, -1 when failure happens
*/
int MXSymbolInferShapeEx(SymbolHandle sym,
uint32_t num_args,
const char** keys,
Expand Down Expand Up @@ -729,6 +750,27 @@ int MXSymbolInferShapeEx(SymbolHandle sym,
API_END();
}

/*!
* \brief Executor for Symbol Shape Inference
* This api is available when MXNet is built with flag
* USE_INT64_TENSOR_SIZE=1 (not default) i.e. Large Tensor Support
* \param sym symbol handle
* \param num_args number of args
* \param keys keys
* \param arg_ind_ptr arg index pointer
* \param arg_shape_data arg shape data
* \param in_shape_size input shape size
* \param in_shape_ndim input shape number of dims
* \param in_shape_data input shape data
* \param out_shape_size ouput shape size
* \param out_shape_ndim output shape number of dims
* \param out_shape_data output shape data
* \param aux_shape_size shape size of auxiliary states
* \param aux_shape_ndim number of dims of auxiliary states shape
* \param aux_shape_data shape data of auxiliary states
* \param complete indicates completion of Shape Inference
* \return 0 when success, -1 when failure happens
*/
int MXSymbolInferShapeEx64(SymbolHandle sym,
uint32_t num_args,
const char** keys,
Expand Down Expand Up @@ -791,6 +833,27 @@ int MXSymbolInferShapePartial(SymbolHandle sym,
&succ);
}

/*!
* \brief Executor for Symbol Partial Shape Inference
* This api is available when MXNet is built with flag
* USE_INT64_TENSOR_SIZE=0 (by default)
* \param sym symbol handle
* \param num_args number of args
* \param keys keys
* \param arg_ind_ptr arg index pointer
* \param arg_shape_data arg shape data
* \param in_shape_size input shape size
* \param in_shape_ndim input shape number of dims
* \param in_shape_data input shape data
* \param out_shape_size ouput shape size
* \param out_shape_ndim output shape number of dims
* \param out_shape_data output shape data
* \param aux_shape_size shape size of auxiliary states
* \param aux_shape_ndim number of dims of auxiliary states shape
* \param aux_shape_data shape data of auxiliary states
* \param complete indicates completion of Shape Inference
* \return 0 when success, -1 when failure happens
*/
int MXSymbolInferShapePartialEx(SymbolHandle sym,
uint32_t num_args,
const char** keys,
Expand All @@ -816,6 +879,27 @@ int MXSymbolInferShapePartialEx(SymbolHandle sym,
&succ);
}

/*!
* \brief Executor for Symbol Partial Shape Inference
* This api is available when MXNet is built with flag
* USE_INT64_TENSOR_SIZE=1 (not default) i.e. Large Tensor Support
* \param sym symbol handle
* \param num_args number of args
* \param keys keys
* \param arg_ind_ptr arg index pointer
* \param arg_shape_data arg shape data
* \param in_shape_size input shape size
* \param in_shape_ndim input shape number of dims
* \param in_shape_data input shape data
* \param out_shape_size ouput shape size
* \param out_shape_ndim output shape number of dims
* \param out_shape_data output shape data
* \param aux_shape_size shape size of auxiliary states
* \param aux_shape_ndim number of dims of auxiliary states shape
* \param aux_shape_data shape data of auxiliary states
* \param complete indicates completion of Shape Inference
* \return 0 when success, -1 when failure happens
*/
int MXSymbolInferShapePartialEx64(SymbolHandle sym,
uint32_t num_args,
const char** keys,
Expand Down

0 comments on commit 32d3bd8

Please sign in to comment.