[Doc] Add MKL-DNN operator list #14891

TaoLv · 2019-05-06T07:00:35Z

Description

Add MKL-DNN optimized operator list and graph fusion pattern list.

This PR is part of the plan in #14399

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

Feature1, tests, (and when applicable, API doc)
Feature2, tests, (and when applicable, API doc)

Comments

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

…to doc-op-list

TaoLv · 2019-05-06T07:00:56Z

@pengzhao-intel please review~

pengzhao-intel

LGTM

Minor comments in line.

docs/tutorials/mkldnn/operator_list.md

TaoLv · 2019-05-06T13:23:34Z

@xinyu-intel @ciyongch please help to review. Thank you.

docs/install/index.md

docs/tutorials/mkldnn/operator_list.md

xinyu-intel

http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-14891/2/install/index.html?platform=Linux&language=Python&processor=CPU
http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-14891/2/tutorials/mkldnn/MKLDNN_README.html
http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-14891/2/tutorials/mkldnn/operator_list.html

xinyu-intel

.

docs/tutorials/mkldnn/MKLDNN_README.md

anirudhacharya · 2019-05-06T17:16:48Z

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

TaoLv · 2019-05-07T02:35:38Z

Hi @aaronmarkham May I have your help? CI complains about converting markdown table:
http://jenkins.mxnet-ci.amazon-ml.com/blue/organizations/jenkins/mxnet-validation%2Fwebsite/detail/PR-14891/3/pipeline/85#step-123-log-1335

aaronmarkham

Please test the install index page on a preview. It tends to break a lot and very easily.

docs/faq/perf.md

docs/tutorials/mkldnn/operator_list.md

aaronmarkham · 2019-05-07T18:42:27Z

docs/tutorials/mkldnn/operator_list.md

