-
Notifications
You must be signed in to change notification settings - Fork 6.8k
update docs to list cmake required for build from source page #12592
Conversation
docs/install/build_from_source.md
Outdated
@@ -16,6 +16,8 @@ This document explains how to build MXNet from source code. Building MXNet from | |||
|
|||
You need C++ build tools and a BLAS library to build the MXNet shared library. If you want to run MXNet with GPUs, you will need to install [NVDIA CUDA and cuDNN](https://developer.nvidia.com/cuda-downloads) first. | |||
|
|||
You may use [GNU Make](https://www.gnu.org/software/make/) to build the library but [cmake](https://cmake.org/) is required |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can you elaborate why cmake is required? I am building from source just fine with config.mk and make
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
when building with make with the MKLDNN, cmake it required: https://github.com/apache/incubator-mxnet/blob/master/mkldnn.mk#L40.
additionally there two discussions already to remove the makefile and make cmake default
https://lists.apache.org/list.html?dev@mxnet.apache.org:2018-6:cmake
#8702
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
for GNU make, we can continue stay with MKLDNN=0 regardless of final discussion result. Anyways, I think it should help some users to skip those compiling tools in certain circumstances.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the purpose of the vote was to eliminate the Makefile. if you think we should keep the Makefile, raise it in the email list. otherwise the direction we are heading is removing it completely and becoming dependent on cmake.
Thanks for your contributions @azai91 |
@zhreshold updated the docs to specify that cmake is only necessary for MKLDNN. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good.
Description
https://mxnet.incubator.apache.org/install/build_from_source.html
currently our docs state that cmake is recommended but not required. in the process to migrate fully to cmake (and because it is required by some of our builds already) we will state that cmake is a prerequisite for building from source.
there were already two public disussions to remove cmake (one vote and one on github) so this transition is happening:
https://lists.apache.org/list.html?dev@mxnet.apache.org:2018-6:cmake
#8702
Checklist
Essentials
Please feel free to remove inapplicable items for your PR.
Changes
Comments