You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mxnet.apache.org by GitBox <gi...@apache.org> on 2018/11/16 01:42:19 UTC
[GitHub] yzhliu closed pull request #13237: [MXNET-1182] Predictor example
yzhliu closed pull request #13237: [MXNET-1182] Predictor example
URL: https://github.com/apache/incubator-mxnet/pull/13237
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/scala-package/examples/scripts/infer/predictor/run_predictor_java_example.sh b/scala-package/examples/scripts/infer/predictor/run_predictor_java_example.sh
new file mode 100755
index 00000000000..4ebcc3076a7
--- /dev/null
+++ b/scala-package/examples/scripts/infer/predictor/run_predictor_java_example.sh
@@ -0,0 +1,44 @@
+#!/bin/bash
+
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+hw_type=cpu
+if [[ $3 = gpu ]]
+then
+ hw_type=gpu
+fi
+
+platform=linux-x86_64
+
+if [[ $OSTYPE = [darwin]* ]]
+then
+ platform=osx-x86_64
+fi
+
+MXNET_ROOT=$(cd "$(dirname $0)/../../../../../"; pwd)
+CLASS_PATH=$MXNET_ROOT/scala-package/assembly/$platform-$hw_type/target/*:$MXNET_ROOT/scala-package/examples/target/*:$MXNET_ROOT/scala-package/examples/target/classes/lib/*:$MXNET_ROOT/scala-package/infer/target/*
+
+# model dir and prefix
+MODEL_DIR=$1
+# input image
+INPUT_IMG=$2
+
+java -Xmx8G -cp $CLASS_PATH \
+ org.apache.mxnetexamples.javaapi.infer.predictor.PredictorExample \
+ --model-path-prefix $MODEL_DIR \
+ --input-image $INPUT_IMG
diff --git a/scala-package/examples/src/main/java/org/apache/mxnetexamples/javaapi/infer/predictor/PredictorExample.java b/scala-package/examples/src/main/java/org/apache/mxnetexamples/javaapi/infer/predictor/PredictorExample.java
new file mode 100644
index 00000000000..c9b4426f52b
--- /dev/null
+++ b/scala-package/examples/src/main/java/org/apache/mxnetexamples/javaapi/infer/predictor/PredictorExample.java
@@ -0,0 +1,200 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.mxnetexamples.javaapi.infer.predictor;
+
+import org.apache.mxnet.infer.javaapi.Predictor;
+import org.apache.mxnet.javaapi.*;
+import org.kohsuke.args4j.CmdLineParser;
+import org.kohsuke.args4j.Option;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import javax.imageio.ImageIO;
+import java.awt.Graphics2D;
+import java.awt.image.BufferedImage;
+import java.io.BufferedReader;
+import java.io.File;
+import java.io.FileReader;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * This Class is a demo to show how users can use Predictor APIs to do
+ * Image Classification with all hand-crafted Pre-processing.
+ * All helper functions for image pre-processing are
+ * currently available in ObjectDetector class.
+ */
+public class PredictorExample {
+ @Option(name = "--model-path-prefix", usage = "input model directory and prefix of the model")
+ private String modelPathPrefix = "/model/ssd_resnet50_512";
+ @Option(name = "--input-image", usage = "the input image")
+ private String inputImagePath = "/images/dog.jpg";
+
+ final static Logger logger = LoggerFactory.getLogger(PredictorExample.class);
+
+ /**
+ * Load the image from file to buffered image
+ * It can be replaced by loadImageFromFile from ObjectDetector
+ * @param inputImagePath input image Path in String
+ * @return Buffered image
+ */
+ private static BufferedImage loadIamgeFromFile(String inputImagePath) {
+ BufferedImage buf = null;
+ try {
+ buf = ImageIO.read(new File(inputImagePath));
+ } catch (IOException e) {
+ System.err.println(e);
+ }
+ return buf;
+ }
+
+ /**
+ * Reshape the current image using ImageIO and Graph2D
+ * It can be replaced by reshapeImage from ObjectDetector
+ * @param buf Buffered image
+ * @param newWidth desired width
+ * @param newHeight desired height
+ * @return a reshaped bufferedImage
+ */
+ private static BufferedImage reshapeImage(BufferedImage buf, int newWidth, int newHeight) {
+ BufferedImage resizedImage = new BufferedImage(newWidth, newHeight, BufferedImage.TYPE_INT_RGB);
+ Graphics2D g = resizedImage.createGraphics();
+ g.drawImage(buf, 0, 0, newWidth, newHeight, null);
+ g.dispose();
+ return resizedImage;
+ }
+
+ /**
+ * Convert an image from a buffered image into pixels float array
+ * It can be replaced by bufferedImageToPixels from ObjectDetector
+ * @param buf buffered image
+ * @return Float array
+ */
+ private static float[] imagePreprocess(BufferedImage buf) {
+ // Get height and width of the image
+ int w = buf.getWidth();
+ int h = buf.getHeight();
+
+ // get an array of integer pixels in the default RGB color mode
+ int[] pixels = buf.getRGB(0, 0, w, h, null, 0, w);
+
+ // 3 times height and width for R,G,B channels
+ float[] result = new float[3 * h * w];
+
+ int row = 0;
+ // copy pixels to array vertically
+ while (row < h) {
+ int col = 0;
+ // copy pixels to array horizontally
+ while (col < w) {
+ int rgb = pixels[row * w + col];
+ // getting red color
+ result[0 * h * w + row * w + col] = (rgb >> 16) & 0xFF;
+ // getting green color
+ result[1 * h * w + row * w + col] = (rgb >> 8) & 0xFF;
+ // getting blue color
+ result[2 * h * w + row * w + col] = rgb & 0xFF;
+ col += 1;
+ }
+ row += 1;
+ }
+ buf.flush();
+ return result;
+ }
+
+ /**
+ * Helper class to print the maximum prediction result
+ * @param probabilities The float array of probability
+ * @param modelPathPrefix model Path needs to load the synset.txt
+ */
+ private static String printMaximumClass(float[] probabilities,
+ String modelPathPrefix) throws IOException {
+ String synsetFilePath = modelPathPrefix.substring(0,
+ 1 + modelPathPrefix.lastIndexOf(File.separator)) + "/synset.txt";
+ BufferedReader reader = new BufferedReader(new FileReader(synsetFilePath));
+ ArrayList<String> list = new ArrayList<>();
+ String line = reader.readLine();
+
+ while (line != null){
+ list.add(line);
+ line = reader.readLine();
+ }
+ reader.close();
+
+ int maxIdx = 0;
+ for (int i = 1;i<probabilities.length;i++) {
+ if (probabilities[i] > probabilities[maxIdx]) {
+ maxIdx = i;
+ }
+ }
+
+ return "Probability : " + probabilities[maxIdx] + " Class : " + list.get(maxIdx) ;
+ }
+
+ public static void main(String[] args) {
+ PredictorExample inst = new PredictorExample();
+ CmdLineParser parser = new CmdLineParser(inst);
+ try {
+ parser.parseArgument(args);
+ } catch (Exception e) {
+ logger.error(e.getMessage(), e);
+ parser.printUsage(System.err);
+ System.exit(1);
+ }
+ // Prepare the model
+ List<Context> context = new ArrayList<Context>();
+ if (System.getenv().containsKey("SCALA_TEST_ON_GPU") &&
+ Integer.valueOf(System.getenv("SCALA_TEST_ON_GPU")) == 1) {
+ context.add(Context.gpu());
+ } else {
+ context.add(Context.cpu());
+ }
+ List<DataDesc> inputDesc = new ArrayList<>();
+ Shape inputShape = new Shape(new int[]{1, 3, 224, 224});
+ inputDesc.add(new DataDesc("data", inputShape, DType.Float32(), "NCHW"));
+ Predictor predictor = new Predictor(inst.modelPathPrefix, inputDesc, context,0);
+ // Prepare data
+ BufferedImage img = loadIamgeFromFile(inst.inputImagePath);
+
+ img = reshapeImage(img, 224, 224);
+ // predict
+ float[][] result = predictor.predict(new float[][]{imagePreprocess(img)});
+ try {
+ System.out.println("Predict with Float input");
+ System.out.println(printMaximumClass(result[0], inst.modelPathPrefix));
+ } catch (IOException e) {
+ System.err.println(e);
+ }
+ // predict with NDArray
+ NDArray nd = new NDArray(
+ imagePreprocess(img),
+ new Shape(new int[]{1, 3, 224, 224}),
+ Context.cpu());
+ List<NDArray> ndList = new ArrayList<>();
+ ndList.add(nd);
+ List<NDArray> ndResult = predictor.predictWithNDArray(ndList);
+ try {
+ System.out.println("Predict with NDArray");
+ System.out.println(printMaximumClass(ndResult.get(0).toArray(), inst.modelPathPrefix));
+ } catch (IOException e) {
+ System.err.println(e);
+ }
+ }
+
+}
diff --git a/scala-package/examples/src/main/java/org/apache/mxnetexamples/javaapi/infer/predictor/README.md b/scala-package/examples/src/main/java/org/apache/mxnetexamples/javaapi/infer/predictor/README.md
new file mode 100644
index 00000000000..1f2c9e0e813
--- /dev/null
+++ b/scala-package/examples/src/main/java/org/apache/mxnetexamples/javaapi/infer/predictor/README.md
@@ -0,0 +1,61 @@
+# Image Classification using Java Predictor
+
+In this example, you will learn how to use Java Inference API to
+build and run pre-trained Resnet 18 model.
+
+## Contents
+
+1. [Prerequisites](#prerequisites)
+2. [Download artifacts](#download-artifacts)
+3. [Setup datapath and parameters](#setup-datapath-and-parameters)
+4. [Run the image classifier example](#run-the-image-inference-example)
+
+## Prerequisites
+
+1. Build from source with [MXNet](https://mxnet.incubator.apache.org/install/index.html)
+2. [IntelliJ IDE (or alternative IDE) project setup](https://github.com/apache/incubator-mxnet/blob/master/docs/tutorials/java/mxnet_java_on_intellij.md) with the MXNet Java Package
+3. wget
+
+## Download Artifacts
+
+For this tutorial, you can get the model and sample input image by running following bash file. This script will use `wget` to download these artifacts from AWS S3.
+
+From the `scala-package/examples/scripts/infer/imageclassifier/` folder run:
+
+```bash
+./get_resnet_18_data.sh
+```
+
+**Note**: You may need to run `chmod +x get_resnet_18_data.sh` before running this script.
+
+### Setup Datapath and Parameters
+
+The available arguments are as follows:
+
+| Argument | Comments |
+| ----------------------------- | ---------------------------------------- |
+| `model-dir` | Folder path with prefix to the model (including json, params, and any synset file). |
+| `input-image` | The image to run inference on. |
+
+## Run the image classifier example
+
+After the previous steps, you should be able to run the code using the following script that will pass all of the required parameters to the Predictor API.
+
+From the `scala-package/examples/scripts/infer/predictor/` folder run:
+
+```bash
+bash run_predictor_java_example.sh ../models/resnet-18/resnet-18 ../images/kitten.jpg
+```
+
+**Notes**:
+* These are relative paths to this script.
+* You may need to run `chmod +x run_predictor_java_example.sh` before running this script.
+
+The example should give an output similar to the one shown below:
+```
+Predict with Float input
+Probability : 0.30337515 Class : n02123159 tiger cat
+Predict with NDArray
+Probability : 0.30337515 Class : n02123159 tiger cat
+```
+the outputs come from the the input image, with top1 predictions picked.
\ No newline at end of file
diff --git a/scala-package/infer/src/main/scala/org/apache/mxnet/infer/javaapi/Predictor.scala b/scala-package/infer/src/main/scala/org/apache/mxnet/infer/javaapi/Predictor.scala
index 21e62b3aa55..a5428e1c821 100644
--- a/scala-package/infer/src/main/scala/org/apache/mxnet/infer/javaapi/Predictor.scala
+++ b/scala-package/infer/src/main/scala/org/apache/mxnet/infer/javaapi/Predictor.scala
@@ -49,6 +49,18 @@ class Predictor private[mxnet] (val predictor: org.apache.mxnet.infer.Predictor)
new org.apache.mxnet.infer.Predictor(modelPathPrefix, informationDesc, inContexts, Some(epoch))
}
+ /**
+ * Takes input as Array of one dimensional arrays and creates the NDArray needed for inference
+ * The array will be reshaped based on the input descriptors.
+ *
+ * @param input: An Array of a one-dimensional array.
+ An extra Array is needed for when the model has more than one input.
+ * @return Indexed sequence array of outputs
+ */
+ def predict(input: Array[Array[Float]]):
+ Array[Array[Float]] = {
+ predictor.predict(input).toArray
+ }
/**
* Takes input as List of one dimensional arrays and creates the NDArray needed for inference
@@ -65,6 +77,7 @@ class Predictor private[mxnet] (val predictor: org.apache.mxnet.infer.Predictor)
}
+
/**
* Predict using NDArray as input
* This method is useful when the input is a batch of data
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services