Skip to content
Localize and identify multiple objects in a single image.
Branch: master
Clone or download

README.md

Build Status Website Status

IBM Developer Model Asset Exchange: Object Detector

This repository contains code to instantiate and deploy an object detection model. This model recognizes the objects present in an image from the 80 different high-level classes of objects in the COCO Dataset. The model consists of a deep convolutional net base model for image feature extraction, together with additional convolutional layers specialized for the task of object detection, that was trained on the COCO data set. The input to the model is an image, and the output is a list of estimated class probabilities for the objects detected in the image.

The model is based on the SSD Mobilenet V1 object detection model for TensorFlow. The model files are hosted on IBM Cloud Object Storage. The code in this repository deploys the model as a web service in a Docker container. This repository was developed as part of the IBM Code Model Asset Exchange.

Model Metadata

Domain Application Industry Framework Training Data Input Data Format
Vision Object Detection General TensorFlow COCO Dataset Image (RGB/HWC)

References

Licenses

Component License Link
This repository Apache 2.0 LICENSE
Model Weights Apache 2.0 TensorFlow Models Repo
Model Code (3rd party) Apache 2.0 TensorFlow Models Repo
Test assets Various Asset README

Pre-requisites:

  • docker: The Docker command-line interface. Follow the installation instructions for your system.
  • The minimum recommended resources for this model is 2GB Memory and 2 CPUs.

Steps

  1. Deploy from Docker Hub
  2. Deploy on Kubernetes
  3. Run Locally

Deploy from Docker Hub

To run the docker image, which automatically starts the model serving API, run:

$ docker run -it -p 5000:5000 codait/max-object-detector

This will pull a pre-built image from Docker Hub (or use an existing image if already cached locally) and run it. If you'd rather checkout and build the model locally you can follow the run locally steps below.

Deploy on Kubernetes

You can also deploy the model on Kubernetes using the latest docker image on Docker Hub.

On your Kubernetes cluster, run the following commands:

$ kubectl apply -f https://raw.githubusercontent.com/IBM/MAX-Object-Detector/master/max-object-detector.yaml

The model will be available internally at port 5000, but can also be accessed externally through the NodePort.

Run Locally

  1. Build the Model
  2. Deploy the Model
  3. Use the Model
  4. Run the Notebook
  5. Development
  6. Cleanup

1. Build the Model

Clone this repository locally. In a terminal, run the following command:

$ git clone https://github.com/IBM/MAX-Object-Detector.git

Change directory into the repository base folder:

$ cd MAX-Object-Detector

To build the docker image locally, run:

$ docker build -t max-object-detector .

All required model assets will be downloaded during the build process. Note that currently this docker image is CPU only (we will add support for GPU images later).

2. Deploy the Model

To run the docker image, which automatically starts the model serving API, run:

$ docker run -it -p 5000:5000 max-object-detector

3. Use the Model

The API server automatically generates an interactive Swagger documentation page. Go to http://localhost:5000 to load it. From there you can explore the API and also create test requests.

Use the model/predict endpoint to load a test image (you can use one of the test images from the assets folder) and get predicted labels for the image from the API. The coordinates of the bounding box are returned in the detection_box field, and contain the array of normalized coordinates (ranging from 0 to 1) in the form [ymin, xmin, ymax, xmax].

Swagger Doc Screenshot

You can also test it on the command line, for example:

$ curl -F "image=@assets/dog-human.jpg" -XPOST http://127.0.0.1:5000/model/predict

You should see a JSON response like that below:

{
  "status": "ok",
  "predictions": [
      {
          "label_id": "1",
          "label": "person",
          "probability": 0.944034993648529,
          "detection_box": [
              0.1242099404335022,
              0.12507188320159912,
              0.8423267006874084,
              0.5974075794219971
          ]
      },
      {
          "label_id": "18",
          "label": "dog",
          "probability": 0.8645511865615845,
          "detection_box": [
              0.10447660088539124,
              0.17799153923988342,
              0.8422801494598389,
              0.732001781463623
          ]
      }
  ]
}

You can also control the probability threshold for what objects are returned using the threshold argument like below:

$ curl -F "image=@assets/dog-human.jpg" -XPOST http://127.0.0.1:5000/model/predict?threshold=0.5

The optional threshold parameter is the minimum probability value for predicted labels returned by the model. The default value for threshold is 0.7.

4. Run the Notebook

The demo notebook walks through how to use the model to detect objects in an image and visualize the results. By default, the notebook uses the hosted demo instance, but you can use a locally running instance (see the comments in Cell 3 for details). Note the demo requires jupyter, matplotlib, Pillow, and requests.

Run the following command from the model repo base folder, in a new terminal window:

$ jupyter notebook

This will start the notebook server. You can launch the demo notebook by clicking on demo.ipynb.

5. Development

To run the Flask API app in debug mode, edit config.py to set DEBUG = True under the application settings. You will then need to rebuild the docker image (see step 1).

6. Cleanup

To stop the Docker container, type CTRL + C in your terminal.

Links

Object Detector Web App

The latest release of the MAX Object Detector Web App is included in the Object Detector docker image.

When the model API server is running, the web app can be accessed at http://localhost:5000/app and provides interactive visualization of the bounding boxes and their related labels returned by the model.

Mini Web App Screenshot

If you wish to disable the web app, start the model serving API by running:

$ docker run -it -p 5000:5000 -e DISABLE_WEB_APP=true codait/max-object-detector
You can’t perform that action at this time.