[GitHub] [incubator-mxnet] reminisce opened a new pull request #16305: [numpy] Cosmetic improvement on mxnet.numpy builtin op signature in documentation

[GitBox <gi...@apache.org>]

reminisce opened a new pull request #16305: [numpy] Cosmetic improvement on mxnet.numpy builtin op signature in documentation
URL: https://github.com/apache/incubator-mxnet/pull/16305
 
 
   ## Description ##
   There is a subset of operators exposed to Python frontend with MXNet auto-generated APIs. This had resulted in inconsistent signature appearance in the documentation with the official NumPy package which is not desirable. For example:
   ```python
   >>> from mxnet import np
   >>> help(np.sum)
   sum(a=None, axis=_Null, dtype=_Null, keepdims=_Null, initial=_Null, out=None, name=None, **kwargs)
   ```
   
   This PR has addressed this issue by replacing those ops' `__signature__` field using the signatures from the documentation file: `_numpy_op_doc.py`. For example:
   ```python
   >>> from mxnet import np
   >>> help(np.sum)
   sum(a, axis=None, dtype=None, keepdims=False, initial=None, out=None)
   ```
   
   ## Checklist ##
   ### Essentials ###
   Please feel free to remove inapplicable items for your PR.
   - [ ] The PR title starts with [MXNET-$JIRA_ID], where $JIRA_ID refers to the relevant [JIRA issue](https://issues.apache.org/jira/projects/MXNET/issues) created (except PRs with tiny changes)
   - [x] Changes are complete (i.e. I finished coding on this PR)
   - [x] All changes have test coverage:
   - Unit tests are added for small changes to verify correctness (e.g. adding a new operator)
   - Nightly tests are added for complicated/long-running ones (e.g. changing distributed kvstore)
   - Build tests will be added for build configuration changes (e.g. adding a new build option with NCCL)
   - [x] Code is well-documented: 
   - For user-facing API changes, API doc string has been updated. 
   - For new C++ functions in header files, their functionalities and arguments are documented. 
   - For new examples, README.md is added to explain the what the example does, the source of the dataset, expected performance on test set and reference to the original paper if applicable
   - Check the API doc at https://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-$PR_ID/$BUILD_ID/index.html
   - [x] To the my best knowledge, examples are either not affected by this change, or have been fixed to be compatible with this change

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services