comments added

apache · Mar 21, 2018 · 22fcac1 · 22fcac1
1 parent 03e67b0
commit 22fcac1
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 4 deletions.
diff --git a/scala-package/examples/scripts/inferexample/imageclassifier/get_resnet_data.sh b/scala-package/examples/scripts/inferexample/imageclassifier/get_resnet_data.sh
@@ -21,9 +21,9 @@ set -e
 
 MXNET_ROOT=$(cd "$(dirname $0)/../../.."; pwd)
 
-data_path=$MXNET_ROOT/examples/scripts/inferexample/imageclassifier/data
+data_path=$MXNET_ROOT/scripts/inferexample/imageclassifier/resnet
 
-image_path=$MXNET_ROOT/examples/scripts/inferexample/imageclassifier/image
+image_path=$MXNET_ROOT/scripts/inferexample/imageclassifier/images
 
 if [ ! -d "$data_path" ]; then
   mkdir -p "$data_path"

diff --git a/...ain/scala/ml/dmlc/mxnetexamples/inferexample/imageclassifier/ImageClassifierExample.scala b/...ain/scala/ml/dmlc/mxnetexamples/inferexample/imageclassifier/ImageClassifierExample.scala
@@ -27,6 +27,10 @@ import ml.dmlc.mxnet.infer._
 import scala.collection.JavaConverters._
 import java.io.File
 
+/**
+  * Example showing usage of Infer package to do inference on resnet-152 model
+  * Follow instructions in README.md to run this example.
+  */
 object ImageClassifierExample {
   private val logger = LoggerFactory.getLogger(classOf[ImageClassifierExample])
 

diff --git a/...les/src/main/scala/ml/dmlc/mxnetexamples/inferexample/imageclassifier/README.md b/...les/src/main/scala/ml/dmlc/mxnetexamples/inferexample/imageclassifier/README.md
@@ -19,13 +19,15 @@ provided by MXNet Scala package.
 For this tutorial, you can get the model and sample input image by running following bash file.
 
   ```bash
+  cd incubator-mxnet/scala-package/examples/scripts/inferexample/imageclassifier/
   bash get_resnet_data.sh
   ```
 
 ## How to run
 
   ```bash
-  bash scala-package/examples/scripts/inferexample/run_predictor_example.sh  /resnet/resnet-152  /images/Cat-hd-wallpapers.jpg  /images/
+  cd incubator-mxnet/scala-package/examples/scripts/inferexample/imageclassifier/
+  bash run_classifier_example.sh resnet/resnet-152 images/Cat-hd-wallpapers.jpg images/
   ```
 
 There are few options which you can provide to run the example, one can list them by passing `--help`.
@@ -42,7 +44,7 @@ They are also listed as following:
 
 We provide multiple pre-trained models on various datasets. Use
 [Python modelzoo.py](https://github.com/dmlc/mxnet/blob/master/example/image-classification/common/modelzoo.py)
-to download these models. These models can be also be downloaded from [here](http://data.mxnet.io/models/imagenet/)
+to download these models. These models can be also be downloaded from [here](http://data.mxnet.io/models/imagenet/).
 
 ## Infer APIs used
 

diff --git a/...cala/ml/dmlc/mxnetexamples/inferexample/imageclassifier/ImageClassifierExampleSuite.scala b/...cala/ml/dmlc/mxnetexamples/inferexample/imageclassifier/ImageClassifierExampleSuite.scala
@@ -23,6 +23,10 @@ import ml.dmlc.mxnet.{DType}
 import org.scalatest.{BeforeAndAfterAll, FunSuite}
 import sys.process._
 
+/**
+  * Integration test for imageClassifier example.
+  * This will run as a part of "make scalatest"
+  */
 class ImageClassifierExampleSuite extends FunSuite with BeforeAndAfterAll {
 
   test("testImageClassifierExample"){