| <!DOCTYPE html> |
| <html lang=" en"><head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <link href="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/mxnet-icon.png" rel="icon" type="image/png"><!-- Begin Jekyll SEO tag v2.6.1 --> |
| <title>Java Setup | Apache MXNet</title> |
| <meta name="generator" content="Jekyll v3.8.6" /> |
| <meta property="og:title" content="Java Setup" /> |
| <meta property="og:locale" content="en_US" /> |
| <meta name="description" content="A flexible and efficient library for deep learning." /> |
| <meta property="og:description" content="A flexible and efficient library for deep learning." /> |
| <link rel="canonical" href="https://mxnet.apache.org/get_started/java_setup" /> |
| <meta property="og:url" content="https://mxnet.apache.org/get_started/java_setup" /> |
| <meta property="og:site_name" content="Apache MXNet" /> |
| <script type="application/ld+json"> |
| {"description":"A flexible and efficient library for deep learning.","headline":"Java Setup","@type":"WebPage","url":"https://mxnet.apache.org/get_started/java_setup","@context":"https://schema.org"}</script> |
| <!-- End Jekyll SEO tag --> |
| <script src="https://medium-widget.pixelpoint.io/widget.js"></script> |
| <link rel="stylesheet" href="/versions/1.6.0/assets/main.css"><link type="application/atom+xml" rel="alternate" href="https://mxnet.apache.org/feed.xml" title="Apache MXNet" /><script> |
| if(!(window.doNotTrack === "1" || navigator.doNotTrack === "1" || navigator.doNotTrack === "yes" || navigator.msDoNotTrack === "1")) { |
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ |
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), |
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) |
| })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); |
| |
| ga('create', 'UA-96378503-1', 'auto'); |
| ga('send', 'pageview'); |
| } |
| </script> |
| |
| <script src="https://code.jquery.com/jquery-3.3.1.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script> |
| |
| <script src="/versions/1.6.0/assets/js/clipboard.js"></script> |
| <script src="/versions/1.6.0/assets/js/copycode.js"></script> |
| <script src="/versions/1.6.0/assets/js/globalSearch.js"></script> |
| <style> |
| .dropdown { |
| position: relative; |
| display: inline-block; |
| } |
| |
| .dropdown-content { |
| display: none; |
| position: absolute; |
| background-color: #f9f9f9; |
| min-width: 160px; |
| box-shadow: 0px 8px 16px 0px rgba(0,0,0,0.2); |
| padding: 12px 16px; |
| z-index: 1; |
| text-align: left; |
| } |
| |
| .dropdown:hover .dropdown-content { |
| display: block; |
| } |
| </style> |
| </head> |
| <body><header class="site-header" role="banner"> |
| |
| <script> |
| $(document).ready(function () { |
| |
| // HEADER OPACITY LOGIC |
| |
| function opacity_header() { |
| var value = "rgba(4,140,204," + ($(window).scrollTop() / 300 + 0.4) + ")" |
| $('.site-header').css("background-color", value) |
| } |
| |
| $(window).scroll(function () { |
| opacity_header() |
| }) |
| opacity_header(); |
| |
| // MENU SELECTOR LOGIC |
| $('.page-link').each( function () { |
| if (window.location.href.includes(this.href)) { |
| $(this).addClass("page-current"); |
| } |
| }); |
| }) |
| </script> |
| <div class="wrapper"> |
| <a class="site-title" rel="author" href="/versions/1.6.0/"><img |
| src="/versions/1.6.0/assets/img/mxnet_logo.png" class="site-header-logo"></a> |
| <nav class="site-nav"> |
| <input type="checkbox" id="nav-trigger" class="nav-trigger"/> |
| <label for="nav-trigger"> |
| <span class="menu-icon"> |
| <svg viewBox="0 0 18 15" width="18px" height="15px"> |
| <path d="M18,1.484c0,0.82-0.665,1.484-1.484,1.484H1.484C0.665,2.969,0,2.304,0,1.484l0,0C0,0.665,0.665,0,1.484,0 h15.032C17.335,0,18,0.665,18,1.484L18,1.484z M18,7.516C18,8.335,17.335,9,16.516,9H1.484C0.665,9,0,8.335,0,7.516l0,0 c0-0.82,0.665-1.484,1.484-1.484h15.032C17.335,6.031,18,6.696,18,7.516L18,7.516z M18,13.516C18,14.335,17.335,15,16.516,15H1.484 C0.665,15,0,14.335,0,13.516l0,0c0-0.82,0.665-1.483,1.484-1.483h15.032C17.335,12.031,18,12.695,18,13.516L18,13.516z"/> |
| </svg> |
| </span> |
| </label> |
| |
| <div class="trigger"> |
| <a class="page-link" href="/versions/1.6.0/get_started">Get Started</a> |
| <a class="page-link" href="/versions/1.6.0/blog">Blog</a> |
| <a class="page-link" href="/versions/1.6.0/features">Features</a> |
| <a class="page-link" href="/versions/1.6.0/ecosystem">Ecosystem</a> |
| <a class="page-link" href="/versions/1.6.0/api">Docs & Tutorials</a> |
| <a class="page-link" href="https://github.com/apache/incubator-mxnet">GitHub</a> |
| <div class="dropdown"> |
| <span style="display:inline-flex;">1.6.0 |
| <svg viewBox="0 0 32 32" class="icon icon-caret-bottom" aria-hidden="true" style="width: 18px;"><path d="M24 11.305l-7.997 11.39L8 11.305z" style="fill: white;"></path></svg> |
| </span> |
| <div class="dropdown-content"> |
| <a href="/">master</a> |
| <a href="/versions/1.7.0/">1.7.0</a> |
| <a style="color:#FF4500;" href="/versions/1.6.0/">1.6.0</a> |
| <a href="/versions/1.5.0/">1.5.0</a> |
| <a href="/versions/1.4.1/">1.4.1</a> |
| <a href="/versions/1.3.1/">1.3.1</a> |
| <a href="/versions/1.2.1/">1.2.1</a> |
| <a href="/versions/1.1.0/">1.1.0</a> |
| <a href="/versions/1.0.0/">1.0.0</a> |
| <a href="/versions/0.12.1/">0.12.1</a> |
| <a href="/versions/0.11.0/">0.11.0</a> |
| </div> |
| </div> |
| </div> |
| </nav> |
| </div> |
| </header> |
| <main class="page-content" aria-label="Content"> |
| <script> |
| |
| </script> |
| <article class="post"> |
| |
| <header class="post-header wrapper"> |
| <h1 class="post-title">Java Setup</h1> |
| <h3></h3><a style="float:left; margin-top:20px" href="/versions/1.6.0/get_started" class="btn btn-action">Get Started |
| <span class="span-accented">›</span></a></header> |
| |
| <div class="post-content"> |
| <div class="wrapper"> |
| <!--- 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. --> |
| |
| <h1 id="setup-the-mxnet-package-for-java">Setup the MXNet Package for Java</h1> |
| |
| <p>The following instructions are provided for macOS and Ubuntu. Windows is not yet available.</p> |
| |
| <p><strong>Note:</strong> If you use IntelliJ or a similar IDE, you may want to follow the <a href="/versions/1.6.0/api/java/docs/tutorials/mxnet_java_on_intellij">MXNet-Java on IntelliJ tutorial</a> instead of these instructions.</p> |
| |
| <p><hr></p> |
| |
| <h2 id="maven">Maven</h2> |
| |
| <h3 id="setup-instructions">Setup Instructions</h3> |
| |
| <p><strong>Step 1.</strong> Install dependencies:</p> |
| |
| <p><strong>macOS Steps</strong></p> |
| <div class="highlight"><pre><code class="language-bash" data-lang="bash">brew update |
| brew tap caskroom/versions |
| brew cask <span class="nb">install </span>java8 |
| brew <span class="nb">install </span>maven |
| </code></pre></div> |
| <p><strong>Ubuntu Steps</strong></p> |
| |
| <p>Please run the following lines:</p> |
| <div class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nb">sudo </span>apt-get <span class="nb">install </span>openjdk-8-jdk maven |
| </code></pre></div> |
| <p><strong>Step 2.</strong> Run the demo MXNet-Java project.</p> |
| |
| <p>Go to the <a href="https://github.com/apache/incubator-mxnet/tree/master/scala-package/mxnet-demo/java-demo">MXNet-Java demo project's README</a> and follow the directions to test the MXNet-Java package installation.</p> |
| |
| <h4 id="maven-repository">Maven Repository</h4> |
| |
| <p>MXNet-Java can be easily included in your Maven managed project. The Java packages are currently available on Maven. Add the dependency which corresponds to your platform to the <code>dependencies</code> tag :</p> |
| |
| <p><strong>Linux CPU</strong> |
| <code>html |
| <dependency> |
| <groupId>org.apache.mxnet</groupId> |
| <artifactId>mxnet-full_2.11-linux-x86_64-cpu</artifactId> |
| <version>1.4.0</version> |
| </dependency> |
| </code></p> |
| |
| <p><strong>Linux GPU</strong> |
| <code>html |
| <dependency> |
| <groupId>org.apache.mxnet</groupId> |
| <artifactId>mxnet-full_2.11-linux-x86_64-gpu</artifactId> |
| <version>1.4.0</version> |
| </dependency> |
| </code></p> |
| |
| <p><strong>macOS CPU</strong> |
| <code>html |
| <dependency> |
| <groupId>org.apache.mxnet</groupId> |
| <artifactId>mxnet-full_2.11-osx-x86_64-cpu</artifactId> |
| <version>1.4.0</version> |
| </dependency> |
| </code></p> |
| |
| <p>The official Java Packages have been released as part of MXNet 1.4 and are available on the <a href="https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.apache.mxnet%22">MXNet Maven package repository</a>. |
| <hr></p> |
| |
| <h3 id="eclipse-ide-support">Eclipse IDE Support</h3> |
| |
| <p>You can convert your existing Maven project to a project that can run in Eclipse by: |
| <code> |
| mvn eclipse:eclipse |
| </code> |
| This can be done once you have your maven project properly configured.</p> |
| |
| <h2 id="source">Source</h2> |
| |
| <p>The previously mentioned setup with Maven is recommended. Otherwise, the following instructions for macOS and Ubuntu are provided for reference only:</p> |
| |
| <p><strong>If you have already built mxnet from source using <code>cmake</code>, run <code>make clean</code> and then follow the appropriate guide below</strong>*</p> |
| |
| <table><thead> |
| <tr> |
| <th>OS</th> |
| <th>Step 1</th> |
| <th>Step 2</th> |
| </tr> |
| </thead><tbody> |
| <tr> |
| <td>macOS</td> |
| <td><a href="osx_setup.html#build-the-shared-library">Shared Library for macOS</a></td> |
| <td><a href="osx_setup.html#install-the-mxnet-package-for-scala">Scala Package for macOS</a></td> |
| </tr> |
| <tr> |
| <td>Ubuntu</td> |
| <td><a href="ubuntu_setup.html#installing-mxnet-on-ubuntu">Shared Library for Ubuntu</a></td> |
| <td><a href="ubuntu_setup.html#install-the-mxnet-package-for-scala">Scala Package for Ubuntu</a></td> |
| </tr> |
| <tr> |
| <td>Windows</td> |
| <td><a class="github-button" href="https://github.com/apache/incubator-mxnet/issues/10549" data-size="large" data-show-count="true" aria-label="Issue apache/incubator-mxnet on GitHub"></td> |
| <td><a class="github-button" href="https://github.com/apache/incubator-mxnet/issues/10549" data-size="large" data-show-count="true" aria-label="Issue apache/incubator-mxnet on GitHub">Call for Contribution</a></td> |
| </tr> |
| </tbody></table> |
| |
| <h4 id="build-java-from-an-existing-mxnet-installation">Build Java from an Existing MXNet Installation</h4> |
| |
| <p>If you have already built MXNet <strong>from source</strong> and are looking to setup Java from that point, you may simply run the following from the MXNet <code>scala-package</code> folder:</p> |
| <div class="highlight"><pre><code class="language-" data-lang="">mvn install |
| </code></pre></div> |
| <p>This will install both the Java Inference API and the required MXNet-Scala package. |
| <hr></p> |
| |
| <h2 id="documentation">Documentation</h2> |
| |
| <p>Javadocs are generated as part of the docs build pipeline. You can find them published in the <a href="/versions/1.6.0/api/java">Java API</a> section of the website or by going to the <a href="/versions/1.6.0/api/scala/docs/api/#org.apache.mxnet.package">scaladocs output</a> directly.</p> |
| |
| <p>To build the docs yourself, follow the <a href="https://github.com/apache/incubator-mxnet/tree/master/docs/README.md">developer build docs instructions</a>.</p> |
| |
| <p><hr></p> |
| |
| <h2 id="resources">Resources</h2> |
| |
| <ul> |
| <li><a href="/versions/1.6.0/api/java">Java API</a></li> |
| <li><a href="/versions/1.6.0/api/scala/docs/api/#org.apache.mxnet.package">javadocs</a></li> |
| <li><a href="/versions/1.6.0/api/java/docs/tutorials">MXNet-Java Tutorials</a></li> |
| </ul> |
| |
| </div> |
| </div> |
| |
| </article> |
| |
| </main><footer class="site-footer h-card"> |
| <div class="wrapper"> |
| <div class="row"> |
| <div class="col-4"> |
| <h4 class="footer-category-title">Resources</h4> |
| <ul class="contact-list"> |
| <li><a href="/versions/1.6.0/community/contribute.html#mxnet-dev-communications">Mailing lists</a></li> |
| <li><a href="https://cwiki.apache.org/confluence/display/MXNET/Apache+MXNet+Home">Developer Wiki</a></li> |
| <li><a href="https://issues.apache.org/jira/projects/MXNET/issues">Jira Tracker</a></li> |
| <li><a href="https://github.com/apache/incubator-mxnet/labels/Roadmap">Github Roadmap</a></li> |
| <li><a href="https://discuss.mxnet.io">MXNet Discuss forum</a></li> |
| <li><a href="/versions/1.6.0/community/contribute.html">Contribute To MXNet</a></li> |
| |
| </ul> |
| </div> |
| |
| <div class="col-4"><ul class="social-media-list"><li><a href="https://github.com/apache/incubator-mxnet"><svg class="svg-icon"><use xlink:href="/versions/1.6.0/assets/minima-social-icons.svg#github"></use></svg> <span class="username">apache/incubator-mxnet</span></a></li><li><a href="https://www.twitter.com/apachemxnet"><svg class="svg-icon"><use xlink:href="/versions/1.6.0/assets/minima-social-icons.svg#twitter"></use></svg> <span class="username">apachemxnet</span></a></li><li><a href="https://youtube.com/apachemxnet"><svg class="svg-icon"><use xlink:href="/versions/1.6.0/assets/minima-social-icons.svg#youtube"></use></svg> <span class="username">apachemxnet</span></a></li></ul> |
| </div> |
| |
| <div class="col-4 footer-text"> |
| <p>A flexible and efficient library for deep learning.</p> |
| </div> |
| </div> |
| </div> |
| </footer> |
| <footer class="site-footer2"> |
| <div class="wrapper"> |
| <div class="row"> |
| <div class="col-3"> |
| <img src="/versions/1.6.0/assets/img/apache_incubator_logo.png" class="footer-logo col-2"> |
| </div> |
| <div class="footer-bottom-warning col-9"> |
| <p>Apache MXNet is an effort undergoing incubation at The Apache Software Foundation (ASF), <span |
| style="font-weight:bold">sponsored by the <i>Apache Incubator</i></span>. Incubation is required |
| of all newly accepted projects until a further review indicates that the infrastructure, |
| communications, and decision making process have stabilized in a manner consistent with other |
| successful ASF projects. While incubation status is not necessarily a reflection of the completeness |
| or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF. |
| </p><p>"Copyright © 2017-2018, The Apache Software Foundation Apache MXNet, MXNet, Apache, the Apache |
| feather, and the Apache MXNet project logo are either registered trademarks or trademarks of the |
| Apache Software Foundation."</p> |
| </div> |
| </div> |
| </div> |
| </footer> |
| |
| |
| |
| |
| </body> |
| |
| </html> |
