-
Notifications
You must be signed in to change notification settings - Fork 6.8k
Docs for MXRecordIO, MXIndexedRecordIO modified #6013
Conversation
python/mxnet/recordio.py
Outdated
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggest rewording it as:
"Returns the current position of write head."
python/mxnet/recordio.py
Outdated
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggest rewording as:
"Returns record at given index."
python/mxnet/recordio.py
Outdated
self.seek(idx) | ||
return self.read() | ||
|
||
def write_idx(self, idx, buf): | ||
"""Write record with index.""" | ||
"""Writes the record on the given index. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Inserts record at given index."
Fixed |
bd64e2f
to
5cea85f
Compare
|
||
Example usage: | ||
---------- | ||
>>> record = mx.recordio.MXRecordIO('tmp.rec', 'w') |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
put a read/write example here.
the methods don't need to include open. Just print the result of read.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
python/mxnet/recordio.py
Outdated
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"current reader" -> read
a9e9c8a
to
8cfaaaf
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
python/mxnet/recordio.py
Outdated
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps change "a" to "the" since there is only one record at the given index. Is that right?
@zackchase Thanks for reviewing. Fixed it. I added examples after running them. But @madjam can run them again. Please approve and merge. |
python/mxnet/recordio.py
Outdated
Example usage: | ||
---------- | ||
>>> record = mx.recordio.MXIndexedRecordIO('tmp.idx', 'tmp.rec', 'w') | ||
>>> record |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
* 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)
@mli @zackchase @madjam @nswamy @indhub @jiajiechen Please take a look.