From 94628410fcfbe88e795ceb6679e454379ff2c1a1 Mon Sep 17 00:00:00 2001 From: Zach Kimberg Date: Tue, 19 Feb 2019 12:36:47 -0800 Subject: [PATCH] Scala interpreter instructions (#14169) --- docs/install/scala_setup.md | 28 ++++++++++++++++++++++++++++ docs/tutorials/scala/char_lstm.md | 6 +----- 2 files changed, 29 insertions(+), 5 deletions(-) diff --git a/docs/install/scala_setup.md b/docs/install/scala_setup.md index bc069a14e6b3..15a2def1ef38 100644 --- a/docs/install/scala_setup.md +++ b/docs/install/scala_setup.md @@ -20,6 +20,7 @@ The following instructions are provided for macOS and Ubuntu. Windows is not yet available. **Note:** If you use IntelliJ or a similar IDE, you may want to follow the [MXNet-Scala on IntelliJ tutorial](../tutorials/scala/mxnet_scala_on_intellij.html) instead of these instructions. +**Note:** Currently, we only support scala 2.11
@@ -114,6 +115,33 @@ mvn install
+## Interpreter + +To run the scala interpreter, first download and install scala 2.11.x (run `scala -version` to make sure you have the right version installed.** + +### Installing the Interpreter + +**Ubuntu*** + +``` +sudo apt-get install scala +``` + +**macOS*** + +``` +brew install scala@2.11 +``` + +Then, add scala to your path by following the instructions output by homebrew. + +### Running the Interpreter + +To run the interpreter, download the appropriate mxnet jar from [the maven repository](https://search.maven.org/search?q=g:org.apache.mxnet) or build from source following the instructions above. + +Then, run `scala -cp {path/to/mxnet-full_2.11-os-version.jar}` to start it. +If you receive a "NumberFormatException" when running the interpreter, run `export TERM=xterm-color` before starting the interpreter. + ## Documentation Scaladocs are generated as part of the docs build pipeline. You can find them published in the [Scala API](http://mxnet.incubator.apache.org/api/scala/index.html) section of the website or by going to the [scaladocs output](https://mxnet.incubator.apache.org/api/scala/docs/index.html#org.apache.mxnet.package) directly. diff --git a/docs/tutorials/scala/char_lstm.md b/docs/tutorials/scala/char_lstm.md index 972661bc81ef..aca08dc79920 100644 --- a/docs/tutorials/scala/char_lstm.md +++ b/docs/tutorials/scala/char_lstm.md @@ -71,11 +71,7 @@ In this tutorial, you will accomplish the following: ## Prerequisites -To complete this tutorial, you need: - -- MXNet. See the instructions for your operating system in [Setup and Installation](http://mxnet.io/install/index.html) -- [Scala 2.11.8](https://www.scala-lang.org/download/2.11.8.html) -- [Maven 3](https://maven.apache.org/install.html) +To complete this tutorial, setup and run the scala interpreter by following the [instructions](https://mxnet.incubator.apache.org/install/scala_setup.html#interpreter). ## Download the Data