Update documentation for mxnet.ndarray.GridGenerator. #6430

indhub · 2017-05-24T20:56:55Z

@mli, @zackchase, @madjam, @nswamy, @Roshrini, @jiajiechen, @piiswrong
Please review and merge.

@Lyken17

piiswrong · 2017-05-25T00:49:13Z

python/mxnet/ndarray_doc.py

+    >>> data =  mx.nd.array(np.ones((1,2,4,4)) * 1)
+    >>> res = mx.ndarray.GridGenerator(data, "warp")
+    >>> print(res.asnumpy())
+    [[[[-0.33333331  0.33333337  1.          1.66666675]


These looks ugly. 0.5 steps would look better. It's also too big.

Plus this should go into cpp docs since its not specific to python. Use the cpp doc formatting.

Can you please let me know how to make it 0.5 step? @Lyken17

Hi @indhub
Modify data = mx.nd.array(np.ones((1,2,4,4)) * 1) to data = mx.nd.array(np.ones((1,2,5,5)) * 1)

@piiswrong feels the example is feeding arbitrary input to the op and printing random values and therefore doesn't add much value to the explanation.

piiswrong · 2017-05-25T00:49:54Z

src/operator/grid_generator-inl.h

    DMLC_DECLARE_FIELD(target_shape).set_default(TShape(shape, shape + 2))
-    .describe("if transformation type is affine, the operator need a target_shape : (H, W)\n    "
-              "if transofrmation type is warp, the operator will ignore target_shape");
+    .describe("Specifies the output shape. This is required when "


This is even less descriptive than the original sentenc.e

piiswrong · 2017-05-25T00:50:18Z

src/operator/grid_generator-inl.h

-    .describe("transformation type\n    "
-              "if transformation type is affine, data is affine matrix : (batch, 6)\n    "
-              "if transformation type is warp, data is optical flow : (batch, 2, h, w)");
+    .describe("The type of transformation. For `affine`, input data should be an affine matrix "


This is still hard to understand. What's affine matrix? what's optical flow?

I here assume reader has backgrounds about common matrices.
I will attach more description for affine transform , but as for optical flow, detailed explanation can take pages, personally prefer a link to wiki.

piiswrong · 2017-05-25T00:50:49Z

src/operator/grid_generator.cc

 .add_arguments(GridGeneratorParam::__FIELDS__())
-.describe("Generates sampling grid for bilinear sampling.");
+.describe("Generates 2D sampling grid for bilinear sampling.");


Explain more. Link to the paper. explain what this op is for & how it should be used.

@Lyken17

* Update documentation for mxnet.ndarray.GridGenerator. Thanks @Lyken17 for apache#6147 * Fix lint error. * Minor fix. * Remove the example.

@Lyken17

…hnorm (#6411) * Add channel_axis to batch norm, performance improvements * rearrange tests a bit * rearrange tests a bit * CR changes * cpp package link issue * Fix: MSVC wants all parallel omp to be int * CR comments, expand legal negative axes * lint * lint * Fix download link (#6431) * Fix Download Button * Small fix * Add release note (#6434) * Fixing tutorials. (#6436) Most of the fixes should be self evident. For tutorial on pre-trained models, one of the images doesn't exist anymore so selected a new one. Long-term, we should put such images on web-data repo but alas, some other day. For Handwritten digit tutorial, we are missing couple of imports in the test_utils.py that was recently created. Note that: for pre-trained model tutorial, we get a softmax_label warning and the probability scores are not really probabilities. Will deal with that issue in another PR. Testing: I've tried to test all the notebooks with this change and things look fine. * Formatting fixes (#6433) * Formatting fixes * lint fixed * fix * doc bash 2-5, for pack, unpack, pack_img and unpack_img (#6140) * doc bash for pack, unpack, pack_img and unpack_img * Add comments for labels could be 1d list * Update recordio.py * Update recordio.py * Update recordio.py fixing text * Update recordio.py fixing text * remove empty line * Improve style (#6445) * Correction (#6444) * CSVIter example correction * fix * Update documentation for MXNetDataIter in io.py (#6000) (#6113) * Update documentation for MXNetDataIter in io.py (#6000) * [DOC] Respond to feedback (#6113) * Fix minor issues with api pages. (#6410) 1. In the notes section for ndarray, references did not seem clear enough to be referring to mxnet.ndarray or numpy.ndarray. Added the package names as prefixes to make it more obvious. 2. "share the same C++ operator source codes" => "share the same code". Since we don't really need to throw in more details than required. 3. Other relatively minor language changes which will be obvious from the diff. Note that I'm relatively not sure about the need for 1/ since it makes things more verbose. Let me know if it unnecessary and I'll remove it. * fixing the early stop for maximize = T (#5915) close #4587 * Update documentation for mxnet.ndarray.GridGenerator. (#6430) * Update documentation for mxnet.ndarray.GridGenerator. Thanks @Lyken17 for #6147 * Fix lint error. * Minor fix. * Remove the example. * Update documentation for deconvolution operation. (#6184) * Update documentation for deconvolution operation. * Add examples. * Remove the example. * skip lines that have %matplotlib (#6451) * Fixing some more broken links before v0.10 release (#6449) * close #4838 (#6452) * Fix linear regression (#6432) * Fix Linear Regression Tutorial * Small fix * Pre-trained model tutorial fixes. (#6453) Before the change on running the tutorial for the first time: "UserWarning: Data provided by label_shapes don't match names specified by label_names ([] vs. ['softmax_label'])". It also showed probability of >>1 due to incorrect usage of np.argsort(). * Nightly test tutorial (#6447) * Add tutorial test * Fix pylint * Small fix * fix member variable name: make them end with underline (#6438) * [R] captcha example (#6443) * skip lines that have %matplotlib (#6459) * Fix cudnn_deconv not guarding no_bias (#6456) * Fixing up issues in install guide (#6463) * Fixing copy code functionality for bash command (#6465) * Residual unroll (#6397) * residual unroll * unroll for residual cell * merge_outputs fix * Linear regression Tutorial link (#6468) * Fixing a link in the linear regression tutorial. The link was initally going to mxnet-test.readthedocs.io. Changed it to mxnet.io/api. * More appropriate language. * bump up version number for release (#6462) * bump up version number for release * update version for scala/R/backend * [R][DOC] update R installation guide (#6457) * Use sphinx==1.3.5 in Dockerfile.doc (#6470) changed PR name * Add 0.10 release info to README.md and NEWS.md (#6471) @nswamy wants to merge it immediately, so i'm going to do it now. I also changed the PR title. * fix batchNorm cpp example (#6454) * Update im2rec.py (#6473) Updated Line 107 of 'im2rec.py'. Read an image as binary. * Change Interface of NDArray & TBlob for DLPack Compatible (#6345) * Change Interface of NDArray & TBlob for DLPack Compatible Fix for cudnn operator Fix cpp tests * Update nnvm * Fix for MKL mem * Fix for windows macro * Bump up version number to 0.10.1 * Update NDArray Save&Load * trigger update * Add test for legacy data load * Use LegacyTShapeLoad * trigger update * Update tensor_blob.h * change 'channel_axis' parameter to 'axis' * Change DEFAULT_CHANNEL_AXIS to DEFAULT_AXIS * wait for dlpack PR to go through * Trigger build

@Lyken17

* Update documentation for mxnet.ndarray.GridGenerator. Thanks @Lyken17 for apache#6147 * Fix lint error. * Minor fix. * Remove the example.

@Lyken17

…hnorm (apache#6411) * Add channel_axis to batch norm, performance improvements * rearrange tests a bit * rearrange tests a bit * CR changes * cpp package link issue * Fix: MSVC wants all parallel omp to be int * CR comments, expand legal negative axes * lint * lint * Fix download link (apache#6431) * Fix Download Button * Small fix * Add release note (apache#6434) * Fixing tutorials. (apache#6436) Most of the fixes should be self evident. For tutorial on pre-trained models, one of the images doesn't exist anymore so selected a new one. Long-term, we should put such images on web-data repo but alas, some other day. For Handwritten digit tutorial, we are missing couple of imports in the test_utils.py that was recently created. Note that: for pre-trained model tutorial, we get a softmax_label warning and the probability scores are not really probabilities. Will deal with that issue in another PR. Testing: I've tried to test all the notebooks with this change and things look fine. * Formatting fixes (apache#6433) * Formatting fixes * lint fixed * fix * doc bash 2-5, for pack, unpack, pack_img and unpack_img (apache#6140) * doc bash for pack, unpack, pack_img and unpack_img * Add comments for labels could be 1d list * Update recordio.py * Update recordio.py * Update recordio.py fixing text * Update recordio.py fixing text * remove empty line * Improve style (apache#6445) * Correction (apache#6444) * CSVIter example correction * fix * Update documentation for MXNetDataIter in io.py (apache#6000) (apache#6113) * Update documentation for MXNetDataIter in io.py (apache#6000) * [DOC] Respond to feedback (apache#6113) * Fix minor issues with api pages. (apache#6410) 1. In the notes section for ndarray, references did not seem clear enough to be referring to mxnet.ndarray or numpy.ndarray. Added the package names as prefixes to make it more obvious. 2. "share the same C++ operator source codes" => "share the same code". Since we don't really need to throw in more details than required. 3. Other relatively minor language changes which will be obvious from the diff. Note that I'm relatively not sure about the need for 1/ since it makes things more verbose. Let me know if it unnecessary and I'll remove it. * fixing the early stop for maximize = T (apache#5915) close apache#4587 * Update documentation for mxnet.ndarray.GridGenerator. (apache#6430) * Update documentation for mxnet.ndarray.GridGenerator. Thanks @Lyken17 for apache#6147 * Fix lint error. * Minor fix. * Remove the example. * Update documentation for deconvolution operation. (apache#6184) * Update documentation for deconvolution operation. * Add examples. * Remove the example. * skip lines that have %matplotlib (apache#6451) * Fixing some more broken links before v0.10 release (apache#6449) * close apache#4838 (apache#6452) * Fix linear regression (apache#6432) * Fix Linear Regression Tutorial * Small fix * Pre-trained model tutorial fixes. (apache#6453) Before the change on running the tutorial for the first time: "UserWarning: Data provided by label_shapes don't match names specified by label_names ([] vs. ['softmax_label'])". It also showed probability of >>1 due to incorrect usage of np.argsort(). * Nightly test tutorial (apache#6447) * Add tutorial test * Fix pylint * Small fix * fix member variable name: make them end with underline (apache#6438) * [R] captcha example (apache#6443) * skip lines that have %matplotlib (apache#6459) * Fix cudnn_deconv not guarding no_bias (apache#6456) * Fixing up issues in install guide (apache#6463) * Fixing copy code functionality for bash command (apache#6465) * Residual unroll (apache#6397) * residual unroll * unroll for residual cell * merge_outputs fix * Linear regression Tutorial link (apache#6468) * Fixing a link in the linear regression tutorial. The link was initally going to mxnet-test.readthedocs.io. Changed it to mxnet.io/api. * More appropriate language. * bump up version number for release (apache#6462) * bump up version number for release * update version for scala/R/backend * [R][DOC] update R installation guide (apache#6457) * Use sphinx==1.3.5 in Dockerfile.doc (apache#6470) changed PR name * Add 0.10 release info to README.md and NEWS.md (apache#6471) @nswamy wants to merge it immediately, so i'm going to do it now. I also changed the PR title. * fix batchNorm cpp example (apache#6454) * Update im2rec.py (apache#6473) Updated Line 107 of 'im2rec.py'. Read an image as binary. * Change Interface of NDArray & TBlob for DLPack Compatible (apache#6345) * Change Interface of NDArray & TBlob for DLPack Compatible Fix for cudnn operator Fix cpp tests * Update nnvm * Fix for MKL mem * Fix for windows macro * Bump up version number to 0.10.1 * Update NDArray Save&Load * trigger update * Add test for legacy data load * Use LegacyTShapeLoad * trigger update * Update tensor_blob.h * change 'channel_axis' parameter to 'axis' * Change DEFAULT_CHANNEL_AXIS to DEFAULT_AXIS * wait for dlpack PR to go through * Trigger build

indhub added 2 commits May 24, 2017 13:55

Update documentation for mxnet.ndarray.GridGenerator.

a2f1a07

Thanks @Lyken17 for #6147

Fix lint error.

c5e1acd

piiswrong reviewed May 25, 2017

View reviewed changes

indhub added 2 commits May 25, 2017 13:09

Minor fix.

1c5e738

Remove the example.

32eba0a

piiswrong merged commit 5f625f2 into apache:master May 25, 2017

indhub deleted the doc/gridgenerator branch June 2, 2017 18:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update documentation for mxnet.ndarray.GridGenerator. #6430

Update documentation for mxnet.ndarray.GridGenerator. #6430

indhub commented May 24, 2017 •

edited

Loading

piiswrong May 25, 2017

indhub May 25, 2017 •

edited

Loading

Lyken17 May 25, 2017

indhub May 25, 2017 •

edited

Loading

piiswrong May 25, 2017

piiswrong May 25, 2017

Lyken17 May 25, 2017 •

edited

Loading

piiswrong May 25, 2017

Update documentation for mxnet.ndarray.GridGenerator. #6430

Update documentation for mxnet.ndarray.GridGenerator. #6430

Conversation

indhub commented May 24, 2017 • edited Loading

piiswrong May 25, 2017

Choose a reason for hiding this comment

indhub May 25, 2017 • edited Loading

Choose a reason for hiding this comment

Lyken17 May 25, 2017

Choose a reason for hiding this comment

indhub May 25, 2017 • edited Loading

Choose a reason for hiding this comment

piiswrong May 25, 2017

Choose a reason for hiding this comment

piiswrong May 25, 2017

Choose a reason for hiding this comment

Lyken17 May 25, 2017 • edited Loading

Choose a reason for hiding this comment

piiswrong May 25, 2017

Choose a reason for hiding this comment

indhub commented May 24, 2017 •

edited

Loading

indhub May 25, 2017 •

edited

Loading

indhub May 25, 2017 •

edited

Loading

Lyken17 May 25, 2017 •

edited

Loading