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 2018/11/27 17:31:12 UTC

[incubator-mxnet] branch master updated: Minor fixes to documentation (#13412)

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 e14482d  Minor fixes to documentation (#13412)
e14482d is described below

commit e14482d828aeff8ec30b80136b52fdfd87c4defb
Author: Piyush Ghai <gh...@osu.edu>
AuthorDate: Tue Nov 27 09:30:55 2018 -0800

    Minor fixes to documentation (#13412)
    
    * Minor fixes to documentation
    
    * Updated the Maven Repository URL to point to staging repo
---
 docs/tutorials/java/mxnet_java_on_intellij.md | 26 ++++++++++++++++++--------
 docs/tutorials/java/ssd_inference.md          |  2 +-
 2 files changed, 19 insertions(+), 9 deletions(-)

diff --git a/docs/tutorials/java/mxnet_java_on_intellij.md b/docs/tutorials/java/mxnet_java_on_intellij.md
index 349aa5f..f4d4ea5 100644
--- a/docs/tutorials/java/mxnet_java_on_intellij.md
+++ b/docs/tutorials/java/mxnet_java_on_intellij.md
@@ -65,7 +65,7 @@ mxnet
 ```
 **ArtifactId**
 ```
-ArtifactId: javaMXNet
+javaMXNet
 ```
 **Version**
 ```
@@ -85,17 +85,27 @@ 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.** Add the following Maven dependency to your `pom.xml` file under the `dependencies` tag: 
+**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 :
+
+```html
 <dependency>
   <groupId>org.apache.mxnet</groupId>
   <artifactId>mxnet-full_2.11-osx-x86_64-cpu</artifactId>
-  <version>1.4.0</version>
+  <version>1.3.1-SNAPSHOT</version>
 </dependency>
 ```
-
-To view the latest MXNet Maven packages, you can check [MXNet Maven package repository](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.apache.mxnet%22)
+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).
 
 Note :
 - Change the osx-x86_64 to linux-x86_64 if your platform is linux.
@@ -113,8 +123,8 @@ Click "Import Changes" in this prompt.
 **Step 5.** Build the project:
 - To build the project, from the menu choose Build, and then choose Build Project.
 
-**Step 6.** Navigate to the App.java class in the project and paste the code from HelloWorld.java from [Java Demo project](https://github.com/apache/incubator-mxnet/blob/java-api/scala-package/mxnet-demo/java-demo/src/main/java/sample/HelloWorld.java) on MXNet repository, overwriting the original hello world code.
-You can also grab the entire [Java Demo project](https://github.com/apache/incubator-mxnet/tree/java-api/scala-package/mxnet-demo/java-demo) and run it by following the instructions on the [README](https://github.com/apache/incubator-mxnet/blob/java-api/scala-package/mxnet-demo/java-demo/README.md)
+**Step 6.** Navigate to the App.java class in the project and paste the code in `main` method from HelloWorld.java from [Java Demo project](https://github.com/apache/incubator-mxnet/blob/java-api/scala-package/mxnet-demo/java-demo/src/main/java/sample/HelloWorld.java) on MXNet repository, overwriting the original hello world code.
+You can also grab the entire [Java Demo project](https://github.com/apache/incubator-mxnet/tree/java-api/scala-package/mxnet-demo/java-demo) and run it by following the instructions on the [README](https://github.com/apache/incubator-mxnet/blob/java-api/scala-package/mxnet-demo/java-demo/README.md).
 
 **Step 7.** Now run the App.java. 
 
@@ -159,7 +169,7 @@ The build generates a new jar file in the `target` folder called `javaMXNet-1.0-
 
 To run the App.java use the following command from the project's root folder and you should see the same output as we got when the project was run from IntelliJ.
 ```bash
-java -cp target/javaMXNet-1.0-SNAPSHOT.jar:target/dependency/* mxnet.App
+java -cp "target/javaMXNet-1.0-SNAPSHOT.jar:target/dependency/*" mxnet.App
 ```
 
 ## Next Steps
diff --git a/docs/tutorials/java/ssd_inference.md b/docs/tutorials/java/ssd_inference.md
index a16469d..3a20329 100644
--- a/docs/tutorials/java/ssd_inference.md
+++ b/docs/tutorials/java/ssd_inference.md
@@ -156,7 +156,7 @@ The build generates a new jar file in the `target` folder called `javaMXNet-1.0-
 
 To run the ObjectDetectionTutorial.java use the following command from the project's root folder.
 ```bash
-java -cp target/javaMXNet-1.0-SNAPSHOT.jar:target/dependency/* mxnet.ObjectDetectionTutorial
+java -cp "target/javaMXNet-1.0-SNAPSHOT.jar:target/dependency/*" mxnet.ObjectDetectionTutorial
 ```
     
 You should see a similar output being generated for the dog image that we used: