Add Windows MKLDNN Building Instruction #10613

xinyu-intel · 2018-04-19T12:34:51Z

Description

This is a raw instruction for windows users to build mxnet with mkldnn from source. The process is quite tedious and still needs some optimization.

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

@pengzhao-intel @zheng-da

zheng-da · 2018-04-19T15:59:04Z

MKL_README.md

+2. Update mkldnn to the newest:
+```
+    cd 3rdparty/mkldnn/ && git checkout master && git pull
+```


This is because mxnet doesn't point to the latest commit in mkldnn master branch, right now?
This is indeed awkward. Ideally, we don't want users to do it manually. but on the other hand, it's unclear if we should move to the latest commit in mkldnn repo right now.

I have to agree with @zheng-da would refrain from adding this instruction. We should only support the versions which are part of our repository. If there's a need to upgrade, we'll have to do it here. Otherwise we're going to run into issues with people who upgrade on their own while we have not validated that version with our CI.

zheng-da · 2018-04-19T16:02:46Z

MKL_README.md

+    add_definitions(-DMXNET_USE_MKLDNN=1)
+  endif()
+  find_package(MKL)
+```


i'm not sure why we need to do this? If you want to turn some options off in cmake, you can do it in the command line. we definitely don't want users to modify CMakeLists.txt

zheng-da · 2018-04-19T16:06:45Z

MKL_README.md

+
+Extract it to `3rdparty/mkldnn/external` manually.
+
+4. Copy file `3rdparty/mkldnn/config_template.vcxproj` to incubator-mxnet root.


is it possible to do everything from step 2 to 4 in a single command line? once we update the mkldnn submodule, we won't need step 2.

zheng-da · 2018-04-19T16:07:36Z

MKL_README.md

+
+6. Modify `incubator-mxnet\src\operator\tensor\elemwise_sum.h`:
+
+Modify `Sum` in `line 40,73,80,88,94,97` to `Sum2` since it has conflicts with `Sum` in MKLDNN.


is this a bug? if it is, can you submit a PR to fix it?

zheng-da · 2018-04-19T16:10:06Z

MKL_README.md

+    mkdir build
+    cd build
+    cmake -G "Visual Studio 14 Win64" ..
+```


what is step 7? can we not do it in a normal command prompt?

zheng-da · 2018-04-19T16:11:10Z

MKL_README.md

+    cmake -G "Visual Studio 14 Win64" ..
+```
+
+Note that you should close the openmp since MSVC doesn't support openMP3.0. Enable MKLDNN with `MKLDNN_VERBOSE=1`.


do we need to turn off openmp in cmake?
why do we enable MKLDNN_VERBOSE here?

our cmakefile should detect this automatically and disable the features accordingly. We should not expect users to change the configuration just in order to get it compiled locally. In the end, that's the purpose of cmake, right?

marcoabreu

.

xinyu-intel · 2018-04-19T16:38:05Z

@zheng-da @marcoabreu yes you are right. I will optimize this instruction and test locally first. Thanks for suggestion：）

yajiedesign · 2018-04-21T08:49:39Z

i am fixed it #10629

xinyu-intel · 2018-04-21T10:08:33Z

@yajiedesign Good J:) I think it is very helpful to simplify my workflow!

xinyu-intel · 2018-05-10T02:07:14Z

@zheng-da @marcoabreu I've modify the install readme according to @yajiedesign 's PR #10629 .

yajiedesign · 2018-05-10T06:56:12Z

MKL_README.md

+3. Download and install [OpenCV](http://sourceforge.net/projects/opencvlibrary/files/opencv-win/3.0.0/opencv-3.0.0.exe/download).
+4. Unzip the OpenCV package.
+5. Set the environment variable ```OpenCV_DIR``` to point to the ```OpenCV build directory``` (```C:\opencv\build\x64\vc14``` for example). Also, you need to add the OpenCV bin directory (```C:\opencv\build\x64\vc14\bin``` for example) to the ``PATH`` variable.
+6. If you have Intel Math Kernel Library (MKL) installed, set ```MKL_ROOT``` to point to ```MKL``` directory that contains the ```include``` and ```lib```. Typically, you can find the directory in


if set USE_MKLDNN=1 and "MKL" is find,,the blas auto set to "open". if whant use mkl blas, must set BLAS=mkl

marcoabreu · 2018-05-11T09:24:58Z

MKL_README.md

+
+After you have installed all of the required dependencies, build the MXNet source code:
+
+1. Download the MXNet source code from [GitHub](https://github.com/dmlc/mxnet). Don't forget to pull the submodules:


marcoabreu · 2018-05-11T09:25:21Z

MKL_README.md

+
+1. Download the MXNet source code from [GitHub](https://github.com/dmlc/mxnet). Don't forget to pull the submodules:
+```
+    git clone https://github.com/apache/incubator-mxnet.git ~/mxnet --recursive


