[2.0] Add cpp-package #20131

barry-jin · 2021-04-06T20:40:40Z

Description

Migrate cpp-package to MXNet2.0. Still work in progress.

Checklist

Essentials

PR's title starts with a category (e.g. [BUGFIX], [MODEL], [TUTORIAL], [FEATURE], [DOC], etc)
Changes are complete (i.e. I finished coding on this PR)
All changes have test coverage
Code is well-documented

Changes

Adopt CachedOp API on graph executor
Adopt autograd API on backward pass
Port SoftmaxOutput operator to 2.0
Test in CI
Xavier initailizer will result in gradient vanish, switch to use Uniform and need more investigation.
Add Documentation
Refactor OpWrapperGenerator.py to solve cross-compilation problems

Comments

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

mxnet-bot · 2021-04-06T20:40:44Z

Hey @barry-jin , Thanks for submitting the PR
All tests are already queued to run once. If tests fail, you can trigger one or more tests again with the following commands:

To trigger all jobs: @mxnet-bot run ci [all]
To trigger specific jobs: @mxnet-bot run ci [job1, job2]

CI supported jobs: [unix-gpu, edge, miscellaneous, centos-cpu, clang, website, sanity, windows-gpu, windows-cpu, centos-gpu, unix-cpu]

Note:
Only following 3 categories can trigger CI :PR Author, MXNet Committer, Jenkins Admin.
All CI tests must pass before the PR can be merged.

barry-jin · 2021-04-08T21:02:29Z

@mxnet-bot run ci [sanity, unix-gpu]

mxnet-bot · 2021-04-08T21:02:36Z

Jenkins CI successfully triggered : [sanity, unix-gpu]

barry-jin · 2021-04-09T16:37:00Z

@mxnet-bot run ci [sanity, unix-gpu]

mxnet-bot · 2021-04-09T16:37:05Z

Jenkins CI successfully triggered : [sanity, unix-gpu]

barry-jin · 2021-04-09T22:05:49Z

@mxnet-bot run ci [unix-gpu]

mxnet-bot · 2021-04-09T22:05:55Z

Jenkins CI successfully triggered : [unix-gpu]

cpp-package/scripts/OpWrapperGenerator.py

This reverts commit c6a40a2.

barry-jin · 2021-05-11T20:22:25Z

@mxnet-bot run ci [centos-cpu]

mxnet-bot · 2021-05-11T20:22:31Z

Jenkins CI successfully triggered : [centos-cpu]

leezu

Thank you @barry-jin! You're adding back a subset of the operators removed in #18531 ("These operators are often used with mx.module APIs. Removing them for mxnet 2.0. You can find equivalent loss functions in mx.gluon.loss namespace.") Why not add back all the Operators that are commonly used therein? This may also be worth an update in the MXNet 2 RFC #16167 as you propose to support the Symbol APIs in the CPP package. For example, this change in CPP package also means that there is no need to drop the other language bindings that were also removed in #18531

leezu · 2021-05-11T22:12:31Z

cpp-package/tests/ci_test.sh

+# skippping temporarily, tracked by https://github.com/apache/incubator-mxnet/issues/20011
+#cp ../../build/cpp-package/example/test_regress_label .
+#./test_regress_label
+
+# sh unittests/unit_test_mlp_csv.sh


Have you tried running?

cpp-package/tests/travis/run_test.sh

src/operator/softmax_output-inl.h

cpp-package/example/inference/unit_test_imagenet_inference.sh

leezu · 2021-05-11T22:23:17Z

cpp-package/include/mxnet-cpp/.gitignore

@@ -0,0 +1,2 @@
+# Rebuildable file(s)
+op.h


Why is op.h placed inside the build dir? Usually we only support out of source build in cmake. This .gitignore may no longer be needed as Makefile in-source build is no longer supported.

op.h is generated by OpWrapperGenerator.py from user side, which should not be tracked by git. Should I just put this .gitignore in cpp-package directory or merged with incubator-mxnet/.gitignore

op.h is generated by OpWrapperGenerator.py from user side

OpWrapperGenerator.py is invoked by cmake inside the build folder ("out of source build"). Usually out-of-source build should not modify the code / files outside of the build folder.

leezu · 2021-05-11T22:29:05Z

cpp-package/README.md

+## Building C++ Package
+
+The cpp-package directory contains the implementation of C++ API. As mentioned above, users are required to build this directory or package before using it.
+**The cpp-package is built while building the MXNet shared library, *libmxnet.so*.**


There is no reason for that. cpp-package depends only on libmxnet.so C APIs. It would be better to keep a separate CMakeLists.txt for the cpp-package with the only requirement to find libmxnet.so. This implies removing the USE_CPP_PACKAGE in the main CMakeLists.txt

Thanks for pointing it out. Let me update the documentation.

ci/docker/runtime_functions.sh

barry-jin · 2021-05-17T18:12:22Z

@mxnet-bot run ci [centos-gpu, unix-gpu]

mxnet-bot · 2021-05-17T18:12:27Z

Jenkins CI successfully triggered : [centos-gpu, unix-gpu]

leezu

Thank you for adding the missing operators. I think the PR is good to merge now and the other points can be addressed later

MXNet2.0: Add cpp-package

c0c4a0e

barry-jin requested review from eric-haibin-lin, leezu, nswamy and szha as code owners April 6, 2021 20:40

