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

Added javadocs and improved example instructions #13711

Merged
merged 1 commit into from
Dec 21, 2018

Conversation

andrewfayres
Copy link
Contributor

@andrewfayres andrewfayres commented Dec 21, 2018

Description

Addressing some user feedback on the documentation for ssd java example and some javadoc stuff.

Specifically:
Making it more clear that in order to run the example, mxnet must first be built.
Fixing a few paths in the readme.
Adding javadocs for ObjectDetectorOutput which is a basic POJO for working with the ObjectDetector inference api.

@piyushghai @zachgk @lanking520 @aaronmarkham

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:https://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-13711/1/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

Comments

  • If this change is a backward incompatible change, why must this change be made.
  • Interesting edge cases to note here

Copy link
Contributor

@piyushghai piyushghai left a comment

Choose a reason for hiding this comment

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

LGTM :)

@Roshrini
Copy link
Member

@mxnet-label-bot Add [pr-awaiting-merge, Scala]

@marcoabreu marcoabreu added pr-awaiting-merge Review and CI is complete. Ready to Merge Scala labels Dec 21, 2018
@aaronmarkham aaronmarkham merged commit b018019 into apache:master Dec 21, 2018
rondogency pushed a commit to rondogency/incubator-mxnet that referenced this pull request Jan 9, 2019
haohuanw pushed a commit to haohuanw/incubator-mxnet that referenced this pull request Jun 23, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
pr-awaiting-merge Review and CI is complete. Ready to Merge Scala
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants