| <!DOCTYPE html> |
| |
| <!--- |
| 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. |
| --> |
| |
| <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="/versions/1.9.1/assets/img/mxnet-icon.png" rel="icon" type="image/png"><!-- Begin Jekyll SEO tag v2.6.1 --> |
| <title>Scala Setup | Apache MXNet</title> |
| <meta name="generator" content="Jekyll v3.8.6" /> |
| <meta property="og:title" content="Scala 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/versions/1.9.1/get_started/scala_setup" /> |
| <meta property="og:url" content="https://mxnet.apache.org/versions/1.9.1/get_started/scala_setup" /> |
| <meta property="og:site_name" content="Apache MXNet" /> |
| <script type="application/ld+json"> |
| {"description":"A flexible and efficient library for deep learning.","headline":"Scala Setup","@type":"WebPage","url":"https://mxnet.apache.org/versions/1.9.1/get_started/scala_setup","@context":"https://schema.org"}</script> |
| <!-- End Jekyll SEO tag --> |
| <link rel="stylesheet" href="/versions/1.9.1/assets/docsearch.min.css" /><link rel="stylesheet" href="/versions/1.9.1/assets/main.css"><link type="application/atom+xml" rel="alternate" href="https://mxnet.apache.org/versions/1.9.1/feed.xml" title="Apache MXNet" /><!-- Matomo --> |
| <script> |
| var _paq = window._paq = window._paq || []; |
| /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ |
| /* We explicitly disable cookie tracking to avoid privacy issues */ |
| _paq.push(['disableCookies']); |
| _paq.push(['trackPageView']); |
| _paq.push(['enableLinkTracking']); |
| (function() { |
| var u="https://analytics.apache.org/"; |
| _paq.push(['setTrackerUrl', u+'matomo.php']); |
| _paq.push(['setSiteId', '23']); |
| var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; |
| g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); |
| })(); |
| </script> |
| <!-- End Matomo Code --> |
| |
| <script src="/versions/1.9.1/assets/js/jquery-3.3.1.min.js"></script> |
| <script src="/versions/1.9.1/assets/js/docsearch.min.js"></script><script src="/versions/1.9.1/assets/js/globalSearch.js" defer></script> |
| <script src="/versions/1.9.1/assets/js/clipboard.js" defer></script> |
| <script src="/versions/1.9.1/assets/js/copycode.js" defer></script></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.9.1/"><img |
| src="/versions/1.9.1/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="gs-search-border"> |
| <div id="gs-search-icon"></div> |
| <form id="global-search-form"> |
| <input id="global-search" type="text" title="Search" placeholder="Search" /> |
| <div id="global-search-dropdown-container"> |
| <button class="gs-current-version btn" type="button" data-toggle="dropdown"> |
| <span id="gs-current-version-label">1.9.1</span> |
| <svg class="gs-dropdown-caret" viewBox="0 0 32 32" class="icon icon-caret-bottom" aria-hidden="true"> |
| <path class="dropdown-caret-path" d="M24 11.305l-7.997 11.39L8 11.305z"></path> |
| </svg> |
| </button> |
| <ul class="gs-opt-group gs-version-dropdown"> |
| |
| |
| <li class="gs-opt gs-versions">master</li> |
| |
| |
| |
| <li class="gs-opt gs-versions active">1.9.1</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.8.0</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.7.0</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.6.0</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.5.0</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.4.1</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.3.1</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.2.1</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.1.0</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.0.0</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">0.12.1</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">0.11.0</li> |
| |
| |
| </ul> |
| </div> |
| <span id="global-search-close">x</span> |
| </form> |
| </div> |
| <div class="trigger"> |
| <div id="global-search-mobile-border"> |
| <div id="gs-search-icon-mobile"></div> |
| <input id="global-search-mobile" placeholder="Search..." type="text"/> |
| <div id="global-search-dropdown-container-mobile"> |
| <button class="gs-current-version-mobile btn" type="button" data-toggle="dropdown"> |
| <svg class="gs-dropdown-caret" viewBox="0 0 32 32" class="icon icon-caret-bottom" aria-hidden="true"> |
| <path class="dropdown-caret-path" d="M24 11.305l-7.997 11.39L8 11.305z"></path> |
| </svg> |
| </button> |
| <ul class="gs-opt-group gs-version-dropdown-mobile"> |
| |
| |
| <li class="gs-opt gs-versions">master</li> |
| |
| |
| |
| <li class="gs-opt gs-versions active">1.9.1</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.8.0</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.7.0</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.6.0</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.5.0</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.4.1</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.3.1</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.2.1</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.1.0</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">1.0.0</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">0.12.1</li> |
| |
| |
| |
| <li class="gs-opt gs-versions">0.11.0</li> |
| |
| |
| </ul> |
| </div> |
| </div> |
| <a class="page-link" href="/versions/1.9.1/get_started">Get Started</a> |
| <a class="page-link" href="/versions/1.9.1/features">Features</a> |
| <a class="page-link" href="/versions/1.9.1/ecosystem">Ecosystem</a> |
| <a class="page-link" href="/versions/1.9.1/api">Docs & Tutorials</a> |
| <a class="page-link" href="/versions/1.9.1/trusted_by">Trusted By</a> |
| <a class="page-link" href="https://github.com/apache/mxnet">GitHub</a> |
| <div class="dropdown" style="min-width:100px"> |
| <span class="dropdown-header">Apache |
| <svg class="dropdown-caret" viewBox="0 0 32 32" class="icon icon-caret-bottom" aria-hidden="true"><path class="dropdown-caret-path" d="M24 11.305l-7.997 11.39L8 11.305z"></path></svg> |
| </span> |
| <div class="dropdown-content" style="min-width:250px"> |
| <a href="https://www.apache.org/foundation/">Apache Software Foundation</a> |
| <a href="https://www.apache.org/licenses/">License</a> |
| <a href="/versions/1.9.1/api/faq/security.html">Security</a> |
| <a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy</a> |
| <a href="https://www.apache.org/events/current-event">Events</a> |
| <a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a> |
| <a href="https://www.apache.org/foundation/thanks.html">Thanks</a> |
| </div> |
| </div> |
| <div class="dropdown"> |
| <span class="dropdown-header">1.9.1 |
| <svg class="dropdown-caret" viewBox="0 0 32 32" class="icon icon-caret-bottom" aria-hidden="true"><path class="dropdown-caret-path" d="M24 11.305l-7.997 11.39L8 11.305z"></path></svg> |
| </span> |
| <div class="dropdown-content"> |
| <a href="/">master</a> |
| <a class="dropdown-option-active" href="/versions/1.9.1/">1.9.1</a> |
| <a href="/versions/1.8.0/">1.8.0</a> |
| <a href="/versions/1.7.0/">1.7.0</a> |
| <a 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">Scala Setup</h1> |
| <h3></h3><a style="float:left; margin-top:20px" href="/versions/1.9.1/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-scala">Setup the MXNet Package for Scala</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.9.1/api/scala/docs/tutorials/mxnet_scala_on_intellij">MXNet-Scala on IntelliJ tutorial</a> instead of these instructions. |
| <strong>Note:</strong> Currently, we only support scala 2.11</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>opencv |
| brew <span class="nb">install </span>maven |
| </code></pre></div> |
| <p><strong>Ubuntu Steps</strong></p> |
| |
| <p>These scripts will install Maven and its dependencies.</p> |
| <div class="highlight"><pre><code class="language-bash" data-lang="bash">wget https://raw.githubusercontent.com/apache/mxnet/master/ci/docker/install/ubuntu_core.sh |
| wget https://raw.githubusercontent.com/apache/mxnet/master/ci/docker/install/ubuntu_scala.sh |
| <span class="nb">chmod</span> +x ubuntu_core.sh |
| <span class="nb">chmod</span> +x ubuntu_scala.sh |
| <span class="nb">sudo</span> ./ubuntu_core.sh |
| <span class="nb">sudo</span> ./ubuntu_scala.sh |
| </code></pre></div> |
| <p><strong>Step 2.</strong> Run the demo MXNet-Scala project.</p> |
| |
| <p>Go to the <a href="https://github.com/apache/mxnet/tree/master/scala-package/mxnet-demo">MXNet-Scala demo project's README</a> and follow the directions to test the MXNet-Scala package installation.</p> |
| |
| <h4 id="maven-repository">Maven Repository</h4> |
| |
| <p>Package information can be found in the Maven Repository: |
| <a href="https://mvnrepository.com/artifact/org.apache.mxnet">https://mvnrepository.com/artifact/org.apache.mxnet</a></p> |
| |
| <p><strong>Linux CPU</strong> |
| <code>html |
| <!-- https://mvnrepository.com/artifact/org.apache.mxnet/mxnet-full_2.11-linux-x86_64-cpu --> |
| <dependency> |
| <groupId>org.apache.mxnet</groupId> |
| <artifactId>mxnet-full_2.11-linux-x86_64-cpu</artifactId> |
| </dependency> |
| </code></p> |
| |
| <p><strong>Linux GPU</strong> |
| <code>html |
| <!-- https://mvnrepository.com/artifact/org.apache.mxnet/mxnet-full_2.11-linux-x86_64-gpu --> |
| <dependency> |
| <groupId>org.apache.mxnet</groupId> |
| <artifactId>mxnet-full_2.11-linux-x86_64-gpu</artifactId> |
| </dependency> |
| </code></p> |
| |
| <p><strong>macOS CPU</strong> |
| <code>html |
| <!-- https://mvnrepository.com/artifact/org.apache.mxnet/mxnet-full_2.11-osx-x86_64-cpu --> |
| <dependency> |
| <groupId>org.apache.mxnet</groupId> |
| <artifactId>mxnet-full_2.11-osx-x86_64-cpu</artifactId> |
| </dependency> |
| </code></p> |
| |
| <p><strong>NOTE:</strong> You may specify the version you wish to use by adding the version number to the <code>dependency</code> block. For example, to use v1.2.0 you would add <code><version>1.2.0</version></code>. Otherwise Maven will use the latest version available.</p> |
| |
| <p><hr></p> |
| |
| <h2 id="source">Source</h2> |
| |
| <p>The previously mentioned setup with Maven is recommended. Otherwise, the following instructions for macOS, Ubuntu, and Windows 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/mxnet/issues/10549" data-size="large" data-show-count="true" aria-label="Issue apache/mxnet on GitHub"></td> |
| <td><a class="github-button" href="https://github.com/apache/mxnet/issues/10549" data-size="large" data-show-count="true" aria-label="Issue apache/mxnet on GitHub">Call for Contribution</a></td> |
| </tr> |
| </tbody></table> |
| |
| <h4 id="build-scala-from-an-existing-mxnet-installation">Build Scala from an Existing MXNet Installation</h4> |
| |
| <p>If you have already built MXNet <strong>from source</strong> and are looking to setup Scala 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><hr></p> |
| |
| <h2 id="interpreter">Interpreter</h2> |
| |
| <p>To run the scala interpreter, first download and install scala 2.11.x (run <code>scala -version</code> to make sure you have the right version installed.**</p> |
| |
| <h3 id="installing-the-interpreter">Installing the Interpreter</h3> |
| |
| <p><strong>Ubuntu</strong>*</p> |
| <div class="highlight"><pre><code class="language-" data-lang="">sudo apt-get install scala |
| </code></pre></div> |
| <p><strong>macOS</strong>*</p> |
| <div class="highlight"><pre><code class="language-" data-lang="">brew install scala@2.11 |
| </code></pre></div> |
| <p>Then, add scala to your path by following the instructions output by homebrew.</p> |
| |
| <h3 id="running-the-interpreter">Running the Interpreter</h3> |
| |
| <p>To run the interpreter, download the appropriate mxnet jar from <a href="https://search.maven.org/search?q=g:org.apache.mxnet">the maven repository</a> or build from source following the instructions above.</p> |
| |
| <p>Then, run <code>scala -cp {path/to/mxnet-full_2.11-os-version.jar}</code> to start it. |
| If you receive a "NumberFormatException" when running the interpreter, run <code>export TERM=xterm-color</code> before starting the interpreter.</p> |
| |
| <h2 id="documentation">Documentation</h2> |
| |
| <p>Scaladocs are generated as part of the docs build pipeline. You can find them published in the <a href="/versions/1.9.1/api/scala">Scala API</a> section of the website or by going to the <a href="/versions/1.9.1/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/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.9.1/api/scala">Scala API</a></li> |
| <li><a href="/versions/1.9.1/api/scala/docs/api/#org.apache.mxnet.package">scaladocs</a></li> |
| <li><a href="/versions/1.9.1/api/scala/docs/tutorials">MXNet-Scala 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.9.1/community/contribute#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/mxnet/labels/Roadmap">Github Roadmap</a></li> |
| <li><a href="https://medium.com/apache-mxnet">Blog</a></li> |
| <li><a href="https://discuss.mxnet.io">Forum</a></li> |
| <li><a href="/versions/1.9.1/community/contribute">Contribute</a></li> |
| </ul> |
| </div> |
| |
| <div class="col-4"><ul class="social-media-list"><li><a href="https://github.com/apache/mxnet"><svg class="svg-icon"><use xlink:href="/versions/1.9.1/assets/minima-social-icons.svg#github"></use></svg> <span class="username">apache/mxnet</span></a></li><li><a href="https://www.twitter.com/apachemxnet"><svg class="svg-icon"><use xlink:href="/versions/1.9.1/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.9.1/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.9.1/assets/img/asf_logo.svg" class="footer-logo col-2"> |
| </div> |
| <div class="footer-bottom-warning col-9"> |
| </p><p>"Copyright © 2017-2022, The Apache Software Foundation. Licensed under the Apache License, Version 2.0. 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> |