lanking520 added the pr-work-in-progress PR is still work in progress label Apr 6, 2021

leezu mentioned this pull request Apr 7, 2021

Update Ubuntu images used on CI to 20.04 #19588

Merged

add tests

b60808f

barry-jin requested review from aaronmarkham and marcoabreu as code owners April 8, 2021 00:51

switch to python3

ce056a0

update OpWrapperGenerator.py

bc62d6b

leezu reviewed Apr 12, 2021

View reviewed changes

cpp-package/scripts/OpWrapperGenerator.py Outdated Show resolved Hide resolved

barry-jin added 2 commits April 15, 2021 12:45

Merge remote-tracking branch 'upstream/master' into cpp-package

9fab1a9

test: test cpp-package on gpu

b6a16d9

barry-jin closed this Apr 16, 2021

barry-jin reopened this Apr 16, 2021

barry-jin added 6 commits April 15, 2021 21:12

test:update ci_test_cpp

0b90b83

add softmaxoutput cuda support

b3d121e

update build

b3075a9

update symbol

c6a40a2

Revert "update symbol"

64d1111

This reverts commit c6a40a2.

update executor

b91d00e

mseth10 added the pr-work-in-progress PR is still work in progress label May 11, 2021

mseth10 added pr-awaiting-testing PR is reviewed and waiting CI build and test pr-awaiting-review PR is waiting for code review and removed pr-work-in-progress PR is still work in progress pr-awaiting-testing PR is reviewed and waiting CI build and test labels May 11, 2021

leezu suggested changes May 11, 2021

View reviewed changes

barry-jin mentioned this pull request May 12, 2021

[RFC] Apache MXNet 2.0 Roadmap #16167

Open

update

6bddda2

mseth10 added pr-awaiting-testing PR is reviewed and waiting CI build and test pr-work-in-progress PR is still work in progress and removed pr-awaiting-review PR is waiting for code review pr-awaiting-testing PR is reviewed and waiting CI build and test labels May 13, 2021

add module api to amp list

e9d8b45

mseth10 added pr-awaiting-testing PR is reviewed and waiting CI build and test pr-work-in-progress PR is still work in progress and removed pr-work-in-progress PR is still work in progress pr-awaiting-testing PR is reviewed and waiting CI build and test labels May 14, 2021

mseth10 added pr-awaiting-testing PR is reviewed and waiting CI build and test pr-awaiting-review PR is waiting for code review and removed pr-work-in-progress PR is still work in progress pr-awaiting-testing PR is reviewed and waiting CI build and test labels May 17, 2021

leezu approved these changes May 24, 2021

View reviewed changes

leezu merged commit ec119d3 into apache:master May 24, 2021

barry-jin mentioned this pull request May 24, 2021

[2.0][CPP] CPP package out of source build. #20306

Open

bartekkuncer mentioned this pull request Jul 20, 2021

[BUGFIX] Fix backport of SoftmaxOutput implementation using onednn kernels #20459

Merged

2 tasks

barry-jin deleted the cpp-package branch August 4, 2021 21:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[2.0] Add cpp-package #20131

[2.0] Add cpp-package #20131

barry-jin commented Apr 6, 2021 •

edited

Loading

mxnet-bot commented Apr 6, 2021

barry-jin commented Apr 8, 2021

mxnet-bot commented Apr 8, 2021

barry-jin commented Apr 9, 2021

mxnet-bot commented Apr 9, 2021

barry-jin commented Apr 9, 2021

mxnet-bot commented Apr 9, 2021

barry-jin commented May 11, 2021

mxnet-bot commented May 11, 2021

leezu left a comment •

edited

Loading

leezu May 11, 2021

leezu May 11, 2021 •

edited

Loading

barry-jin May 13, 2021

leezu May 13, 2021

leezu May 11, 2021

barry-jin May 13, 2021

barry-jin commented May 17, 2021

mxnet-bot commented May 17, 2021

leezu left a comment

[2.0] Add cpp-package #20131

[2.0] Add cpp-package #20131

Conversation

barry-jin commented Apr 6, 2021 • edited Loading

Description

Checklist

Essentials

Changes

Comments

mxnet-bot commented Apr 6, 2021

barry-jin commented Apr 8, 2021

mxnet-bot commented Apr 8, 2021

barry-jin commented Apr 9, 2021

mxnet-bot commented Apr 9, 2021

barry-jin commented Apr 9, 2021

mxnet-bot commented Apr 9, 2021

barry-jin commented May 11, 2021

mxnet-bot commented May 11, 2021

leezu left a comment • edited Loading

Choose a reason for hiding this comment

leezu May 11, 2021

Choose a reason for hiding this comment

leezu May 11, 2021 • edited Loading

Choose a reason for hiding this comment

barry-jin May 13, 2021

Choose a reason for hiding this comment

leezu May 13, 2021

Choose a reason for hiding this comment

leezu May 11, 2021

Choose a reason for hiding this comment

barry-jin May 13, 2021

Choose a reason for hiding this comment

barry-jin commented May 17, 2021

mxnet-bot commented May 17, 2021

leezu left a comment

Choose a reason for hiding this comment

barry-jin commented Apr 6, 2021 •

edited

Loading

leezu left a comment •

edited

Loading

leezu May 11, 2021 •

edited

Loading