[MXNET-1083] Add the example to demonstrate the inference workflow using C++ API #13294

leleamol · 2018-11-16T01:11:05Z

Description

The PR includes an example that demonstrates the inference workflow using C++ API.

Checklist

Essentials

Please feel free to remove inapplicable items for your PR.

[y] 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-$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

Feature1, tests, (and when applicable, API doc)
Feature2, tests, (and when applicable, API doc)
The example demonstrates how to load the pre-trained model and associated parameter files.
The model and parameter files can be specified as command line arguments.

Comments

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

…ing C++ API

leleamol · 2018-11-16T01:13:04Z

@nswamy addressed the latest review comments

Loading the mean image only once.
Remove the image_data instance variable.

cpp-package/example/inference/Makefile

cpp-package/example/inference/inception_inference.cpp

lebeg · 2018-11-16T14:19:40Z

cpp-package/example/inference/inception_inference.cpp

+ int num_unit = strtol(hidden_units_string.c_str(), &pNext, 10);
+ dimensions.push_back(num_unit);
+ while (*pNext) {
+ num_unit = strtol(pNext, &pNext, 10);


std::stringstream with >> operators could be much more readable and safe.

Can you elaborate a little more?

std::istringstream stream(hidden_units_string); std::vector<index_t> dimensions; int num_unit; while (stream >> num_unit) { dimensions.push_back(num_unit); }

@lebeg The "strtol method" was recommended by @larroy in my last PR, hence I am using is to keep it consistent.

@larroy which method would you suggest?

kalyc · 2018-11-16T20:42:12Z

@mxnet-label-bot add [pr-awaiting-review]

cpp-package/example/inference/Makefile

stu1130 · 2018-11-20T00:35:42Z

cpp-package/example/inference/unit_test_inception_inference.sh

+else
+ echo "FAIL: inception_inference FAILED to identify the image."
+ exit 1
+fi


I think we can put all the training and inference unit tests under the unittest folder? and why not use C++ testing framework such as Catch

Catch is 👍 but gtest is already available in MXNet as a subrepo, so it might be considered as well

The examples are written so that they won't have external dependency. However, will definitely consider gtest for unit tests.

stu1130 · 2018-11-20T20:44:56Z

@mxnet-label-bot update [pr-awaiting-response]

vandanavk · 2018-11-26T22:43:04Z

Could you add information about this example in the README file cpp-package/example/README.md

leleamol · 2018-11-27T23:11:22Z

@vandanavk Added the ReadMe file for example.

leleamol · 2018-11-28T22:25:34Z

@sandeep-krishnamurthy

cpp-package/example/inference/inception_inference.cpp

lebeg · 2018-11-29T09:38:49Z

cpp-package/example/inference/inception_inference.cpp

+ int num_unit = strtol(hidden_units_string.c_str(), &pNext, 10);
+ dimensions.push_back(num_unit);
+ while (*pNext) {
+ num_unit = strtol(pNext, &pNext, 10);


@larroy which method would you suggest?

cpp-package/example/inference/inception_inference.cpp

leleamol · 2018-11-29T23:43:16Z

@mxnet-jenkins The recent CI failure doesn't seem to be related to my changes. Can we re trigger the build?

lebeg · 2018-11-30T14:18:41Z

Job timed out due to dockerhub failure. Restarted (even if I'm not @mxnet-jenkins).

leleamol · 2018-12-03T20:20:50Z

Can this PR be merged? I have addressed the review comments. The example is working as expected and demonstrates the usage of C++ API in running inference workflow.

lupesko · 2018-12-04T01:10:12Z

@mxnet-label-bot update [pr-awaiting-review]
@sandeep-krishnamurthy @nswamy @anirudh2290 - can you guys review/merge please?

larroy

LGTM

sandeep-krishnamurthy

Thanks Amol.

cpp-package/example/inference/inception_inference.cpp

cpp-package/example/README.md

cpp-package/example/inference/README.md

cpp-package/example/inference/inception_inference.cpp

leleamol · 2018-12-12T18:11:33Z

I have addressed all the review comments. Can this be merged? Since the purpose of this example is to show the inference workflow, I would like to keep the example simple.

sandeep-krishnamurthy

LGTM. Thanks.

@lebeg @stu1130 - This is good to go if your comments are addressed.

lebeg

Sure

leleamol · 2018-12-14T19:26:24Z

Thanks @sandeep-krishnamurthy @lebeg ,

can you please merge the PR?

leleamol · 2018-12-14T22:29:13Z

@mxnet-label-bot update [pr-awaiting-merge]

…ing C++ API (apache#13294) * [MXNET-1083] Add the example to demonstrate the inference workflow using C++ API * [MXNET-1083] Add the example to demonstrate the inference workflow using C++ API * Updated the code to address the review comments. * Added the README file for the folder. * Addressed the review comments * Addressed the review comments to use argmax and default mean values.

leleamol · 2019-06-10T18:15:41Z

@mxnet-label-bot remove [pr-awaiting-merge]

leleamol added 2 commits November 15, 2018 17:02

[MXNET-1083] Add the example to demonstrate the inference workflow us…

4088c67

…ing C++ API

[MXNET-1083] Add the example to demonstrate the inference workflow us…

425b159

…ing C++ API

leleamol requested review from nswamy and szha as code owners November 16, 2018 01:11

leleamol mentioned this pull request Nov 16, 2018

[MXNET-1083] Add the example to demonstrate the inference workflow using C++ API. #12930

Closed

3 tasks

lebeg reviewed Nov 16, 2018

View reviewed changes

marcoabreu added the pr-awaiting-review PR is waiting for code review label Nov 16, 2018

stu1130 reviewed Nov 20, 2018

View reviewed changes

cpp-package/example/inference/Makefile Outdated Show resolved Hide resolved

stu1130 reviewed Nov 20, 2018

View reviewed changes

marcoabreu added pr-awaiting-response PR is reviewed and waiting for contributor to respond and removed pr-awaiting-review PR is waiting for code review labels Nov 20, 2018

leleamol added 2 commits November 26, 2018 16:57

Updated the code to address the review comments.

48074fe

Added the README file for the folder.

09bc9b3

lebeg reviewed Nov 29, 2018

View reviewed changes

Addressed the review comments

6a71f17

marcoabreu added pr-awaiting-review PR is waiting for code review and removed pr-awaiting-response PR is reviewed and waiting for contributor to respond labels Dec 4, 2018

larroy approved these changes Dec 4, 2018

View reviewed changes

sandeep-krishnamurthy reviewed Dec 4, 2018

View reviewed changes

Addressed the review comments to use argmax and default mean values.

0ab6c54

sandeep-krishnamurthy approved these changes Dec 14, 2018

View reviewed changes

stu1130 approved these changes Dec 14, 2018

View reviewed changes

lebeg approved these changes Dec 14, 2018

View reviewed changes

marcoabreu added pr-awaiting-merge Review and CI is complete. Ready to Merge and removed pr-awaiting-review PR is waiting for code review labels Dec 14, 2018

sandeep-krishnamurthy merged commit ed2cb76 into apache:master Dec 15, 2018

leleamol deleted the inception-example branch December 19, 2018 00:34

marcoabreu removed the pr-awaiting-merge Review and CI is complete. Ready to Merge label Jun 10, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[MXNET-1083] Add the example to demonstrate the inference workflow using C++ API #13294

[MXNET-1083] Add the example to demonstrate the inference workflow using C++ API #13294

leleamol commented Nov 16, 2018

leleamol commented Nov 16, 2018

lebeg Nov 16, 2018

leleamol Nov 26, 2018

lebeg Nov 28, 2018

leleamol Nov 28, 2018

lebeg Nov 29, 2018

kalyc commented Nov 16, 2018

stu1130 Nov 20, 2018

lebeg Nov 20, 2018

leleamol Nov 27, 2018

stu1130 commented Nov 20, 2018

vandanavk commented Nov 26, 2018

leleamol commented Nov 27, 2018

leleamol commented Nov 28, 2018

lebeg Nov 29, 2018

leleamol commented Nov 29, 2018

lebeg commented Nov 30, 2018 •

edited

Loading

leleamol commented Dec 3, 2018

lupesko commented Dec 4, 2018

larroy left a comment

sandeep-krishnamurthy left a comment

leleamol commented Dec 12, 2018

sandeep-krishnamurthy left a comment

lebeg left a comment

leleamol commented Dec 14, 2018

leleamol commented Dec 14, 2018 •

edited

Loading

leleamol commented Jun 10, 2019

[MXNET-1083] Add the example to demonstrate the inference workflow using C++ API #13294

[MXNET-1083] Add the example to demonstrate the inference workflow using C++ API #13294

Conversation

leleamol commented Nov 16, 2018

Description

Checklist

Essentials

Changes

Comments

leleamol commented Nov 16, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kalyc commented Nov 16, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stu1130 commented Nov 20, 2018

vandanavk commented Nov 26, 2018

leleamol commented Nov 27, 2018

leleamol commented Nov 28, 2018

Choose a reason for hiding this comment

leleamol commented Nov 29, 2018

lebeg commented Nov 30, 2018 • edited Loading

leleamol commented Dec 3, 2018

lupesko commented Dec 4, 2018

larroy left a comment

Choose a reason for hiding this comment

sandeep-krishnamurthy left a comment

Choose a reason for hiding this comment

leleamol commented Dec 12, 2018

sandeep-krishnamurthy left a comment

Choose a reason for hiding this comment

lebeg left a comment

Choose a reason for hiding this comment

leleamol commented Dec 14, 2018

leleamol commented Dec 14, 2018 • edited Loading

leleamol commented Jun 10, 2019

lebeg commented Nov 30, 2018 •

edited

Loading

leleamol commented Dec 14, 2018 •

edited

Loading