You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mxnet.apache.org by la...@apache.org on 2019/03/13 20:07:44 UTC
[incubator-mxnet] branch master updated: [MXNET-1226] add Docs
update for MXNet Java (#14395)
This is an automated email from the ASF dual-hosted git repository.
lanking pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-mxnet.git
The following commit(s) were added to refs/heads/master by this push:
new 4432af1 [MXNET-1226] add Docs update for MXNet Java (#14395)
4432af1 is described below
commit 4432af1f47a439517eff9a21bef23ef7ae5e4aa4
Author: Lanking <la...@live.com>
AuthorDate: Wed Mar 13 13:07:19 2019 -0700
[MXNET-1226] add Docs update for MXNet Java (#14395)
* add Docs update for MXNet Java
* fixed based on comments
* Update docs/install/java_setup.md
Co-Authored-By: lanking520 <la...@live.com>
* Update docs/tutorials/java/mxnet_java_on_intellij.md
Co-Authored-By: lanking520 <la...@live.com>
---
docs/install/index.md | 6 ++---
docs/install/java_setup.md | 32 ++++++---------------------
docs/tutorials/java/mxnet_java_on_intellij.md | 17 +++-----------
3 files changed, 13 insertions(+), 42 deletions(-)
diff --git a/docs/install/index.md b/docs/install/index.md
index eab1c82..f1e959e 100644
--- a/docs/install/index.md
+++ b/docs/install/index.md
@@ -505,7 +505,7 @@ You can use the Maven packages defined in the following dependency to include MX
<br/>
You can use the Maven packages defined in the following dependency to include MXNet in your Java project. The Java API is provided as a subset of the Scala API and is intended for inference only. Please refer to the <a href="java_setup.html">MXNet-Java setup guide</a> for a detailed set of instructions to help you with the setup process.
-<a href="https://repository.apache.org/#nexus-search;gav~org.apache.mxnet~~1.4.0-SNAPSHOT~~"><img src="https://img.shields.io/badge/org.apache.mxnet-linux gpu-green.svg" alt="maven badge"/></a>
+<a href="https://repository.apache.org/#nexus-search;gav~org.apache.mxnet~~1.4.0~~"><img src="https://img.shields.io/badge/org.apache.mxnet-linux gpu-green.svg" alt="maven badge"/></a>
```html
<dependency>
@@ -522,7 +522,7 @@ You can use the Maven packages defined in the following dependency to include MX
<br/>
You can use the Maven packages defined in the following dependency to include MXNet in your Java project. The Java API is provided as a subset of the Scala API and is intended for inference only. Please refer to the <a href="java_setup.html">MXNet-Java setup guide</a> for a detailed set of instructions to help you with the setup process.
-<a href="https://repository.apache.org/#nexus-search;gav~org.apache.mxnet~~1.4.0-SNAPSHOT~~"><img src="https://img.shields.io/badge/org.apache.mxnet-linux cpu-green.svg" alt="maven badge"/></a>
+<a href="https://repository.apache.org/#nexus-search;gav~org.apache.mxnet~~1.4.0~~"><img src="https://img.shields.io/badge/org.apache.mxnet-linux cpu-green.svg" alt="maven badge"/></a>
```html
<dependency>
@@ -810,7 +810,7 @@ Not available at this time. <br>
</br>
You can use the Maven packages defined in the following dependency to include MXNet in your Java project. The Java API is provided as a subset of the Scala API and is intended for inference only. Please refer to the <a href="java_setup.html">MXNet-Java setup guide</a> for a detailed set of instructions to help you with the setup process.
-<a href="https://repository.apache.org/#nexus-search;gav~org.apache.mxnet~~1.4.0-SNAPSHOT~~"><img src="https://img.shields.io/badge/org.apache.mxnet-mac cpu-green.svg" alt="maven badge"/></a>
+<a href="https://repository.apache.org/#nexus-search;gav~org.apache.mxnet~~1.4.0~~"><img src="https://img.shields.io/badge/org.apache.mxnet-mac cpu-green.svg" alt="maven badge"/></a>
```html
<dependency>
diff --git a/docs/install/java_setup.md b/docs/install/java_setup.md
index 569f439..ce4a4ab 100644
--- a/docs/install/java_setup.md
+++ b/docs/install/java_setup.md
@@ -35,21 +35,15 @@ The following instructions are provided for macOS and Ubuntu. Windows is not yet
brew update
brew tap caskroom/versions
brew cask install java8
-brew install opencv
brew install maven
```
**Ubuntu Steps**
-These scripts will install Maven and its dependencies. You will be running the Scala scripts because the MXNet-Java project has a dependency on the MXNet-Scala project.
+Please run the following lines:
```bash
-wget https://raw.githubusercontent.com/apache/incubator-mxnet/master/ci/docker/install/ubuntu_core.sh
-wget https://raw.githubusercontent.com/apache/incubator-mxnet/master/ci/docker/install/ubuntu_scala.sh
-chmod +x ubuntu_core.sh
-chmod +x ubuntu_scala.sh
-sudo ./ubuntu_core.sh
-sudo ./ubuntu_scala.sh
+sudo apt-get install openjdk-8-java maven
```
**Step 2.** Run the demo MXNet-Java project.
@@ -58,25 +52,14 @@ Go to the [MXNet-Java demo project's README](https://github.com/apache/incubator
#### Maven Repository
-MXNet-Java can be easily included in your Maven managed project. The Java packages are currently available as nightly builds on Maven. Add the following Maven repository to your `pom.xml` to fetch the Java packages :
-
-```html
-<repositories>
- <repository>
- <id>Apache Snapshot</id>
- <url>https://repository.apache.org/content/groups/snapshots</url>
- </repository>
-</repositories>
-```
-
-Also, add the dependency which corresponds to your platform to the `dependencies` tag :
+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 `dependencies` tag :
**Linux CPU**
```html
<dependency>
<groupId>org.apache.mxnet</groupId>
<artifactId>mxnet-full_2.11-linux-x86_64-cpu</artifactId>
- <version>1.4.0-SNAPSHOT</version>
+ <version>1.4.0</version>
</dependency>
```
@@ -85,7 +68,7 @@ Also, add the dependency which corresponds to your platform to the `dependencies
<dependency>
<groupId>org.apache.mxnet</groupId>
<artifactId>mxnet-full_2.11-linux-x86_64-gpu</artifactId>
- <version>1.4.0-SNAPSHOT</version>
+ <version>1.4.0</version>
</dependency>
```
@@ -94,12 +77,11 @@ Also, add the dependency which corresponds to your platform to the `dependencies
<dependency>
<groupId>org.apache.mxnet</groupId>
<artifactId>mxnet-full_2.11-osx-x86_64-cpu</artifactId>
- <version>1.4.0-SNAPSHOT</version>
+ <version>1.4.0</version>
</dependency>
```
-
-The official Java Packages will be released with the release of MXNet 1.4 and will be available on [MXNet Maven package repository](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.apache.mxnet%22).
+The official Java Packages have been released as part of MXNet 1.4 and are available on the [MXNet Maven package repository](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.apache.mxnet%22).
<hr>
### Eclipse IDE Support
diff --git a/docs/tutorials/java/mxnet_java_on_intellij.md b/docs/tutorials/java/mxnet_java_on_intellij.md
index ce84788..d95aabd 100644
--- a/docs/tutorials/java/mxnet_java_on_intellij.md
+++ b/docs/tutorials/java/mxnet_java_on_intellij.md
@@ -102,27 +102,16 @@ Set the project's location. The rest of the settings can be left as their defaul
After clicking Finish, you will be presented with the project's first view.
The project's `pom.xml` will be open for editing.
-**Step 3.** The Java packages are currently available as nightly builds on Maven. Add the following Maven repository to your `pom.xml` to fetch the Java packages :
-
-```html
-<repositories>
- <repository>
- <id>Apache Snapshot</id>
- <url>https://repository.apache.org/content/groups/snapshots</url>
- </repository>
-</repositories>
-```
-
-Also, add this under the `dependencies` tag :
+**Step 3.** The Java packages are currently available on Maven. Add the following under the `dependencies` tag :
```html
<dependency>
<groupId>org.apache.mxnet</groupId>
<artifactId>mxnet-full_2.11-osx-x86_64-cpu</artifactId>
- <version>1.4.0-SNAPSHOT</version>
+ <version>1.4.0</version>
</dependency>
```
-The official Java Packages will be released with the release of MXNet 1.4 and will be available on [MXNet Maven package repository](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.apache.mxnet%22).
+The official Java Packages have been released as part of MXNet 1.4 and are available on the [MXNet Maven package repository](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.apache.mxnet%22).
Note :
- Change the osx-x86_64 to linux-x86_64 if your platform is linux.