~ not a valid path on windows - I'd just omit the path

seems same mistakes in https://github.com/apache/incubator-mxnet/blob/master/docs/install/windows_setup.md I'll fix them together.

Thanks a lot! :)

xinyu-intel · 2018-05-14T04:54:22Z

@marcoabreu hi, please help review this pr. Thanks!

xinyu-intel · 2018-05-17T01:31:04Z

@zheng-da @marcoabreu hi, please help review this pr. Thanks!

zheng-da · 2018-05-18T04:36:16Z

It looks good to me. @marcoabreu do you have more comments for this PR? If not, could you please merge it?

marcoabreu

LGTM, sorry for the delay

* add windows mkldnn instruction * update readme * typo full mkl to mkldnn * update blas * update mxnet url * update mkl build * intel mkl liscence * retrigger

add windows mkldnn instruction

0866648

zheng-da reviewed Apr 19, 2018

View reviewed changes

marcoabreu suggested changes Apr 19, 2018

View reviewed changes

xinyu-intel mentioned this pull request Apr 22, 2018

[MXNET-343]fix Mkldnn with msvc #10629

Merged

3 tasks

xinyu-intel added 2 commits May 10, 2018 09:59

update readme

04e957b

typo full mkl to mkldnn

03910a7

yajiedesign reviewed May 10, 2018

View reviewed changes

update blas

137046c

marcoabreu reviewed May 11, 2018

View reviewed changes

update mxnet url

9ac628c

xinyu-intel requested a review from szha as a code owner May 11, 2018 10:06

xinyu-intel added 3 commits May 15, 2018 20:26

update mkl build

cf86288

intel mkl liscence

a0bda84

retrigger

bb452c3

marcoabreu approved these changes May 18, 2018

View reviewed changes

marcoabreu merged commit 2567c90 into apache:master May 18, 2018

anirudh2290 pushed a commit that referenced this pull request Jun 13, 2018

Add Windows MKLDNN Building Instruction (#10613)

bc9a2d2

* add windows mkldnn instruction * update readme * typo full mkl to mkldnn * update blas * update mxnet url * update mkl build * intel mkl liscence * retrigger

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Windows MKLDNN Building Instruction #10613

Add Windows MKLDNN Building Instruction #10613

xinyu-intel commented Apr 19, 2018

zheng-da Apr 19, 2018

marcoabreu Apr 19, 2018

zheng-da Apr 19, 2018

zheng-da Apr 19, 2018

zheng-da Apr 19, 2018

zheng-da Apr 19, 2018

zheng-da Apr 19, 2018

marcoabreu Apr 19, 2018

marcoabreu left a comment

xinyu-intel commented Apr 19, 2018 via email •

edited

Loading

yajiedesign commented Apr 21, 2018

xinyu-intel commented Apr 21, 2018

xinyu-intel commented May 10, 2018

yajiedesign May 10, 2018

xinyu-intel May 10, 2018

marcoabreu May 11, 2018

marcoabreu May 11, 2018

xinyu-intel May 11, 2018

marcoabreu May 11, 2018

xinyu-intel commented May 14, 2018

xinyu-intel commented May 17, 2018

zheng-da commented May 18, 2018

marcoabreu left a comment


		Extract it to `3rdparty/mkldnn/external` manually.

		4. Copy file `3rdparty/mkldnn/config_template.vcxproj` to incubator-mxnet root.


		6. Modify `incubator-mxnet\src\operator\tensor\elemwise_sum.h`:

		Modify `Sum` in `line 40,73,80,88,94,97` to `Sum2` since it has conflicts with `Sum` in MKLDNN.


		After you have installed all of the required dependencies, build the MXNet source code:

		1. Download the MXNet source code from [GitHub](https://github.com/dmlc/mxnet). Don't forget to pull the submodules:

Add Windows MKLDNN Building Instruction #10613

Add Windows MKLDNN Building Instruction #10613

Conversation

xinyu-intel commented Apr 19, 2018

Description

Checklist

Essentials

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marcoabreu left a comment

Choose a reason for hiding this comment

xinyu-intel commented Apr 19, 2018 via email • edited Loading

yajiedesign commented Apr 21, 2018

xinyu-intel commented Apr 21, 2018

xinyu-intel commented May 10, 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

Choose a reason for hiding this comment

xinyu-intel commented May 14, 2018

xinyu-intel commented May 17, 2018

zheng-da commented May 18, 2018

marcoabreu left a comment

Choose a reason for hiding this comment

xinyu-intel commented Apr 19, 2018 via email •

edited

Loading