aaronmarkham commented on a change in pull request #12606: Refine the documentation of im2rec URL: https://github.com/apache/incubator-mxnet/pull/12606#discussion_r219011040
########## File path: docs/faq/recordio.md ########## @@ -6,35 +6,39 @@ RecordIO implements a file format for a sequence of records. We recommend storin * Packing data together allows continuous reading on the disk. * RecordIO has a simple way to partition, simplifying distributed setting. We provide an example later. -We provide the [im2rec tool](https://github.com/dmlc/mxnet/blob/master/tools/im2rec.cc) so you can create an Image RecordIO dataset by yourself. The following walkthrough shows you how. +We provide the [im2rec tool](https://github.com/dmlc/mxnet/blob/master/tools/im2rec.cc) so you can create an Image RecordIO dataset by yourself. The following walkthrough shows you how. Note that there is python version of [im2rec tool](https://github.com/apache/incubator-mxnet/blob/master/tools/im2rec.py) and [example](https://mxnet.incubator.apache.org/tutorials/basic/data.html) using real-world data. Review comment: We provide two tools for creating a RecordIO dataset. * [im2rec.cc](https://github.com/dmlc/mxnet/blob/master/tools/im2rec.cc) - implements the tool using the C++ API. * [im2rec.py](https://github.com/dmlc/mxnet/blob/master/tools/im2rec.cc) - implements the tool using the Python API. Both provide the same output: a RecordIO dataset. (Then take this mention and add it later for "Next Steps". I don't think you want them leaving this FAQ/tutorial quite yet.) You may want to also review the [example using real-world data with im2rec.py](https://mxnet.incubator.apache.org/tutorials/basic/data.html). ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
