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

Updated docs for randint operator #13541

Merged
merged 5 commits into from
Dec 6, 2018
Merged

Updated docs for randint operator #13541

merged 5 commits into from
Dec 6, 2018

Conversation

ChaiBapchya
Copy link
Contributor

@ChaiBapchya ChaiBapchya commented Dec 4, 2018 •
edited
Loading

Description

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

aaronmarkham
aaronmarkham suggested changes Dec 5, 2018
View reviewed changes
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

docs/api/python/ndarray/ndarray.md Outdated Show resolved Hide resolved
docs/api/python/ndarray/random.md Show resolved Hide resolved
docs/api/python/symbol/random.md Show resolved Hide resolved
docs/api/python/symbol/symbol.md Outdated Show resolved Hide resolved
anirudh2290
anirudh2290 reviewed Dec 5, 2018
View reviewed changes
Copy link
Member

@anirudh2290 anirudh2290 left a comment •
edited
Loading

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
Revert "Updated docs for randint operator (#13541)"
61a0b69 
This reverts commit e0ff3c3.
TaoLv added a commit that referenced this pull request Dec 6, 2018
@TaoLv
Revert "Bumped minor version from 1.4.0 to 1.5.0 on master, updated L…
29885c5 
…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.
zhaoyao73 pushed a commit to zhaoyao73/incubator-mxnet that referenced this pull request Dec 13, 2018
@ChaiBapchya @zhaoyao73
Updated docs for randint operator (apache#13541)
2cc1267 
* updated docs for randint

* added randint in __all__ and reordered acc to categorical then alphabetical

* Trigger CI

* minus mxnet.symbol and alphabetical for ndarray,symbol.md

* alphabetical order
zhaoyao73 pushed a commit to zhaoyao73/incubator-mxnet that referenced this pull request Dec 13, 2018
@TaoLv @zhaoyao73
Revert "Bumped minor version from 1.4.0 to 1.5.0 on master, updated L…
ad7ba29 
…icense file" (apache#13558)

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

This reverts commit cf6e8cb.

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

This reverts commit e0ff3c3.

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

This reverts commit 8bbac82.

* Revert "Fix apache#13521 (apache#13537)"

This reverts commit f6b4665.

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

This reverts commit f6f8401.

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

This reverts commit bd8e0f8.

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

This reverts commit 1c8972c.

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

This reverts commit cb0db29.

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

This reverts commit 40db619.
zhaoyao73 added a commit to zhaoyao73/incubator-mxnet that referenced this pull request Dec 13, 2018
@zhaoyao73
Merge remote-tracking branch 'upstream/master'
79de25d 
* upstream/master: (54 commits)
  Add notes about debug with libstdc++ symbols (apache#13533)
  add cpp example inception to nightly test (apache#13534)
  Fix exception handling api doc (apache#13519)
  fix link for gluon model zoo (apache#13583)
  ONNX import/export: Size (apache#13112)
  Update MXNetTutorialTemplate.ipynb (apache#13568)
  fix the situation where idx didn't align with rec (apache#13550)
  Fix use-before-assignment in convert_dot (apache#13511)
  License update  (apache#13565)
  Update version to v1.5.0 including clojure package (apache#13566)
  Fix flaky test test_random:test_randint_generator (apache#13498)
  Add workspace cleaning after job finished (apache#13490)
  Adding test for softmaxoutput (apache#13116)
  apache#13441 [Clojure] Add Spec Validations for the Random namespace (apache#13523)
  Revert "Bumped minor version from 1.4.0 to 1.5.0 on master, updated License file" (apache#13558)
  Chi_square_check for discrete distribution fix (apache#13543)
  Updated docs for randint operator (apache#13541)
  Simplifications and some fun stuff for the MNIST Gluon tutorial (apache#13094)
  Fix apache#13521 (apache#13537)
  Add a retry to qemu_provision (apache#13551)
  ...
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@anirudh2290 anirudh2290 anirudh2290 left review comments

@aaronmarkham aaronmarkham aaronmarkham approved these changes

@szha szha Awaiting requested review from szha szha is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ChaiBapchya @aaronmarkham @anirudh2290