diff --git a/scala-package/mxnet-demo/java-demo/README.md b/scala-package/mxnet-demo/java-demo/README.md index accc4abcf9c7..cad52cbc44cb 100644 --- a/scala-package/mxnet-demo/java-demo/README.md +++ b/scala-package/mxnet-demo/java-demo/README.md @@ -16,9 +16,15 @@ # MXNet Java Sample Project -This is an project created to use Maven-published Scala/Java package with two Java examples. +This is a project demonstrating how to use the Maven published Scala/Java MXNet package. +The examples provided include: +* NDArray creation +* NDArray operation +* Object Detection using the Inference API +* Image Classification using the Predictor API + ## Setup -You are required to use Maven to build the package with the following commands: +You are required to use Maven to build the package with the following commands under `java-demo`: ``` mvn package ``` @@ -43,7 +49,7 @@ The `SCALA_PKG_PROFILE` should be chosen from `osx-x86_64-cpu`, `linux-x86_64-cp ## Run ### NDArrayCreation -The Scala file is being executed using Java. You can execute the helloWorld example as follows: +The Scala file is being executed using Java. You can execute the `NDArrayCreation` example as follows: ```Bash bash bin/java_sample.sh ``` @@ -51,7 +57,7 @@ You can also run the following command manually: ```Bash java -cp $CLASSPATH sample.NDArrayCreation ``` -However, you have to define the Classpath before you run the demo code. More information can be found in the `java_sample.sh`. +However, you have to define the Classpath before you run the demo code. More information can be found in `bin/java_sample.sh`. The `CLASSPATH` should point to the jar file you have downloaded. It will load the library automatically and run the example diff --git a/scala-package/mxnet-demo/java-demo/bin/java_sample.sh b/scala-package/mxnet-demo/java-demo/bin/java_sample.sh index e3f80e0dd5db..fb1795f20f9d 100755 --- a/scala-package/mxnet-demo/java-demo/bin/java_sample.sh +++ b/scala-package/mxnet-demo/java-demo/bin/java_sample.sh @@ -17,4 +17,4 @@ #!/bin/bash CURR_DIR=$(cd $(dirname $0)/../; pwd) CLASSPATH=$CLASSPATH:$CURR_DIR/target/*:$CLASSPATH:$CURR_DIR/target/dependency/* -java -Xmx8G -cp $CLASSPATH mxnet.NDArrayCreation \ No newline at end of file +java -Xmx8G -cp $CLASSPATH mxnet.NDArrayCreation diff --git a/scala-package/mxnet-demo/java-demo/bin/run_od.sh b/scala-package/mxnet-demo/java-demo/bin/run_od.sh index abd0bf5b1b93..4370518dc8cd 100755 --- a/scala-package/mxnet-demo/java-demo/bin/run_od.sh +++ b/scala-package/mxnet-demo/java-demo/bin/run_od.sh @@ -17,4 +17,4 @@ #!/bin/bash CURR_DIR=$(cd $(dirname $0)/../; pwd) CLASSPATH=$CLASSPATH:$CURR_DIR/target/*:$CLASSPATH:$CURR_DIR/target/dependency/* -java -Xmx8G -cp $CLASSPATH mxnet.ObjectDetection \ No newline at end of file +java -Xmx8G -cp $CLASSPATH mxnet.ObjectDetection