Skip to content

Latest commit

 

History

History
344 lines (186 loc) · 21.1 KB

Custom Vision Service HOL.md

File metadata and controls

344 lines (186 loc) · 21.1 KB

Using the Microsoft Custom Vision Service to Perform Image Classification

Microsoft Cognitive Services is a suite of services and APIs backed by machine learning that enables developers to incorporate intelligent features such as facial recognition in photos and videos, sentiment analysis in text, and language understanding into their applications. Microsoft's Custom Vision Service is among the newest members of the Cognitive Services suite. Its purpose is to create image classification models that "learn" from labeled images you provide. Want to know if a photo contains a picture of a flower? Train the Custom Vision Service with a collection of flower images, and it can tell you whether the next image includes a flower — or even what type of flower it is.

The Custom Vision Service enables organizations to develop domain-specific image-classification models and use it to analyze image content. Examples include identifying a dog's breed from a picture of the dog, analyzing images for adult content, and identifying defective parts produced by manufacturing processes. It was recently used to help search-and-rescue drones identify objects such as boats and life vests in large bodies of water and recognize potential emergency situations in order to notify a rescue squad without waiting for human intervention.

The Custom Vision Service exposes two APIs: the Custom Vision Training API and the Custom Vision Prediction API. You can build, train, and test image-classification models using the Custom Vision Service portal, or you can build, train, and test them using the Custom Vision Training API. Once a model is trained, you can use the Custom Vision Prediction API to build apps that utilize it. Both are REST APIs that are easily called from a variety of programming languages.

In this lab, you will create a Custom Vision Service model, train it with images of famous paintings tagged with the artists' names, and utilize the model from a Node.js app to identify the artist of paintings that you upload. Along the way, you will learn how to train a Custom Vision Service model and leverage it from your apps using REST APIs.

Objectives

In this hands-on lab, you will learn how to:

  • Create a Custom Vision Service project
  • Train a Custom Vision Service model with tagged images
  • Test a Custom Vision Service model
  • Create apps that leverage Custom Vision Service models by calling REST APIs

Prerequisites

The following are required to complete this hands-on lab:

Resources

Click here to download a zip file containing the resources used in this lab. Copy the contents of the zip file into a folder on your hard disk.

Cost

There is no cost associated with this lab because it doesn't require an Azure subscription. For an overview of cost ratings, refer to Explanation of Costs.

Exercises

This hands-on lab includes the following exercises:

Estimated time to complete this lab: 45 minutes.

Exercise 1: Create a Custom Vision Service project

The first step in building an image-classification model with the Custom Vision Service is to create a project. In this exercise, you will use the Custom Vision Service portal to create a Custom Vision Service project.

  1. Open the Custom Vision Service portal in your browser. Then click Sign In.

    Signing in to the Custom Vision Service portal

    Signing in to the Custom Vision Service portal

  2. If you are asked to sign in, do so using the credentials for your Microsoft account. If you are asked to let this app access your info, click Yes, and if prompted, agree to the terms of service.

  3. Click New Project to create a new project.

    Creating a Custom Vision Service project

    Creating a Custom Vision Service project

  4. In the "New project" dialog, name the project "Artworks," ensure that General is selected as the domain, and click Create project.

    A domain optimizes a model for specific types of images. For example, if your goal is to classify food images by the types of food they contain or the ethnicity of the dishes, then it might be helpful to select the Food domain. For scenarios that don't match any of the offered domains, or if you are unsure of which domain to choose, select the General domain.

    Creating a Custom Vision Service project

    Creating a Custom Vision Service project

The next step is to upload images to the project and assign tags to those images to classify them.

Exercise 2: Upload tagged images

In this exercise, you will add images of famous paintings by Picasso, Pollock, and Rembrandt to the Artworks project, and tag the images so the Custom Vision Service can learn to differentiate one artist from another.

  1. Click Add images to add images to the project.

    Adding images to the Artworks project

    Adding images to the Artworks project

  2. Click Browse local files.

    Browsing for local images

    Browsing for local images

  3. Browse to the "Artists\Picasso" folder in the resources that accompany this lab, select all of the files in the folder, and click Open.

    Selecting an image

    Selecting an image

  4. Type "painting" (without quotation marks) into the Add some tags... box. Then click + to assign the tag to the images.

    Adding a "painting" tag to the images

    Adding a "painting" tag to the images

  5. Repeat Step 4 to add a "Picasso" tag to the images.

  6. Click Upload 7 files to upload the images. Once the upload has completed, click Done.

    Uploading tagged images

    Uploading tagged images

  7. Confirm that the images you uploaded appear in the portal, along with the tags assigned to them.

    The uploaded images

    The uploaded images

  8. With seven Picasso images, the Custom Vision Service can do a decent job of identifying paintings by Picasso. But if you trained the model right now, it would only understand what a Picasso looks like, and it would not be able to identify paintings by other artists.

    The next step is to upload some paintings by another artist. Click Add images and select all of the images in the "Artists\Rembrandt" folder in the lab resources. Tag them with the labels "painting" and "Rembrandt" (not "Picasso"), and upload them to the project.

    When you add the tag "painting," you don't have to type it in again. You can select it from the drop-down list attached to the Add some tags... box, as shown below. You will have to type "Rembrandt" and click + to add a "Rembrandt" tag.

    Selecting an existing tag

    Selecting an existing tag

  9. Confirm that the Rembrandt images appear alongside the Picasso images in the project, and that "Rembrandt" appears in the list of tags.

    Picasso and Rembrandt images

    Picasso and Rembrandt images

  10. Now add paintings by the enigmatic artist Jackson Pollock to enable the Custom Vision Service to recognize Pollock paintings, too. Select all of the images in the "Artists\Pollock" folder in the lab resources, tag them with the terms "painting" and "Pollock", and upload them to the project.

With the tagged images uploaded, the next step is to train the model with these images so it can distinguish between paintings by Picasso, Rembrandt, and Pollock, as well as determine whether a painting is a work by one of these famous artists.

Exercise 3: Train the model

In this exercise, you will train the model using the images uploaded and tagged in the previous exercise. Training can be accomplished with a simple button click in the portal, or by calling the TrainProject method in the Custom Vision Training API. Once trained, a model can be refined by uploading additional tagged images and retraining it.

  1. Click the Train button at the top of the page to train the model. Each time you train the model, a new iteration is created. The Custom Vision Service maintains several iterations, allowing you to compare your progress over time.

    Training the model

    Training the model

  2. Wait for the training process to complete. (It should only take a few seconds.) Then review the training statistics presented to you for iteration 1. Precision and recall are separate but related measures of the model's accuracy. Suppose the model was presented with three Picassos and three Van Goghs, and that it correctly identified two of the Picassos as "Picasso" images, but incorrectly identified two of the Van Goghs as Picassos. In this case, the precision would be 50% (two of the four images it classified as Picassos are actually Picassos), while its recall would be 67% (it correctly identified two of the three Picasso images as Picassos). You can learn more about precision and recall from https://en.wikipedia.org/wiki/Precision_and_recall.

    Results of training the model

    Results of training the model

Now let's test the model using the portal's Quick Test feature, which allows you to submit images to the model and see how it classifies them using the knowledge gained from the training images.

Exercise 4: Test the model

In Exercise 5, you will create a Node.js app that uses the model to identify the artist of paintings presented to it. But you don't have to write an app to test the model; you can do your testing in the portal, and you can further refine the model using the images that you test with. In this exercise, you will test the model's ability to identify the artist of a painting using test images provided for you.

  1. Click Quick Test at the top of the page.

    Testing the model

    Testing the model

  2. Click Browse local files, and then browse to the "Quick Tests" folder in the lab resources. Select PicassoTest_01.jpg, and click Open.

    Selecting a Picasso test image

    Selecting a Picasso test image

  3. Examine the results of the test in the "Quick Test" dialog. What is the probability that the painting is a Picasso? What is the probability that it is a Rembrandt or Pollock?

  4. Close the "Quick Test" dialog. Then click Predictions at the top of the page.

    Viewing the tests that have been performed

    Viewing the tests that have been performed

  5. Click the test image that you uploaded to show a detail of it. Then tag the image as a "Picasso" by selecting Picasso from the drop-down list and clicking Save and close.

    By tagging test images this way, you can refine the model without uploading additional training images.

    Tagging the test image

    Tagging the test image

  6. Perform another quick test using the file named FlowersTest.jpg in the "Quick Test" folder. Confirm that this image is assigned a low probability of being a Picasso, a Rembrandt, or a Pollock.

The model is trained and ready to go and appears to be adept at identifying paintings by certain artists. Now let's go a step further and incorporate the model's intelligence into an app.

Exercise 5: Create a Node.js app that uses the model

