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

Add docstring in im2rec.py #12621

Merged
merged 12 commits into from
Sep 21, 2018

Conversation

stu1130
Copy link
Contributor

@stu1130 stu1130 commented Sep 20, 2018

Description

Checklist

Essentials

Please feel free to remove inapplicable items for your PR.

  • The PR title starts with [MXNET-$JIRA_ID], where $JIRA_ID refers to the relevant JIRA issue created (except PRs with tiny changes)
  • Changes are complete (i.e. I finished coding on this PR)
  • All changes have test coverage:
  • Unit tests are added for small changes to verify correctness (e.g. adding a new operator)
  • Nightly tests are added for complicated/long-running ones (e.g. changing distributed kvstore)
  • Build tests will be added for build configuration changes (e.g. adding a new build option with NCCL)
  • Code is well-documented:
  • For user-facing API changes, API doc string has been updated.
  • For new C++ functions in header files, their functionalities and arguments are documented.
  • For new examples, README.md is added to explain the what the example does, the source of the dataset, expected performance on test set and reference to the original paper if applicable
  • Check the API doc at http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-$PR_ID/$BUILD_ID/index.html
  • To the my best knowledge, examples are either not affected by this change, or have been fixed to be compatible with this change

Changes

  • update the im2rec tutorial link. It now point to exact im2rec section.

Comments

N/A

@stu1130 stu1130 requested a review from szha as a code owner September 20, 2018 21:35
@stu1130 stu1130 changed the title Add im2rec docstring Add docstring in im2rec Sep 20, 2018
@stu1130 stu1130 changed the title Add docstring in im2rec Add docstring in im2rec.py Sep 20, 2018
@sandeep-krishnamurthy sandeep-krishnamurthy added Doc pr-awaiting-review PR is waiting for code review labels Sep 20, 2018
Copy link
Contributor

@lupesko lupesko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding the docstring. But why not include params and return details in the docstring?
(e.g. https://github.com/apache/incubator-mxnet/blob/master/python/mxnet/autograd.py#L52)

Copy link
Contributor

@sandeep-krishnamurthy sandeep-krishnamurthy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work.

@aaronmarkham - Can you please take a look. Thanks.

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 make the one grammar change. Otherwise this is gtg!

tools/im2rec.py Outdated
if line_len < 3:
print('lst should at least has three parts, but only has %s parts for %s' %(line_len, line))
print('lst should at least has three parts, but only has %s parts for %s' % (line_len, line))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lst should have at least three parts

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @aaronmarkham

@sandeep-krishnamurthy sandeep-krishnamurthy merged commit 504d24c into apache:master Sep 21, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Doc pr-awaiting-review PR is waiting for code review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants