This repository has been archived by the owner on Nov 17, 2023. It is now read-only.
added -DCMAKE_BUILD_TYPE=Release to docs for building from source #16144
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@mxnet-label-bot add [Doc, Build] |
larroy
approved these changes
Sep 11, 2019
| @@ -182,6 +182,8 @@ There is a configuration file for make, | |||
|
|
|||
| **NOTE:** When certain set of build flags are set, MXNet archive increases to more than 4 GB. Since MXNet uses archive internally archive runs into a bug ("File Truncated": [bugreport](https://sourceware.org/bugzilla/show_bug.cgi?id=14625)) for archives greater than 4 GB. Please use ar version 2.27 or greater to overcome this bug. Please see https://github.com/apache/incubator-mxnet/issues/15084 for more details. | |||
|
|
|||
| You can specify different cmake compiler configurations with the option `CMAKE_BUILD_TYPE`. In most cases you should set this to option to `Release` for a smaller and faster binary compared to `Debug`. Alternatively, if you are interested in building the smallest binary you can set the option to `MinSizeRel`. In the case you are developing MXNet you might choose `Debug` instead. | |||
|
|
|||
There was a problem hiding this comment.
Can you add relwithdebinfo for completeness?
There was a problem hiding this comment.
Good point! I just added RelWithDebInfo.
as requested by @larroy
|
@QueensGambit There are merge conflicts since we released our new website (#15883). Can you rebase? |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The
CMAKE_BUILD_TYPEis not set in most cases for the build instructions from source.If the
CMAKE_BUILD_TYPEis empty no optimization flags are used by default. This results not only in a higher memory footprint but also in a much slower binary compared to the official python MXNet pip packages. This PR adds the option-DCMAKE_BUILD_TYPE=Releasein the documentation as the default option. @zachgk @aaronmarkhamChecklist
Essentials
Comments