Docs for MXRecordIO, MXIndexedRecordIO modified #6013

Roshrini · 2017-04-27T20:44:19Z

@mli @zackchase @madjam @nswamy @indhub @jiajiechen Please take a look.

madjam · 2017-04-27T20:58:51Z

python/mxnet/recordio.py

        assert not self.writable
        pos = ctypes.c_size_t(self.idx[idx])
        check_call(_LIB.MXRecordIOReaderSeek(self.handle, pos))

    def tell(self):
-        """Query current write head position."""
+        """Queries current writer pointer position and returns it.


Suggest rewording it as:
"Returns the current position of write head."

madjam · 2017-04-27T21:01:01Z

python/mxnet/recordio.py

        assert self.writable
        pos = ctypes.c_size_t()
        check_call(_LIB.MXRecordIOWriterTell(self.handle, ctypes.byref(pos)))
        return pos.value

    def read_idx(self, idx):
-        """Read record with index."""
+        """Reads the record on the given index and returns it.


Suggest rewording as:
"Returns record at given index."

madjam · 2017-04-27T21:01:47Z

python/mxnet/recordio.py

        self.seek(idx)
        return self.read()

    def write_idx(self, idx, buf):
-        """Write record with index."""
+        """Writes the record on the given index.


"Inserts record at given index."

Roshrini · 2017-04-27T21:07:15Z

Fixed

piiswrong · 2017-04-27T23:37:57Z

python/mxnet/recordio.py

+
+    Example usage:
+    ----------
+    >>> record = mx.recordio.MXRecordIO('tmp.rec', 'w')


put a read/write example here.
the methods don't need to include open. Just print the result of read.

read/write example is added in the respective function. If I add it here, it might be redundant? I added whole example now so that one should able to run it.

madjam · 2017-04-27T23:39:26Z

python/mxnet/recordio.py

        if not self.is_open:
            return
        super(MXIndexedRecordIO, self).close()
        self.fidx.close()

    def seek(self, idx):
-        """Query current read head position."""
+        """Sets the current reader pointer position.


"current reader" -> read

zackchase

Hi @Roshrini , only one comment. I didn't run the example code (can you @madjam), from the language and clarity this looks like an excellent PR. Thanks!

zackchase · 2017-05-01T21:24:46Z

python/mxnet/recordio.py

        assert self.writable
        pos = ctypes.c_size_t()
        check_call(_LIB.MXRecordIOWriterTell(self.handle, ctypes.byref(pos)))
        return pos.value

    def read_idx(self, idx):
