versions/1.9.1/api/julia/docs/api/user-guide/install/index.html - mxnet-site - Git at Google



 <!doctype html>
 <html lang="en" class="no-js">
   <head>

       <meta charset="utf-8">
       <meta name="viewport" content="width=device-width,initial-scale=1">
       <meta http-equiv="x-ua-compatible" content="ie=edge">


         <meta name="lang:clipboard.copy" content="Copy to clipboard">

         <meta name="lang:clipboard.copied" content="Copied to clipboard">

         <meta name="lang:search.language" content="en">

         <meta name="lang:search.pipeline.stopwords" content="True">

         <meta name="lang:search.pipeline.trimmer" content="True">

         <meta name="lang:search.result.none" content="No matching documents">

         <meta name="lang:search.result.one" content="1 matching document">

         <meta name="lang:search.result.other" content="# matching documents">

         <meta name="lang:search.tokenizer" content="[\s\-]+">

       <link rel="shortcut icon" href="../../assets/images/favicon.png">
       <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.6.0">


         <title>Installation Guide - MXNet.jl</title>


       <link rel="stylesheet" href="../../assets/stylesheets/application.1b62728e.css">


       <script src="../../assets/javascripts/modernizr.268332fc.js"></script>


         <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
         <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
         <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>


     <link rel="stylesheet" href="../../assets/fonts/material-icons.css">


       <link rel="stylesheet" href="../../assets/Documenter.css">


   </head>

     <body dir="ltr">

     <svg class="md-svg">
       <defs>


           <svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" viewBox="0 0 416 448" id="__github"><path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z"/></svg>

       </defs>
     </svg>
     <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
     <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
     <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>

       <a href="#installation-guide" tabindex="1" class="md-skip">
         Skip to content
       </a>


       <header class="md-header" data-md-component="header">
   <nav class="md-header-nav md-grid">
     <div class="md-flex">
       <div class="md-flex__cell md-flex__cell--shrink">
         <a href="../.." title="MXNet.jl" class="md-header-nav__button md-logo">

             <i class="md-icon"></i>

         </a>
       </div>
       <div class="md-flex__cell md-flex__cell--shrink">
         <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
       </div>
       <div class="md-flex__cell md-flex__cell--stretch">
         <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">

             <span class="md-header-nav__topic">
               MXNet.jl
             </span>
             <span class="md-header-nav__topic">

                 Installation Guide

             </span>

         </div>
       </div>
       <div class="md-flex__cell md-flex__cell--shrink">

           <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>

 <div class="md-search" data-md-component="search" role="dialog">
   <label class="md-search__overlay" for="__search"></label>
   <div class="md-search__inner" role="search">
     <form class="md-search__form" name="search">
       <input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
       <label class="md-icon md-search__icon" for="__search"></label>
       <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
         &#xE5CD;
       </button>
     </form>
     <div class="md-search__output">
       <div class="md-search__scrollwrap" data-md-scrollfix>
         <div class="md-search-result" data-md-component="result">
           <div class="md-search-result__meta">
             Type to start searching
           </div>
           <ol class="md-search-result__list"></ol>
         </div>
       </div>
     </div>
   </div>
 </div>

       </div>

         <div class="md-flex__cell md-flex__cell--shrink">
           <div class="md-header-nav__source">


 <a href="https://github.com/apache/mxnet/tree/master/julia#mxnet/" title="Go to repository" class="md-source" data-md-source="github">

     <div class="md-source__icon">
       <svg viewBox="0 0 24 24" width="24" height="24">
         <use xlink:href="#__github" width="24" height="24"></use>
       </svg>
     </div>

   <div class="md-source__repository">
     GitHub
   </div>
 </a>
           </div>
         </div>

     </div>
   </nav>
 </header>

     <div class="md-container">


       <main class="md-main" role="main">
         <div class="md-main__inner md-grid" data-md-component="container">


               <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
                 <div class="md-sidebar__scrollwrap">
                   <div class="md-sidebar__inner">
                     <nav class="md-nav md-nav--primary" data-md-level="0">
   <label class="md-nav__title md-nav__title--site" for="__drawer">
     <a href="../.." title="MXNet.jl" class="md-nav__button md-logo">

         <i class="md-icon"></i>

     </a>
     MXNet.jl
   </label>

     <div class="md-nav__source">


 <a href="https://github.com/apache/mxnet/tree/master/julia#mxnet/" title="Go to repository" class="md-source" data-md-source="github">

     <div class="md-source__icon">
       <svg viewBox="0 0 24 24" width="24" height="24">
         <use xlink:href="#__github" width="24" height="24"></use>
       </svg>
     </div>

   <div class="md-source__repository">
     GitHub
   </div>
 </a>
     </div>

   <ul class="md-nav__list" data-md-scrollfix>


   <li class="md-nav__item">
     <a href="../.." title="Home" class="md-nav__link">
       Home
     </a>
   </li>


   <li class="md-nav__item md-nav__item--nested">

       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-2" type="checkbox" id="nav-2">

     <label class="md-nav__link" for="nav-2">
       Tutorial
     </label>
     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
       <label class="md-nav__title" for="nav-2">
         Tutorial
       </label>
       <ul class="md-nav__list" data-md-scrollfix>


   <li class="md-nav__item">
     <a href="../../tutorial/mnist/" title="Digit Recognition on MNIST" class="md-nav__link">
       Digit Recognition on MNIST
     </a>
   </li>


   <li class="md-nav__item">
     <a href="../../tutorial/char-lstm/" title="Generating Random Sentence with LSTM RNN" class="md-nav__link">
       Generating Random Sentence with LSTM RNN
     </a>
   </li>


       </ul>
     </nav>
   </li>


   <li class="md-nav__item md-nav__item--active md-nav__item--nested">

       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3" checked>

     <label class="md-nav__link" for="nav-3">
       User Guide
     </label>
     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
       <label class="md-nav__title" for="nav-3">
         User Guide
       </label>
       <ul class="md-nav__list" data-md-scrollfix>


   <li class="md-nav__item md-nav__item--active">

     <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">


       <label class="md-nav__link md-nav__link--active" for="__toc">
         Installation Guide
       </label>

     <a href="./" title="Installation Guide" class="md-nav__link md-nav__link--active">
       Installation Guide
     </a>


 <nav class="md-nav md-nav--secondary">


     <label class="md-nav__title" for="__toc">Table of contents</label>
     <ul class="md-nav__list" data-md-scrollfix>

         <li class="md-nav__item">
   <a href="#automatic-installation" class="md-nav__link">
     Automatic Installation
   </a>

 </li>


     </ul>

 </nav>

   </li>


   <li class="md-nav__item">
     <a href="../overview/" title="Overview" class="md-nav__link">
       Overview
     </a>
   </li>


   <li class="md-nav__item">
     <a href="../faq/" title="FAQ" class="md-nav__link">
       FAQ
     </a>
   </li>


       </ul>
     </nav>
   </li>


   <li class="md-nav__item md-nav__item--nested">

       <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">

     <label class="md-nav__link" for="nav-4">
       API Documentation
     </label>
     <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
       <label class="md-nav__title" for="nav-4">
         API Documentation
       </label>
       <ul class="md-nav__list" data-md-scrollfix>


   <li class="md-nav__item">
     <a href="../../api/context/" title="Context" class="md-nav__link">
       Context
     </a>
   </li>


   <li class="md-nav__item">
     <a href="../../api/model/" title="Models" class="md-nav__link">
       Models
     </a>
   </li>


   <li class="md-nav__item">
     <a href="../../api/initializer/" title="Initializers" class="md-nav__link">
       Initializers
     </a>
   </li>


   <li class="md-nav__item">
     <a href="../../api/optimizer/" title="Optimizers" class="md-nav__link">
       Optimizers
     </a>
   </li>


   <li class="md-nav__item">
     <a href="../../api/callback/" title="Callbacks in training" class="md-nav__link">
       Callbacks in training
     </a>
   </li>


   <li class="md-nav__item">
     <a href="../../api/metric/" title="Evaluation Metrics" class="md-nav__link">
       Evaluation Metrics
     </a>
   </li>


   <li class="md-nav__item">
     <a href="../../api/io/" title="Data Providers" class="md-nav__link">
       Data Providers
     </a>
   </li>


   <li class="md-nav__item">
     <a href="../../api/ndarray/" title="NDArray API" class="md-nav__link">
       NDArray API
     </a>
   </li>


   <li class="md-nav__item">
     <a href="../../api/symbolic-node/" title="Symbolic API" class="md-nav__link">
       Symbolic API
     </a>
   </li>


   <li class="md-nav__item">
     <a href="../../api/nn-factory/" title="Neural Networks Factory" class="md-nav__link">
       Neural Networks Factory
     </a>
   </li>


   <li class="md-nav__item">
     <a href="../../api/executor/" title="Executor" class="md-nav__link">
       Executor
     </a>
   </li>


   <li class="md-nav__item">
     <a href="../../api/kvstore/" title="Key-Value Store" class="md-nav__link">
       Key-Value Store
     </a>
   </li>


   <li class="md-nav__item">
     <a href="../../api/visualize/" title="Network Visualization" class="md-nav__link">
       Network Visualization
     </a>
   </li>


       </ul>
     </nav>
   </li>


   </ul>
 </nav>
                   </div>
                 </div>
               </div>


               <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
                 <div class="md-sidebar__scrollwrap">
                   <div class="md-sidebar__inner">

 <nav class="md-nav md-nav--secondary">


     <label class="md-nav__title" for="__toc">Table of contents</label>
     <ul class="md-nav__list" data-md-scrollfix>

         <li class="md-nav__item">
   <a href="#automatic-installation" class="md-nav__link">
     Automatic Installation
   </a>

 </li>


     </ul>

 </nav>
                   </div>
                 </div>
               </div>


           <div class="md-content">
             <article class="md-content__inner md-typeset">


                   <a href="https://github.com/apache/mxnet/tree/master/edit/master/docs/user-guide/install.md" title="Edit this page" class="md-icon md-content__icon">&#xE3C9;</a>


                 <!–- Licensed to the Apache Software Foundation (ASF) under one –> <!–- or more contributor license agreements.  See the NOTICE file –> <!–- distributed with this work for additional information –> <!–- regarding copyright ownership.  The ASF licenses this file –> <!–- to you under the Apache License, Version 2.0 (the –> <!–- "License"); you may not use this file except in compliance –> <!–- with the License.  You may obtain a copy of the License at –>

 <!–-   http://www.apache.org/licenses/LICENSE-2.0 –>

 <!–- Unless required by applicable law or agreed to in writing, –> <!–- software distributed under the License is distributed on an –> <!–- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY –> <!–- KIND, either express or implied.  See the License for the –> <!–- specific language governing permissions and limitations –> <!–- under the License. –>

 <p><a id='Installation-Guide-1'></a></p>
 <h1 id="installation-guide">Installation Guide</h1>
 <p><a id='Automatic-Installation-1'></a></p>
 <h2 id="automatic-installation">Automatic Installation</h2>
 <p>To install MXNet.jl, simply type</p>
 <pre><code class="julia">Pkg.add(&quot;MXNet&quot;)
 </code></pre>

 <p>In the Julia REPL. Or to use the latest git version of MXNet.jl, use the following command instead</p>
 <pre><code class="julia">Pkg.checkout(&quot;MXNet&quot;)
 </code></pre>

 <p>MXNet.jl is built on top of <a href="https://github.com/apache/mxnet">libmxnet</a>. Upon installation, Julia will try to automatically download and build libmxnet.</p>
 <p>There are several environment variables that change this behaviour.</p>
 <ul>
 <li><code>MXNET_HOME</code>: If you already have a pre-installed version of mxnet you can use <code>MXNET_HOME</code> to point the build-process in the right direction.</li>
 <li><code>CUDA_HOME</code>: If the automatic cuda detection fails you can also set <code>CUDA_HOME</code> to override the process.</li>
 <li><code>MXNET_COMMIT</code>: To control which version of libmxnet will be compiled, you can use the<code>MXNET_COMMIT</code> variable to point to either a version tag (e.g. <code>v0.10.0</code>), a branch name (e.g. <code>master</code>) or a specific commit hash (e.g. <code>a0b1c2d3</code>).</li>
 <li><code>CC</code>: The path of C compiler.</li>
 <li><code>CXX</code>: The path of C++ compiler.</li>
 <li><code>ADD_CFLAGS</code>: Additional C flags. For instance, if you need to point non-standard include directory, please set it as <code>ENV["ADD_CFLAGS"] = "-I'/path/to/include/dir'"</code>.</li>
 <li><code>ADD_LDFLAGS</code>: Additional linker flags.</li>
 <li>
 <p><code>USE_JEMALLOC</code>: Default is enabled if jemalloc available. If you ran into segfault cause by jemalloc, Please try to disable it.</p>
 <p>```julia</p>
 <h1 id="first-remove-whole-libmxnet-source-pkgdirmxnet-deps-src">first remove whole libmxnet source: Pkg.dir("MXNet", "deps", "src")</h1>
 <p>ENV["USE_JEMALLOC"] = "0"
 Pkg.build("MXNet")
 ```</p>
 </li>
 </ul>
 <p>The libmxnet source is downloaded to <code>Pkg.dir("MXNet", "deps", "src", "mxnet")</code>. The automatic build is using default configurations, with OpenCV disabled. If the compilation failed due to unresolved dependency, or if you want to customize the build, you can compile and install libmxnet manually. Please see below for more details.</p>
 <p><a id='Manual-Compilation-1'></a></p>
 <h2 id="manual-compilation">Manual Compilation</h2>
 <p>It is possible to compile libmxnet separately and point MXNet.jl to a existing library in case automatic compilation fails due to unresolved dependencies in an non-standard environment; Or when one want to work with a separate, maybe customized libmxnet.</p>
 <p>To build libmxnet, please refer to <a href="https://mxnet.apache.org/install/index.html">the installation guide of libmxnet</a>. After successfully installing libmxnet, set the <code>MXNET_HOME</code> <em>environment variable</em> to the location of libmxnet. In other words, the compiled <code>libmxnet.so</code> should be found in <code>$MXNET_HOME/lib</code>.</p>
 <blockquote>
 <p><strong>note</strong></p>
 <p>The constant <code>MXNET_HOME</code> is pre-compiled in MXNet.jl package cache. If you updated the environment variable after installing MXNet.jl, make sure to update the pre-compilation cache by <code>Base.compilecache("MXNet")</code>.</p>
 </blockquote>
 <p>When the <code>MXNET_HOME</code> environment variable is detected and the corresponding <code>libmxnet.so</code> could be loaded successfully, MXNet.jl will skip automatic building during installation and use the specified libmxnet instead.</p>
 <p>Basically, MXNet.jl will search <code>libmxnet.so</code> or <code>libmxnet.dll</code> in the following paths (and in that order):</p>
 <ul>
 <li><code>$MXNET_HOME/lib</code>: customized libmxnet builds</li>
 <li><code>Pkg.dir("MXNet", "deps", "usr", "lib")</code>: automatic builds</li>
 <li>Any system wide library search path</li>
 </ul>
 <p>Note that MXNet.jl can not load <code>libmxnet.so</code> even if it is on one of the paths above in case a library it depends upon is missing from the <code>LD_LIBRARY_PATH</code>. Thus, if you are going to compile to add CUDA, the path to the CUDA libraries will have to be added to <code>LD_LIBRARY_PATH</code>.</p>


             </article>
           </div>
         </div>
       </main>


 <footer class="md-footer">

     <div class="md-footer-nav">
       <nav class="md-footer-nav__inner md-grid">

           <a href="../../tutorial/char-lstm/" title="Generating Random Sentence with LSTM RNN" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
             <div class="md-flex__cell md-flex__cell--shrink">
               <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
             </div>
             <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
               <span class="md-flex__ellipsis">
                 <span class="md-footer-nav__direction">
                   Previous
                 </span>
                 Generating Random Sentence with LSTM RNN
               </span>
             </div>
           </a>


           <a href="../overview/" title="Overview" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
             <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
               <span class="md-flex__ellipsis">
                 <span class="md-footer-nav__direction">
                   Next
                 </span>
                 Overview
               </span>
             </div>
             <div class="md-flex__cell md-flex__cell--shrink">
               <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
             </div>
           </a>

       </nav>
     </div>

   <div class="md-footer-meta md-typeset">
     <div class="md-footer-meta__inner md-grid">
       <div class="md-footer-copyright">

         powered by
         <a href="https://www.mkdocs.org">MkDocs</a>
         and
         <a href="https://squidfunk.github.io/mkdocs-material/">
           Material for MkDocs</a>
       </div>

     </div>
   </div>
 </footer>

     </div>

       <script src="../../assets/javascripts/application.808e90bb.js"></script>

       <script>app.initialize({version:"1.0.4",url:{base:"../.."}})</script>

         <script src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML"></script>

         <script src="../../assets/mathjaxhelper.js"></script>


   </body>
 </html>




	<!doctype html>
	<html lang="en" class="no-js">
	<head>

	<meta charset="utf-8">
	<meta name="viewport" content="width=device-width,initial-scale=1">
	<meta http-equiv="x-ua-compatible" content="ie=edge">




	<meta name="lang:clipboard.copy" content="Copy to clipboard">

	<meta name="lang:clipboard.copied" content="Copied to clipboard">

	<meta name="lang:search.language" content="en">

	<meta name="lang:search.pipeline.stopwords" content="True">

	<meta name="lang:search.pipeline.trimmer" content="True">

	<meta name="lang:search.result.none" content="No matching documents">

	<meta name="lang:search.result.one" content="1 matching document">

	<meta name="lang:search.result.other" content="# matching documents">

	<meta name="lang:search.tokenizer" content="[\s\-]+">

	<link rel="shortcut icon" href="../../assets/images/favicon.png">
	<meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.6.0">



	<title>Installation Guide - MXNet.jl</title>



	<link rel="stylesheet" href="../../assets/stylesheets/application.1b62728e.css">




	<script src="../../assets/javascripts/modernizr.268332fc.js"></script>



	<link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
	<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
	<style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>


	<link rel="stylesheet" href="../../assets/fonts/material-icons.css">


	<link rel="stylesheet" href="../../assets/Documenter.css">





	</head>

	<body dir="ltr">

	<svg class="md-svg">
	<defs>


	<svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" viewBox="0 0 416 448" id="__github"><path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z"/></svg>

	</defs>
	</svg>
	<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
	<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
	<label class="md-overlay" data-md-component="overlay" for="__drawer"></label>

	<a href="#installation-guide" tabindex="1" class="md-skip">
	Skip to content
	</a>


	<header class="md-header" data-md-component="header">
	<nav class="md-header-nav md-grid">
	<div class="md-flex">
	<div class="md-flex__cell md-flex__cell--shrink">
	<a href="../.." title="MXNet.jl" class="md-header-nav__button md-logo">

	<i class="md-icon"></i>

	</a>
	</div>
	<div class="md-flex__cell md-flex__cell--shrink">
	<label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
	</div>
	<div class="md-flex__cell md-flex__cell--stretch">
	<div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">

	<span class="md-header-nav__topic">
	MXNet.jl
	</span>
	<span class="md-header-nav__topic">

	Installation Guide

	</span>

	</div>
	</div>
	<div class="md-flex__cell md-flex__cell--shrink">

	<label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>

	<div class="md-search" data-md-component="search" role="dialog">
	<label class="md-search__overlay" for="__search"></label>
	<div class="md-search__inner" role="search">
	<form class="md-search__form" name="search">
	<input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
	<label class="md-icon md-search__icon" for="__search"></label>
	<button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
	
	</button>
	</form>
	<div class="md-search__output">
	<div class="md-search__scrollwrap" data-md-scrollfix>
	<div class="md-search-result" data-md-component="result">
	<div class="md-search-result__meta">
	Type to start searching
	</div>
	<ol class="md-search-result__list"></ol>
	</div>
	</div>
	</div>
	</div>
	</div>

	</div>

	<div class="md-flex__cell md-flex__cell--shrink">
	<div class="md-header-nav__source">





	<a href="https://github.com/apache/mxnet/tree/master/julia#mxnet/" title="Go to repository" class="md-source" data-md-source="github">

	<div class="md-source__icon">
	<svg viewBox="0 0 24 24" width="24" height="24">
	<use xlink:href="#__github" width="24" height="24"></use>
	</svg>
	</div>

	<div class="md-source__repository">
	GitHub
	</div>
	</a>
	</div>
	</div>

	</div>
	</nav>
	</header>

	<div class="md-container">




	<main class="md-main" role="main">
	<div class="md-main__inner md-grid" data-md-component="container">


	<div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
	<div class="md-sidebar__scrollwrap">
	<div class="md-sidebar__inner">
	<nav class="md-nav md-nav--primary" data-md-level="0">
	<label class="md-nav__title md-nav__title--site" for="__drawer">
	<a href="../.." title="MXNet.jl" class="md-nav__button md-logo">

	<i class="md-icon"></i>

	</a>
	MXNet.jl
	</label>

	<div class="md-nav__source">





	<a href="https://github.com/apache/mxnet/tree/master/julia#mxnet/" title="Go to repository" class="md-source" data-md-source="github">

	<div class="md-source__icon">
	<svg viewBox="0 0 24 24" width="24" height="24">
	<use xlink:href="#__github" width="24" height="24"></use>
	</svg>
	</div>

	<div class="md-source__repository">
	GitHub
	</div>
	</a>
	</div>

	<ul class="md-nav__list" data-md-scrollfix>






	<li class="md-nav__item">
	<a href="../.." title="Home" class="md-nav__link">
	Home
	</a>
	</li>







	<li class="md-nav__item md-nav__item--nested">

	<input class="md-toggle md-nav__toggle" data-md-toggle="nav-2" type="checkbox" id="nav-2">

	<label class="md-nav__link" for="nav-2">
	Tutorial
	</label>
	<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
	<label class="md-nav__title" for="nav-2">
	Tutorial
	</label>
	<ul class="md-nav__list" data-md-scrollfix>







	<li class="md-nav__item">
	<a href="../../tutorial/mnist/" title="Digit Recognition on MNIST" class="md-nav__link">
	Digit Recognition on MNIST
	</a>
	</li>







	<li class="md-nav__item">
	<a href="../../tutorial/char-lstm/" title="Generating Random Sentence with LSTM RNN" class="md-nav__link">
	Generating Random Sentence with LSTM RNN
	</a>
	</li>


	</ul>
	</nav>
	</li>









	<li class="md-nav__item md-nav__item--active md-nav__item--nested">

	<input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3" checked>

	<label class="md-nav__link" for="nav-3">
	User Guide
	</label>
	<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
	<label class="md-nav__title" for="nav-3">
	User Guide
	</label>
	<ul class="md-nav__list" data-md-scrollfix>









	<li class="md-nav__item md-nav__item--active">

	<input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">




	<label class="md-nav__link md-nav__link--active" for="__toc">
	Installation Guide
	</label>

	<a href="./" title="Installation Guide" class="md-nav__link md-nav__link--active">
	Installation Guide
	</a>


	<nav class="md-nav md-nav--secondary">





	<label class="md-nav__title" for="__toc">Table of contents</label>
	<ul class="md-nav__list" data-md-scrollfix>

	<li class="md-nav__item">
	<a href="#automatic-installation" class="md-nav__link">
	Automatic Installation
	</a>

	</li>





	</ul>

	</nav>

	</li>







	<li class="md-nav__item">
	<a href="../overview/" title="Overview" class="md-nav__link">
	Overview
	</a>
	</li>







	<li class="md-nav__item">
	<a href="../faq/" title="FAQ" class="md-nav__link">
	FAQ
	</a>
	</li>


	</ul>
	</nav>
	</li>







	<li class="md-nav__item md-nav__item--nested">

	<input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">

	<label class="md-nav__link" for="nav-4">
	API Documentation
	</label>
	<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
	<label class="md-nav__title" for="nav-4">
	API Documentation
	</label>
	<ul class="md-nav__list" data-md-scrollfix>







	<li class="md-nav__item">
	<a href="../../api/context/" title="Context" class="md-nav__link">
	Context
	</a>
	</li>







	<li class="md-nav__item">
	<a href="../../api/model/" title="Models" class="md-nav__link">
	Models
	</a>
	</li>







	<li class="md-nav__item">
	<a href="../../api/initializer/" title="Initializers" class="md-nav__link">
	Initializers
	</a>
	</li>







	<li class="md-nav__item">
	<a href="../../api/optimizer/" title="Optimizers" class="md-nav__link">
	Optimizers
	</a>
	</li>







	<li class="md-nav__item">
	<a href="../../api/callback/" title="Callbacks in training" class="md-nav__link">
	Callbacks in training
	</a>
	</li>







	<li class="md-nav__item">
	<a href="../../api/metric/" title="Evaluation Metrics" class="md-nav__link">
	Evaluation Metrics
	</a>
	</li>







	<li class="md-nav__item">
	<a href="../../api/io/" title="Data Providers" class="md-nav__link">
	Data Providers
	</a>
	</li>







	<li class="md-nav__item">
	<a href="../../api/ndarray/" title="NDArray API" class="md-nav__link">
	NDArray API
	</a>
	</li>







	<li class="md-nav__item">
	<a href="../../api/symbolic-node/" title="Symbolic API" class="md-nav__link">
	Symbolic API
	</a>
	</li>







	<li class="md-nav__item">
	<a href="../../api/nn-factory/" title="Neural Networks Factory" class="md-nav__link">
	Neural Networks Factory
	</a>
	</li>







	<li class="md-nav__item">
	<a href="../../api/executor/" title="Executor" class="md-nav__link">
	Executor
	</a>
	</li>







	<li class="md-nav__item">
	<a href="../../api/kvstore/" title="Key-Value Store" class="md-nav__link">
	Key-Value Store
	</a>
	</li>







	<li class="md-nav__item">
	<a href="../../api/visualize/" title="Network Visualization" class="md-nav__link">
	Network Visualization
	</a>
	</li>


	</ul>
	</nav>
	</li>


	</ul>
	</nav>
	</div>
	</div>
	</div>


	<div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
	<div class="md-sidebar__scrollwrap">
	<div class="md-sidebar__inner">

	<nav class="md-nav md-nav--secondary">





	<label class="md-nav__title" for="__toc">Table of contents</label>
	<ul class="md-nav__list" data-md-scrollfix>

	<li class="md-nav__item">
	<a href="#automatic-installation" class="md-nav__link">
	Automatic Installation
	</a>

	</li>





	</ul>

	</nav>
	</div>
	</div>
	</div>


	<div class="md-content">
	<article class="md-content__inner md-typeset">


	<a href="https://github.com/apache/mxnet/tree/master/edit/master/docs/user-guide/install.md" title="Edit this page" class="md-icon md-content__icon"></a>


	<!–- Licensed to the Apache Software Foundation (ASF) under one –> <!–- or more contributor license agreements. See the NOTICE file –> <!–- distributed with this work for additional information –> <!–- regarding copyright ownership. The ASF licenses this file –> <!–- to you under the Apache License, Version 2.0 (the –> <!–- "License"); you may not use this file except in compliance –> <!–- with the License. You may obtain a copy of the License at –>

	<!–- http://www.apache.org/licenses/LICENSE-2.0 –>

	<!–- Unless required by applicable law or agreed to in writing, –> <!–- software distributed under the License is distributed on an –> <!–- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY –> <!–- KIND, either express or implied. See the License for the –> <!–- specific language governing permissions and limitations –> <!–- under the License. –>

	<p><a id='Installation-Guide-1'></a></p>
	<h1 id="installation-guide">Installation Guide</h1>
	<p><a id='Automatic-Installation-1'></a></p>
	<h2 id="automatic-installation">Automatic Installation</h2>
	<p>To install MXNet.jl, simply type</p>
	<pre><code class="julia">Pkg.add("MXNet")
	</code></pre>

	<p>In the Julia REPL. Or to use the latest git version of MXNet.jl, use the following command instead</p>
	<pre><code class="julia">Pkg.checkout("MXNet")
	</code></pre>

	<p>MXNet.jl is built on top of <a href="https://github.com/apache/mxnet">libmxnet</a>. Upon installation, Julia will try to automatically download and build libmxnet.</p>
	<p>There are several environment variables that change this behaviour.</p>
	<ul>
	<li><code>MXNET_HOME</code>: If you already have a pre-installed version of mxnet you can use <code>MXNET_HOME</code> to point the build-process in the right direction.</li>
	<li><code>CUDA_HOME</code>: If the automatic cuda detection fails you can also set <code>CUDA_HOME</code> to override the process.</li>
	<li><code>MXNET_COMMIT</code>: To control which version of libmxnet will be compiled, you can use the<code>MXNET_COMMIT</code> variable to point to either a version tag (e.g. <code>v0.10.0</code>), a branch name (e.g. <code>master</code>) or a specific commit hash (e.g. <code>a0b1c2d3</code>).</li>
	<li><code>CC</code>: The path of C compiler.</li>
	<li><code>CXX</code>: The path of C++ compiler.</li>
	<li><code>ADD_CFLAGS</code>: Additional C flags. For instance, if you need to point non-standard include directory, please set it as <code>ENV["ADD_CFLAGS"] = "-I'/path/to/include/dir'"</code>.</li>
	<li><code>ADD_LDFLAGS</code>: Additional linker flags.</li>
	<li>
	<p><code>USE_JEMALLOC</code>: Default is enabled if jemalloc available. If you ran into segfault cause by jemalloc, Please try to disable it.</p>
	<p>```julia</p>
	<h1 id="first-remove-whole-libmxnet-source-pkgdirmxnet-deps-src">first remove whole libmxnet source: Pkg.dir("MXNet", "deps", "src")</h1>
	<p>ENV["USE_JEMALLOC"] = "0"
	Pkg.build("MXNet")
	```</p>
	</li>
	</ul>
	<p>The libmxnet source is downloaded to <code>Pkg.dir("MXNet", "deps", "src", "mxnet")</code>. The automatic build is using default configurations, with OpenCV disabled. If the compilation failed due to unresolved dependency, or if you want to customize the build, you can compile and install libmxnet manually. Please see below for more details.</p>
	<p><a id='Manual-Compilation-1'></a></p>
	<h2 id="manual-compilation">Manual Compilation</h2>
	<p>It is possible to compile libmxnet separately and point MXNet.jl to a existing library in case automatic compilation fails due to unresolved dependencies in an non-standard environment; Or when one want to work with a separate, maybe customized libmxnet.</p>
	<p>To build libmxnet, please refer to <a href="https://mxnet.apache.org/install/index.html">the installation guide of libmxnet</a>. After successfully installing libmxnet, set the <code>MXNET_HOME</code> <em>environment variable</em> to the location of libmxnet. In other words, the compiled <code>libmxnet.so</code> should be found in <code>$MXNET_HOME/lib</code>.</p>
	<blockquote>
	<p><strong>note</strong></p>
	<p>The constant <code>MXNET_HOME</code> is pre-compiled in MXNet.jl package cache. If you updated the environment variable after installing MXNet.jl, make sure to update the pre-compilation cache by <code>Base.compilecache("MXNet")</code>.</p>
	</blockquote>
	<p>When the <code>MXNET_HOME</code> environment variable is detected and the corresponding <code>libmxnet.so</code> could be loaded successfully, MXNet.jl will skip automatic building during installation and use the specified libmxnet instead.</p>
	<p>Basically, MXNet.jl will search <code>libmxnet.so</code> or <code>libmxnet.dll</code> in the following paths (and in that order):</p>
	<ul>
	<li><code>$MXNET_HOME/lib</code>: customized libmxnet builds</li>
	<li><code>Pkg.dir("MXNet", "deps", "usr", "lib")</code>: automatic builds</li>
	<li>Any system wide library search path</li>
	</ul>
	<p>Note that MXNet.jl can not load <code>libmxnet.so</code> even if it is on one of the paths above in case a library it depends upon is missing from the <code>LD_LIBRARY_PATH</code>. Thus, if you are going to compile to add CUDA, the path to the CUDA libraries will have to be added to <code>LD_LIBRARY_PATH</code>.</p>










	</article>
	</div>
	</div>
	</main>


	<footer class="md-footer">

	<div class="md-footer-nav">
	<nav class="md-footer-nav__inner md-grid">

	<a href="../../tutorial/char-lstm/" title="Generating Random Sentence with LSTM RNN" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
	<div class="md-flex__cell md-flex__cell--shrink">
	<i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
	</div>
	<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
	<span class="md-flex__ellipsis">
	<span class="md-footer-nav__direction">
	Previous
	</span>
	Generating Random Sentence with LSTM RNN
	</span>
	</div>
	</a>


	<a href="../overview/" title="Overview" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
	<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
	<span class="md-flex__ellipsis">
	<span class="md-footer-nav__direction">
	Next
	</span>
	Overview
	</span>
	</div>
	<div class="md-flex__cell md-flex__cell--shrink">
	<i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
	</div>
	</a>

	</nav>
	</div>

	<div class="md-footer-meta md-typeset">
	<div class="md-footer-meta__inner md-grid">
	<div class="md-footer-copyright">

	powered by
	<a href="https://www.mkdocs.org">MkDocs</a>
	and
	<a href="https://squidfunk.github.io/mkdocs-material/">
	Material for MkDocs</a>
	</div>

	</div>
	</div>
	</footer>

	</div>

	<script src="../../assets/javascripts/application.808e90bb.js"></script>

	<script>app.initialize({version:"1.0.4",url:{base:"../.."}})</script>

	<script src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML"></script>

	<script src="../../assets/mathjaxhelper.js"></script>


	</body>
	</html>