The true power of the Microsoft Custom Vision Service is the ease with which developers can incorporate its intelligence into their own applications using the Custom Vision Prediction API. In this exercise, you will use Visual Studio Code to modify an app named Artwork to use the model you built and trained in previous exercises.

  1. If Node.js isn't installed on your system, go to https://nodejs.org and install the latest LTS version for your operating system.

    If you aren't sure whether Node.js is installed, open a Command Prompt or terminal window and type node -v. If you don't see a Node.js version number, then Node.js isn't installed. If a version of Node.js older than 6.0 is installed, it is highly recommend that you download and install the latest version.

  2. If Visual Studio Code isn't installed on your workstation, go to http://code.visualstudio.com and install it now.

  3. Start Visual Studio Code and select Open Folder... from the File menu. In the ensuing dialog, select the "Client\Artworks" folder included in the lab resources.

    Selecting the Artworks folder

    Selecting the Artworks folder

  4. Use the View > Integrated Terminal command to open an integrated terminal window in Visual Studio Code. Then execute the following command in the integrated terminal to load the packages required by the app:

    npm install
    
  5. Return to the Artwork project in the Custom Vision Service portal, click Performance, and then click Make default to make sure the latest iteration of the model is the default iteration.

    Specifying the default iteration

    Specifying the default iteration

  6. Before you can run the app and use it to call the Custom Vision Service, it must be modified to include endpoint and authorization information. To that end, click Prediction URL.

    Viewing Prediction URL information

    Viewing Prediction URL information

  7. The ensuing dialog lists two URLs: one for uploading images via URL, and another for uploading local images. Copy the Prediction API URL for image files to the clipboard.

    Copying the Prediction API URL

    Copying the Prediction API URL

  8. Return to Visual Studio Code and click predict.js to open it in the code editor.

    Opening predict.js

    Opening predict.js

  9. Replace "PREDICTION_ENDPOINT" in line 3 with the URL on the clipboard.

    Adding the Prediction API URL

    Adding the Prediction API URL

  10. Return to the Custom Vision Service portal and copy the Prediction API key to the clipboard.

    Copying the Prediction API key

    Copying the Prediction API key

  11. Return to Visual Studio Code and replace "PREDICTION_KEY" in line 4 of predict.js with the API key on the clipboard.

    Adding the Prediction API key

    Adding the Prediction API key

  12. Scroll down in predict.js and examine the block of code that begins on line 34. This is the code that calls out to the Custom Vision Service using AJAX. Using the Custom Vision Prediction API is as easy as making a simple, authenticated POST to a REST endpoint.

    Making a call to the Prediction API

    Making a call to the Prediction API

  13. Return to the integrated terminal in Visual Studio Code and execute the following command to start the app:

    npm start
    
  14. Confirm that the Artworks app starts and displays a window like this one:

    The Artworks app

    The Artworks app

Artworks is a cross-platform app written with Node.js and Electron. As such, it is equally capable of running on Windows, macOS, and Linux. In the next exercise, you will use it to classify images by the artists who painted them.

Exercise 6: Use the app to classify images

In this exercise, you will use the Artworks app to submit images to the Custom Vision Service for classification. The app uses the JSON information returned from calls to the Custom Vision Prediction API's PredictImage method to tell you whether an image represents a painting by Picasso, Rembrandt, Pollock, or none of the above. It also shows the probability that the classification assigned to the image is correct.

  1. Click the Browse (...) button in the Artworks app.

    Browsing for local images in the Artworks app

    Browsing for local images in the Artworks app

  2. Browse to the "Quick Tests" folder in the lab resources. Select the file named PicassoTest_02.jpg, and then click Open.

  3. Click the Predict button to submit the image to the Custom Vision Service.

    Submitting the image to the Custom Vision Service

    Submitting the image to the Custom Vision Service

  4. Confirm that the app identifies the painting as a Picasso.

    Classifying an image as a Picasso

    Classifying an image as a Picasso

  5. Repeat steps 1 through 3 for RembrandtTest_01.jpg and PollockTest_01.jpg and confirm that the app can identify paintings by Rembrandt and Pollock.

    Classifying an image as a Rembrandt

    Classifying an image as a Rembrandt

  6. Repeat steps 1 through 3 for VanGoghTest_01.png and VanGoghTest_02.png and confirm that the app does not identify these Van Gogh masterworks as paintings by Picasso, Rembrandt, or Pollock.

    Not a Picasso, Rembrandt, or Pollock

    Not a Picasso, Rembrandt, or Pollock

  7. As you can see, using the Prediction API from an app is just as reliable as through the Custom Vision Service portal — and way more fun! What's more, if you go to the Predictions page in the portal, you'll find that each of the images uploaded via the app is shown there as well.

    Images submitted to the Custom Vision Service

    Images submitted to the Custom Vision Service

Feel free to test with images of your own and gauge the model's adeptness at identifying artists or determining that an image is not a Picasso, Rembrandt, or Pollock. If you'd like to train it to recognize Van Goghs, too, simply upload some Van Gogh paintings, tag them with "Van Gogh," and retrain the model. There is no limit to the intelligence you can add if you're willing to do the training. And remember that in general, the more images you train with, the smarter the model will be.

Summary

Image classification is playing an increasingly large role in industry as a means for automating such tasks as checking images uploaded to Web sites for offensive content and inspecting parts rolling off of assembly lines for defects. Building an image-classification model manually — that is, coding it from the ground up in Python, R, or another language — requires no small amount of expertise, but the Custom Vision Service enables virtually anyone to build sophisticated image-classification models. And once a model is built and trained, an app that uses it is only few lines of code away.


Copyright 2017 Microsoft Corporation. All rights reserved. Except where otherwise noted, these materials are licensed under the terms of the MIT License. You may use them according to the license as is most appropriate for your project. The terms of this license can be found at https://opensource.org/licenses/MIT.