-        """Read record with index."""
+        """Returns a record at given index.


Perhaps change "a" to "the" since there is only one record at the given index. Is that right?

Roshrini · 2017-05-01T21:36:50Z

@zackchase Thanks for reviewing. Fixed it. I added examples after running them. But @madjam can run them again. Please approve and merge.

piiswrong · 2017-05-02T07:19:19Z

python/mxnet/recordio.py

+    Example usage:
+    ----------
+    >>> record = mx.recordio.MXIndexedRecordIO('tmp.idx', 'tmp.rec', 'w')
+    >>> record


remove these two lines

* docs for MXIndexedRecordIO modified * changes after review * recordIO doc modified * changes after review * lint error * minor change * minor change after review * empty commit to retrigger build * changes after review

* updated docstring for set_lr_mult and set_wd_mult * updated docstring per review * Fixed imdecode crash bug when flag=0 (#6134) * Fix (#6131) * Docs for MXRecordIO, MXIndexedRecordIO modified (#6013) * docs for MXIndexedRecordIO modified * changes after review * recordIO doc modified * changes after review * lint error * minor change * minor change after review * empty commit to retrigger build * changes after review * Update documentation for mx.callback.Speedometer. (#6058) * Update documentation for mx.callback.Speedometer. * Minor doc changes. * Use module instead of model in example code. * update doc for Load (#6092) * Installation instructions for MacOS and Cloud (#6012) * Fix NDArray bool checking (#6130) * fix shape order bug (#6136) * TOC click unfold (#6133) * [doc] new sphnix plugin (#6105) * update doc * rm * update * update ndarray * update mds * update * update * update * update * update * update * update image.md and others * update * [doc] use debug mode to build (#6151) * move ctc loss to contrib (#6154) * Fix for invalid numpy float indexing (#6144) * Fix python3 compatibilities (#6143) * [doc] small changes to tutorials (#6164) * [doc] Fix left toc link (#6162) * [example]ADD practical functions and options for speech_recognition example (#6141) * ADD practical functions and options for speech_recognition example * add missing stt_bi_graphemes_util.py and deepspeech.cfg template * Added reflection padding (#6123) * Added reflection padding * Lint fix * Added 5d reflection padding * Added failure in forward/backward for input dimensions other than 4 of 5 * Improved sanity check readability * Fixing LICENSE file and adding NOTICE (#6172) * Creating NOTICE. When code moves to Apache, it will need adjusting to the Apache format. * Replacing source header with full license text * doc improvement - softmax, metrics, and initializer (#5945) * doc improvement, softmaxoutput, initializer-constant, minor fixes * doc improvement, metrics * fix softmax doc, fix metric lint * softmax more fixes * add doc change in initializer.py. some minor fix in softmax_cross_entropy * doc change in initializer.py * fix grammer * fix * fix * fix * minor fix * fix * minor fix * DataBatch and NDArrayIter doc modified (#6091) * DataBatch and NDArrayIter doc modified * fixes after review * fixes after review * wording changed * some more fixes * improvement * desc fix * Datadesc info added * minor addition * fix * fix * fix after review * [Scala] Change version to 0.9.5-SNAPSHOT (#6173) * [scala] change version to 0.9.5-SNAPSHOT * API doc improvement Dropout and SoftmaxActivation (#6088) * doc improve for dropout oper * doc improve for SoftmaxActivation oper * fix * fix * Update documentation for mx.callback.do_checkpoint (#6059) * Update documentation for mx.callback.do_checkpoint * Use module instead of model for example code. * Update documentation for plot_graph. (#6098) * Update documentation for plot_graph. * Minor doc fix. * Restruct get started (#6167) * Change get started page * Small fix * Improve * Update documentation of Initializer.dumps() (#6128) * Doc Improvement - RMSProp and RMSPropAlex (#6107) * rmsprop * rmsprop alex * add link in optimizer.py * fix * fix * missed fix.. * Docforcs,fft,ifft (#6145) * fft.cc * add all * changed the description of set_lr_mult and set_wd_mult * Explicitly specify quiet in R install_version (#6171)

* docs for MXIndexedRecordIO modified * changes after review * recordIO doc modified * changes after review * lint error * minor change * minor change after review * empty commit to retrigger build * changes after review

* updated docstring for set_lr_mult and set_wd_mult * updated docstring per review * Fixed imdecode crash bug when flag=0 (apache#6134) * Fix (apache#6131) * Docs for MXRecordIO, MXIndexedRecordIO modified (apache#6013) * docs for MXIndexedRecordIO modified * changes after review * recordIO doc modified * changes after review * lint error * minor change * minor change after review * empty commit to retrigger build * changes after review * Update documentation for mx.callback.Speedometer. (apache#6058) * Update documentation for mx.callback.Speedometer. * Minor doc changes. * Use module instead of model in example code. * update doc for Load (apache#6092) * Installation instructions for MacOS and Cloud (apache#6012) * Fix NDArray bool checking (apache#6130) * fix shape order bug (apache#6136) * TOC click unfold (apache#6133) * [doc] new sphnix plugin (apache#6105) * update doc * rm * update * update ndarray * update mds * update * update * update * update * update * update * update image.md and others * update * [doc] use debug mode to build (apache#6151) * move ctc loss to contrib (apache#6154) * Fix for invalid numpy float indexing (apache#6144) * Fix python3 compatibilities (apache#6143) * [doc] small changes to tutorials (apache#6164) * [doc] Fix left toc link (apache#6162) * [example]ADD practical functions and options for speech_recognition example (apache#6141) * ADD practical functions and options for speech_recognition example * add missing stt_bi_graphemes_util.py and deepspeech.cfg template * Added reflection padding (apache#6123) * Added reflection padding * Lint fix * Added 5d reflection padding * Added failure in forward/backward for input dimensions other than 4 of 5 * Improved sanity check readability * Fixing LICENSE file and adding NOTICE (apache#6172) * Creating NOTICE. When code moves to Apache, it will need adjusting to the Apache format. * Replacing source header with full license text * doc improvement - softmax, metrics, and initializer (apache#5945) * doc improvement, softmaxoutput, initializer-constant, minor fixes * doc improvement, metrics * fix softmax doc, fix metric lint * softmax more fixes * add doc change in initializer.py. some minor fix in softmax_cross_entropy * doc change in initializer.py * fix grammer * fix * fix * fix * minor fix * fix * minor fix * DataBatch and NDArrayIter doc modified (apache#6091) * DataBatch and NDArrayIter doc modified * fixes after review * fixes after review * wording changed * some more fixes * improvement * desc fix * Datadesc info added * minor addition * fix * fix * fix after review * [Scala] Change version to 0.9.5-SNAPSHOT (apache#6173) * [scala] change version to 0.9.5-SNAPSHOT * API doc improvement Dropout and SoftmaxActivation (apache#6088) * doc improve for dropout oper * doc improve for SoftmaxActivation oper * fix * fix * Update documentation for mx.callback.do_checkpoint (apache#6059) * Update documentation for mx.callback.do_checkpoint * Use module instead of model for example code. * Update documentation for plot_graph. (apache#6098) * Update documentation for plot_graph. * Minor doc fix. * Restruct get started (apache#6167) * Change get started page * Small fix * Improve * Update documentation of Initializer.dumps() (apache#6128) * Doc Improvement - RMSProp and RMSPropAlex (apache#6107) * rmsprop * rmsprop alex * add link in optimizer.py * fix * fix * missed fix.. * Docforcs,fft,ifft (apache#6145) * fft.cc * add all * changed the description of set_lr_mult and set_wd_mult * Explicitly specify quiet in R install_version (apache#6171)

* docs for MXIndexedRecordIO modified * changes after review * recordIO doc modified * changes after review * lint error * minor change * minor change after review * empty commit to retrigger build * changes after review

* updated docstring for set_lr_mult and set_wd_mult * updated docstring per review * Fixed imdecode crash bug when flag=0 (apache#6134) * Fix (apache#6131) * Docs for MXRecordIO, MXIndexedRecordIO modified (apache#6013) * docs for MXIndexedRecordIO modified * changes after review * recordIO doc modified * changes after review * lint error * minor change * minor change after review * empty commit to retrigger build * changes after review * Update documentation for mx.callback.Speedometer. (apache#6058) * Update documentation for mx.callback.Speedometer. * Minor doc changes. * Use module instead of model in example code. * update doc for Load (apache#6092) * Installation instructions for MacOS and Cloud (apache#6012) * Fix NDArray bool checking (apache#6130) * fix shape order bug (apache#6136) * TOC click unfold (apache#6133) * [doc] new sphnix plugin (apache#6105) * update doc * rm * update * update ndarray * update mds * update * update * update * update * update * update * update image.md and others * update * [doc] use debug mode to build (apache#6151) * move ctc loss to contrib (apache#6154) * Fix for invalid numpy float indexing (apache#6144) * Fix python3 compatibilities (apache#6143) * [doc] small changes to tutorials (apache#6164) * [doc] Fix left toc link (apache#6162) * [example]ADD practical functions and options for speech_recognition example (apache#6141) * ADD practical functions and options for speech_recognition example * add missing stt_bi_graphemes_util.py and deepspeech.cfg template * Added reflection padding (apache#6123) * Added reflection padding * Lint fix * Added 5d reflection padding * Added failure in forward/backward for input dimensions other than 4 of 5 * Improved sanity check readability * Fixing LICENSE file and adding NOTICE (apache#6172) * Creating NOTICE. When code moves to Apache, it will need adjusting to the Apache format. * Replacing source header with full license text * doc improvement - softmax, metrics, and initializer (apache#5945) * doc improvement, softmaxoutput, initializer-constant, minor fixes * doc improvement, metrics * fix softmax doc, fix metric lint * softmax more fixes * add doc change in initializer.py. some minor fix in softmax_cross_entropy * doc change in initializer.py * fix grammer * fix * fix * fix * minor fix * fix * minor fix * DataBatch and NDArrayIter doc modified (apache#6091) * DataBatch and NDArrayIter doc modified * fixes after review * fixes after review * wording changed * some more fixes * improvement * desc fix * Datadesc info added * minor addition * fix * fix * fix after review * [Scala] Change version to 0.9.5-SNAPSHOT (apache#6173) * [scala] change version to 0.9.5-SNAPSHOT * API doc improvement Dropout and SoftmaxActivation (apache#6088) * doc improve for dropout oper * doc improve for SoftmaxActivation oper * fix * fix * Update documentation for mx.callback.do_checkpoint (apache#6059) * Update documentation for mx.callback.do_checkpoint * Use module instead of model for example code. * Update documentation for plot_graph. (apache#6098) * Update documentation for plot_graph. * Minor doc fix. * Restruct get started (apache#6167) * Change get started page * Small fix * Improve * Update documentation of Initializer.dumps() (apache#6128) * Doc Improvement - RMSProp and RMSPropAlex (apache#6107) * rmsprop * rmsprop alex * add link in optimizer.py * fix * fix * missed fix.. * Docforcs,fft,ifft (apache#6145) * fft.cc * add all * changed the description of set_lr_mult and set_wd_mult * Explicitly specify quiet in R install_version (apache#6171)

madjam reviewed Apr 27, 2017

View reviewed changes

madjam added the Doc label Apr 27, 2017

Roshrini force-pushed the mxrecordio-docs branch from bd64e2f to 5cea85f Compare April 27, 2017 22:26

Roshrini changed the title ~~Docs for MXIndexedRecordIO modified~~ Docs for MXRecordIO, MXIndexedRecordIO modified Apr 27, 2017

piiswrong reviewed Apr 27, 2017

View reviewed changes

madjam reviewed Apr 27, 2017

View reviewed changes

Roshrini force-pushed the mxrecordio-docs branch 2 times, most recently from a9e9c8a to 8cfaaaf Compare April 28, 2017 23:58

zackchase suggested changes May 1, 2017

View reviewed changes

Roshrini force-pushed the mxrecordio-docs branch from 8cfaaaf to 077aaf9 Compare May 1, 2017 21:33

piiswrong reviewed May 2, 2017

View reviewed changes

Roshrini added 9 commits May 2, 2017 09:23

docs for MXIndexedRecordIO modified

89ee0c5

changes after review

b2a8c96

recordIO doc modified

667aaa7

changes after review

806c1d7

lint error

46db66d

minor change

82ab63b

minor change after review

d86b334

empty commit to retrigger build

986b8fc

changes after review

1f50013

Roshrini force-pushed the mxrecordio-docs branch from 3599821 to 1f50013 Compare May 2, 2017 16:23

madjam approved these changes May 4, 2017

View reviewed changes

madjam added 3 commits May 4, 2017 12:42

Merge branch 'master' into mxrecordio-docs

a72c3c3

Merge branch 'master' into mxrecordio-docs

0f15626

Merge branch 'master' into mxrecordio-docs

aa501ee

piiswrong merged commit 4069e14 into apache:master May 6, 2017

Roshrini deleted the mxrecordio-docs branch July 14, 2017 05:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs for MXRecordIO, MXIndexedRecordIO modified #6013

Docs for MXRecordIO, MXIndexedRecordIO modified #6013

Roshrini commented Apr 27, 2017

madjam Apr 27, 2017

madjam Apr 27, 2017

madjam Apr 27, 2017

Roshrini commented Apr 27, 2017

piiswrong Apr 27, 2017 •

edited

Loading

Roshrini Apr 27, 2017

madjam Apr 27, 2017

zackchase left a comment

zackchase May 1, 2017

Roshrini commented May 1, 2017

piiswrong May 2, 2017

Docs for MXRecordIO, MXIndexedRecordIO modified #6013

Docs for MXRecordIO, MXIndexedRecordIO modified #6013

Conversation

Roshrini commented Apr 27, 2017

madjam Apr 27, 2017

Choose a reason for hiding this comment

madjam Apr 27, 2017

Choose a reason for hiding this comment

madjam Apr 27, 2017

Choose a reason for hiding this comment

Roshrini commented Apr 27, 2017

piiswrong Apr 27, 2017 • edited Loading

Choose a reason for hiding this comment

Roshrini Apr 27, 2017

Choose a reason for hiding this comment

madjam Apr 27, 2017

Choose a reason for hiding this comment

zackchase left a comment

Choose a reason for hiding this comment

zackchase May 1, 2017

Choose a reason for hiding this comment

Roshrini commented May 1, 2017

piiswrong May 2, 2017

Choose a reason for hiding this comment

piiswrong Apr 27, 2017 •

edited

Loading