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

Conversation

@ChaiBapchya
Copy link
Contributor

@ChaiBapchya ChaiBapchya commented Dec 4, 2018

Description

Updated the docs to reflect randint operator
Added for both NDArray and Symbol API (RandomNumberGenerator API)

@ChaiBapchya ChaiBapchya requested a review from szha as a code owner December 4, 2018 23:00
Copy link
Contributor

@aaronmarkham aaronmarkham left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please try to keep the API references in categorical then alphabetical order.
Also, a description is needed in your PR's main comment.

Once your PR gets through CI, use the preview link template as a guide for providing links to each update so it is easier to review.

For example, http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-13541/1/api/python/ndarray/ndarray.html#random-sampling

Copy link
Member

@anirudh2290 anirudh2290 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can test the docs here: http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-13541/1 . Looks like the docs for mx.nd.random.randint are not generated. Please check if randint is added to the __all__ list.

@aaronmarkham
Copy link
Contributor

Here's the current output at: http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-13541/3/api/python/ndarray/ndarray.html#random-sampling

2018-12-05_10-16-35

First thing I'm noticing is that you probably could have it showing minus mxnet.ndarray so each entry is like random.x. Note how the other sections are like this.

I see that mxnet.random.seed is different and not part of ndarray, so it make sense to have the full name.

Then within this Random Sampling category, the entries should be alphabetical. Rooting around in a long list for the function you want is difficult when it isn't alphabetical.

@aaronmarkham aaronmarkham merged commit e0ff3c3 into apache:master Dec 6, 2018
TaoLv added a commit that referenced this pull request Dec 6, 2018
TaoLv added a commit that referenced this pull request Dec 6, 2018
…icense file" (#13558)

* Revert "Chi_square_check for discrete distribution fix (#13543)"

This reverts commit cf6e8cb.

* Revert "Updated docs for randint operator (#13541)"

This reverts commit e0ff3c3.

* Revert "Simplifications and some fun stuff for the MNIST Gluon tutorial (#13094)"

This reverts commit 8bbac82.

* Revert "Fix #13521 (#13537)"

This reverts commit f6b4665.

* Revert "Add a retry to qemu_provision (#13551)"

This reverts commit f6f8401.

* Revert "[MXNET-769] Use MXNET_HOME in a tempdir in windows to prevent access denied due t… (#13531)"

This reverts commit bd8e0f8.

* Revert "[MXNET-1249] Fix Object Detector Performance with GPU (#13522)"

This reverts commit 1c8972c.

* Revert "Fixing a 404 in the ubuntu setup doc (#13542)"

This reverts commit cb0db29.

* Revert "Bumped minor version from 1.4.0 to 1.5.0 on master, updated License file (#13478)"

This reverts commit 40db619.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants