adding docs for 64bit C APIs of large tensor and removing not required int64 C APIs #17309
Conversation
access2rohit
requested review from
anirudh2290 and
eric-haibin-lin
as code owners
|
@mxnet-label-bot add [pr-awaiting-review] |
|
@apeforest @ChaiBapchya PR ready for review |
| @@ -585,6 +585,8 @@ MXNET_DLL int MXNDArrayCreate(const uint32_t *shape, | |||
|
|
|||
| /*! | |||
| * \brief create a NDArray with specified shape and data type | |||
| * This api is available when MXNet is built with flag | |||
| * USE_INT64_TENSOR_SIZE=0 (by default) | |||
There was a problem hiding this comment.
I think instead of adding the comment, we should just error out from the API when the incorrect flags are used with API.
There was a problem hiding this comment.
There already is a functionality to throw error messages when usage is of large tensor and mxnet is not built with USE_INT64_TENSOR_SIZE=1. This is a documentation for devs to help them decide which one to choose.
| * \param out_shape_size sizeof the returning array of out_shapes | ||
| * \param out_shape_ndim returning array of shape dimensions of eachs input shape. | ||
| * \param out_shape_data returning array of pointers to head of the input shape. | ||
| * \param aux_shape_size sizeof the returning array of aux_shapes |
There was a problem hiding this comment.
| * \param aux_shape_size sizeof the returning array of aux_shapes | |
| * \param aux_shape_size size of the returning array of aux_shapes |
There was a problem hiding this comment.
addressed all comments. sizeof can also be also thought of as a function, which I think is fine. So, decided to keep it that way. Let me know if its important to make it "size of". I don't have any strong opinion on keeping it "sizeof"
access2rohit
force-pushed
the
docs_for_64bit
branch
from
beecdcf
to
06d139c
Compare
access2rohit
force-pushed
the
docs_for_64bit
branch
from
06d139c
to
de9d063
Compare
|
@access2rohit @apeforest could you help clarify which version the *64 APIs were first introduced? If they appeared in the past versions before, then this change cannot be merged into 1.7.x (#16864) |
|
I think the *64APIs were introduce in 1.6. @access2rohit Please confirm. Thanks. |
Correct ! |
Description
adding docs for 64bit C APIs of large tensor and removing not required int64 C APIs:
MXNDArrayGetShape64
MXSymbolInferShape64
MXSymbolInferShapePartial64
Checklist
Essentials
Please feel free to remove inapplicable items for your PR.