+| FullyConnected (INT8) + re-quantization                   |                                     |
+
+
+To install MXNet MKL-DNN backend, please refer to [MKL-DNN backend readme](http://mxnet.incubator.apache.org/tutorials/mkldnn/MKLDNN_README.html)


Please use relative links. You should be able to use MKLDNN_README.md. That being said, I'd move that readme content to the index page and link to index.md.

docs/tutorials/mkldnn/operator_list.md

aaronmarkham · 2019-05-07T19:06:54Z

docs/install/index.md

@@ -124,20 +124,38 @@ Indicate your preferred configuration. Then, follow the customized commands to i
 $ pip install mxnet
 ```

+MXNet offers pip packages with MKL-DNN enabled which will be much faster when running on Intel hardware. Try the following command line to install it and find performance numbers and tuning guide in <a href="https://mxnet.incubator.apache.org/versions/master/faq/perf.html#intel-cpu">performance on Intel CPU</a>.


Suggested change

MXNet offers pip packages with MKL-DNN enabled which will be much faster when running on Intel hardware. Try the following command line to install it and find performance numbers and tuning guide in <a href="https://mxnet.incubator.apache.org/versions/master/faq/perf.html#intel-cpu">performance on Intel CPU</a>.

MKL-DNN enabled pip packages are optimized for Intel hardware. You can find performance numbers in the <a href="../..//faq/perf.md#intel-cpu">MXNet tuning guide</a>.

Hi @aaronmarkham, the link here will be compiled to https://mxnet.incubator.apache.org/versions/faq/perf.md#intel-cpu which is a blank page. Do you think I can use http://mxnet.io/faq/perf.html#intel-cpu instead here?

@pengzhao-intel

docs/install/index.md

docs/tutorials/mkldnn/MKLDNN_README.md

Co-Authored-By: TaoLv <tao.a.lv@intel.com>

…to doc-op-list

TaoLv · 2019-05-14T02:13:30Z

@aaronmarkham @ciyongch @pengzhao-intel please take another look - I added some description about how the subgraph backend variable is used and added a reference link in the env var page.

aaronmarkham

Some minor grammar suggestions. And maybe one link issue...
If you're going back in there, I'd still rename mkldnn_readme.md to index.md and adjust any backlinks to it.

docs/faq/env_var.md

docs/install/index.md

docs/tutorials/mkldnn/MKLDNN_README.md

Co-Authored-By: Aaron Markham <markhama@amazon.com>

TaoLv · 2019-05-15T06:09:43Z

Thank you for the fix @aaronmarkham . I'm not familiar with the compilation from md files to html files, but I not notice there is already an index.md in the folder (and other folders under tutorials). Are you suggesting to overwrite the existing index.md?

…to doc-op-list

…into doc-op-list

…to doc-op-list

aaronmarkham · 2019-05-16T16:52:07Z

Thank you for the fix @aaronmarkham . I'm not familiar with the compilation from md files to html files, but I not notice there is already an index.md in the folder (and other folders under tutorials). Are you suggesting to overwrite the existing index.md?

Since others are working on that file right now in another PR, let's leave it alone for now.

…to doc-op-list

pengzhao-intel · 2019-05-17T04:28:34Z

@TaoLv I merged two MKLDNN related PRs just now and please check if the doc needs the related change.
I think we can merge this PR when all is finalized.

TaoLv · 2019-05-17T05:10:26Z

@TaoLv I merged two MKLDNN related PRs just now and please check if the doc needs the related change.
I think we can merge this PR when all is finalized.

Sure. Will change accordingly~

…to doc-op-list

TaoLv · 2019-05-17T09:44:00Z

@pengzhao-intel Change the environmental variable name from MKLDNN_POST_QUANTIZE to MKLDNN_QUANTIZE accordingly. And also remove the ReLU constraint since we support more activation fusion now. Please review again~

pengzhao-intel · 2019-05-17T11:40:42Z

It's great @TaoLv, please retrigger the CI and I will merge soon.

pengzhao-intel · 2019-05-18T00:25:58Z

update env_var.md again :(

* improve mkldnn document * fix * enable fusion * adjust table * fix comments * promote mxnet-mkl package * Update docs/tutorials/mkldnn/MKLDNN_README.md Co-Authored-By: TaoLv <tao.a.lv@intel.com> * Update docs/install/index.md Co-Authored-By: TaoLv <tao.a.lv@intel.com> * Update docs/install/index.md Co-Authored-By: TaoLv <tao.a.lv@intel.com> * Update docs/install/index.md Co-Authored-By: TaoLv <tao.a.lv@intel.com> * Update docs/install/index.md Co-Authored-By: TaoLv <tao.a.lv@intel.com> * Update docs/tutorials/mkldnn/operator_list.md Co-Authored-By: TaoLv <tao.a.lv@intel.com> * Update docs/faq/perf.md Co-Authored-By: TaoLv <tao.a.lv@intel.com> * Update docs/faq/perf.md Co-Authored-By: TaoLv <tao.a.lv@intel.com> * Update docs/tutorials/mkldnn/operator_list.md Co-Authored-By: TaoLv <tao.a.lv@intel.com> * Update docs/tutorials/mkldnn/operator_list.md Co-Authored-By: TaoLv <tao.a.lv@intel.com> * fix markdown table * fix comments * Update docs/faq/env_var.md Co-Authored-By: Aaron Markham <markhama@amazon.com> * Update docs/install/index.md Co-Authored-By: Aaron Markham <markhama@amazon.com> * Update docs/tutorials/mkldnn/MKLDNN_README.md Co-Authored-By: Aaron Markham <markhama@amazon.com> * change name of env variable * retrigger ci * Update env_var.md

TaoLv added 4 commits May 6, 2019 14:04

improve mkldnn document

c202b36

fix

6fbfe48

enable fusion

15446a8

Merge branch 'master' of /~https://github.com/apache/incubator-mxnet in…

8a3b9b9

…to doc-op-list

TaoLv requested a review from szha as a code owner May 6, 2019 07:00

TaoLv mentioned this pull request May 6, 2019

[Doc] Improve the document for MKL-DNN backend #14399

Closed

5 tasks

adjust table

70f3723

pengzhao-intel approved these changes May 6, 2019

View reviewed changes

docs/tutorials/mkldnn/operator_list.md Outdated Show resolved Hide resolved

docs/tutorials/mkldnn/operator_list.md Outdated Show resolved Hide resolved

docs/tutorials/mkldnn/operator_list.md Outdated Show resolved Hide resolved

xinyu-intel reviewed May 6, 2019

View reviewed changes

docs/install/index.md Outdated Show resolved Hide resolved

xinyu-intel reviewed May 6, 2019

View reviewed changes

docs/tutorials/mkldnn/operator_list.md Show resolved Hide resolved

xinyu-intel reviewed May 6, 2019

View reviewed changes

docs/tutorials/mkldnn/operator_list.md Outdated Show resolved Hide resolved

xinyu-intel reviewed May 6, 2019

View reviewed changes

docs/tutorials/mkldnn/MKLDNN_README.md Outdated Show resolved Hide resolved

fix comments

5b3f6db

marcoabreu added the pr-awaiting-review PR is waiting for code review label May 6, 2019

promote mxnet-mkl package

58e8ac1

aaronmarkham suggested changes May 7, 2019

View reviewed changes

aaronmarkham and others added 9 commits May 8, 2019 09:47

Update docs/tutorials/mkldnn/MKLDNN_README.md

ce82caa

Co-Authored-By: TaoLv <tao.a.lv@intel.com>

Update docs/install/index.md

dab9ddf

Co-Authored-By: TaoLv <tao.a.lv@intel.com>

Update docs/install/index.md

2a5e2cd

Co-Authored-By: TaoLv <tao.a.lv@intel.com>

Update docs/install/index.md

708edee

Co-Authored-By: TaoLv <tao.a.lv@intel.com>

Update docs/install/index.md

fb5fcc3

Co-Authored-By: TaoLv <tao.a.lv@intel.com>

Update docs/tutorials/mkldnn/operator_list.md

4a61c8e

Co-Authored-By: TaoLv <tao.a.lv@intel.com>

Update docs/faq/perf.md

4c897e8

Co-Authored-By: TaoLv <tao.a.lv@intel.com>

Update docs/faq/perf.md

eb36414

Co-Authored-By: TaoLv <tao.a.lv@intel.com>

Update docs/tutorials/mkldnn/operator_list.md

bfc5ac0

Co-Authored-By: TaoLv <tao.a.lv@intel.com>

TaoLv added 3 commits May 13, 2019 15:51

fix comments

d1cf743

Merge branch 'master' of /~https://github.com/apache/incubator-mxnet in…

762945b

…to doc-op-list

Merge branch 'master' of /~https://github.com/apache/incubator-mxnet in…

6b01ce3

…to doc-op-list

aaronmarkham reviewed May 14, 2019

View reviewed changes

docs/faq/env_var.md Outdated Show resolved Hide resolved

docs/install/index.md Outdated Show resolved Hide resolved

docs/tutorials/mkldnn/MKLDNN_README.md Outdated Show resolved Hide resolved

TaoLv and others added 3 commits May 15, 2019 14:04

Update docs/faq/env_var.md

5c3d067

Co-Authored-By: Aaron Markham <markhama@amazon.com>

Update docs/install/index.md

d9fcea4

Co-Authored-By: Aaron Markham <markhama@amazon.com>

Update docs/tutorials/mkldnn/MKLDNN_README.md

b6de387

Co-Authored-By: Aaron Markham <markhama@amazon.com>

ciyongch approved these changes May 15, 2019

View reviewed changes

TaoLv added 3 commits May 15, 2019 22:55

Merge branch 'master' of /~https://github.com/apache/incubator-mxnet in…

ad5e2c8

…to doc-op-list

Merge branch 'doc-op-list' of /~https://github.com/TaoLv/incubator-mxnet …

2d8e4d8

…into doc-op-list

Merge branch 'master' of /~https://github.com/apache/incubator-mxnet in…

d7c7776

…to doc-op-list

pengzhao-intel mentioned this pull request May 17, 2019

[Discussion] 1.5.0 Roadmap #14619

Closed

Merge branch 'master' of /~https://github.com/apache/incubator-mxnet in…

e2f0d03

…to doc-op-list

TaoLv added 2 commits May 17, 2019 17:35

Merge branch 'master' of /~https://github.com/apache/incubator-mxnet in…

bd49e9d

…to doc-op-list

change name of env variable

b783f58

retrigger ci

0f82b3b

szha added 2 commits May 17, 2019 18:57

Merge branch 'master' into doc-op-list

dd4cfa5

Update env_var.md

4d36bbf

pengzhao-intel merged commit e11a23d into apache:master May 18, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Doc] Add MKL-DNN operator list #14891

[Doc] Add MKL-DNN operator list #14891

TaoLv commented May 6, 2019

TaoLv commented May 6, 2019

pengzhao-intel left a comment

TaoLv commented May 6, 2019

xinyu-intel left a comment

xinyu-intel left a comment

anirudhacharya commented May 6, 2019

TaoLv commented May 7, 2019

aaronmarkham left a comment

aaronmarkham May 7, 2019

aaronmarkham May 7, 2019

TaoLv May 21, 2019

TaoLv May 21, 2019

TaoLv commented May 14, 2019

aaronmarkham left a comment

TaoLv commented May 15, 2019

aaronmarkham commented May 16, 2019

pengzhao-intel commented May 17, 2019

TaoLv commented May 17, 2019

TaoLv commented May 17, 2019

pengzhao-intel commented May 17, 2019

pengzhao-intel commented May 18, 2019

		\| FullyConnected (INT8) + re-quantization \| \|


		To install MXNet MKL-DNN backend, please refer to [MKL-DNN backend readme](http://mxnet.incubator.apache.org/tutorials/mkldnn/MKLDNN_README.html)

	MXNet offers pip packages with MKL-DNN enabled which will be much faster when running on Intel hardware. Try the following command line to install it and find performance numbers and tuning guide in <a href="https://mxnet.incubator.apache.org/versions/master/faq/perf.html#intel-cpu">performance on Intel CPU</a>.
	MKL-DNN enabled pip packages are optimized for Intel hardware. You can find performance numbers in the <a href="../..//faq/perf.md#intel-cpu">MXNet tuning guide</a>.

[Doc] Add MKL-DNN operator list #14891

[Doc] Add MKL-DNN operator list #14891

Conversation

TaoLv commented May 6, 2019

Description

Checklist

Essentials

Changes

Comments

TaoLv commented May 6, 2019

pengzhao-intel left a comment

Choose a reason for hiding this comment

TaoLv commented May 6, 2019

xinyu-intel left a comment

Choose a reason for hiding this comment

xinyu-intel left a comment

Choose a reason for hiding this comment

anirudhacharya commented May 6, 2019

TaoLv commented May 7, 2019

aaronmarkham left a comment

Choose a reason for hiding this comment

aaronmarkham May 7, 2019

Choose a reason for hiding this comment

aaronmarkham May 7, 2019

Choose a reason for hiding this comment

TaoLv May 21, 2019

Choose a reason for hiding this comment

TaoLv May 21, 2019

Choose a reason for hiding this comment

TaoLv commented May 14, 2019

aaronmarkham left a comment

Choose a reason for hiding this comment

TaoLv commented May 15, 2019

aaronmarkham commented May 16, 2019

pengzhao-intel commented May 17, 2019

TaoLv commented May 17, 2019

TaoLv commented May 17, 2019

pengzhao-intel commented May 17, 2019

pengzhao-intel commented May 18, 2019