Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

[MXNET-1226] add Docs update for MXNet Java #14395

Merged
merged 4 commits into from
Mar 13, 2019
Merged

[MXNET-1226] add Docs update for MXNet Java #14395

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6a339d3
add Docs update for MXNet Java
lanking520 Mar 11, 2019
14c7803
fixed based on comments
lanking520 Mar 12, 2019
7e09566
Update docs/install/java_setup.md
zachgk Mar 13, 2019
8c84327
Update docs/tutorials/java/mxnet_java_on_intellij.md
zachgk Mar 13, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/install/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand All @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
32 changes: 7 additions & 25 deletions docs/install/java_setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's going on here?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need to install openCV for Java, not any more

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So all of the dependencies for ubuntu/scala/mxnet environment are covered with this change? I'm skeptical.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We no longer require user to install that bunch... Simply Java and maven would work

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.
Expand All @@ -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>
```

Expand All @@ -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>
```

Expand All @@ -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 are released with the release of MXNet 1.4 and are now available on the [MXNet Maven package repository](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.apache.mxnet%22).
lanking520 marked this conversation as resolved.
Show resolved Hide resolved
<hr>

### Eclipse IDE Support
Expand Down
17 changes: 3 additions & 14 deletions docs/tutorials/java/mxnet_java_on_intellij.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 are released with the release of MXNet 1.4 and are now available on the [MXNet Maven package repository](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.apache.mxnet%22).
lanking520 marked this conversation as resolved.
Show resolved Hide resolved

Note :
- Change the osx-x86_64 to linux-x86_64 if your platform is linux.
Expand Down