Updates for 3.0 SDK

Author: areddish

README.md

@@ -98,8 +98,8 @@ We provide several meta-packages to help you install several packages at a time.
 4.  Set up the environment variable `WEBSEARCH_SUBSCRIPTION_KEY` with your key if you want to execute WebSearch tests.
 4.  Set up the environment variable `COMPUTERVISION_SUBSCRIPTION_KEY` with your key if you want to execute Computer Vision tests. You might override too `COMPUTERVISION_LOCATION` (westcentralus by default).
 4.  Set up the environment variable `CONTENTMODERATOR_SUBSCRIPTION_KEY` with your key if you want to execute Content Moderator tests. You might override too `CONTENTMODERATOR_LOCATION` (westcentralus by default).
-4.  Set up the environment variable `CUSTOMVISION_TRAINING_KEY` with your key if you want to execute CustomVision Training tests.
-4.  Set up the environment variable `CUSTOMVISION_PREDICTION_KEY` with your key if you want to execute CustomVision Prediction tests.
+4.  Set up the environment variable `CUSTOMVISION_TRAINING_KEY` with your key and `CUSTOMVISION_PREDICTION_ID` with a valid prediction resource id if you want to execute CustomVision Training tests.
+4.  Set up the environment variable `CUSTOMVISION_PREDICTION_KEY` with your key and `CUSTOMVISION_PREDICTION_ID` with a valid prediction resource id if you want to execute CustomVision Prediction tests.
 
 ## Demo
 

samples/vision/custom_vision_object_detection_sample.py

@@ -8,8 +8,11 @@
 
 # Replace with a valid key
 SUBSCRIPTION_KEY_ENV_NAME = "CUSTOMVISION_TRAINING_KEY"
+PREDICTION_RESOURCE_ID_KEY_ENV_NAME = "CUSTOMVISION_PREDICTION_ID"
 PREDICTION_KEY_ENV_NAME = "CUSTOMVISION_PREDICTION_KEY"
 
+PUBLISH_ITERATION_NAME = "classifyModel"
+
 ENDPOINT = "https://southcentralus.api.cognitive.microsoft.com"
 
 # Add this directory to the path so that custom_vision_training_samples can be found
@@ -27,10 +30,15 @@ def run_sample(subscription_key):
     predict_project(prediction_key, project, iteration)
 
 def train_project(training_key):
+    try:
+        prediction_resource_id = os.environ[PREDICTION_RESOURCE_ID_KEY_ENV_NAME]
+    except KeyError:
+        raise PredictionResourceMissingError("Didn't find a prediction resource to publish to. Please set the {} environment variable".format(PREDICTION_RESOURCE_ID_KEY_ENV_NAME))
+
     trainer = CustomVisionTrainingClient(training_key, endpoint=ENDPOINT)
 
     # Find the object detection domain
-    obj_detection_domain = next(domain for domain in trainer.get_domains() if domain.type == "ObjectDetection")
+    obj_detection_domain = next(domain for domain in trainer.get_domains() if domain.type == "ObjectDetection" and domain.name == "General")
 
     # Create a new project
     print ("Creating project...")
@@ -104,7 +112,6 @@ def train_project(training_key):
         with open(os.path.join(IMAGES_FOLDER,"scissors", file_name + ".jpg"), mode="rb") as image_contents:
             tagged_images_with_regions.append(ImageFileCreateEntry(name=file_name, contents=image_contents.read(), regions=regions))
 
-
     trainer.create_images_from_files(project.id, images=tagged_images_with_regions)
 
     print ("Training...")
@@ -114,8 +121,8 @@ def train_project(training_key):
         print ("Training status: " + iteration.status)
         time.sleep(1)
 
-    # The iteration is now trained. Make it the default project endpoint
-    trainer.update_iteration(project.id, iteration.id, is_default=True)
+    # The iteration is now trained. Name and publish this iteration to a prediciton endpoint
+    trainer.publish_iteration(project.id, iteration.id, PUBLISH_ITERATION_NAME, prediction_resource_id)
     print ("Done!")
     return project, iteration
 
@@ -124,11 +131,11 @@ def predict_project(prediction_key, project, iteration):
 
     # Open the sample image and get back the prediction results.
     with open(os.path.join(IMAGES_FOLDER, "Test", "test_od_image.jpg"), mode="rb") as test_data:
-        results = predictor.predict_image(project.id, test_data, iteration.id)
+        results = predictor.detect_image(project.id, PUBLISH_ITERATION_NAME, test_data)
 
     # Display the results.
     for prediction in results.predictions:
-        print ("\t" + prediction.tag_name + ": {0:.2f}%".format(prediction.probability * 100), prediction.bounding_box.left, prediction.bounding_box.top, prediction.bounding_box.width, prediction.bounding_box.height)
+        print("\t" + prediction.tag_name + ": {0:.2f}% bbox.left = {1:.2f}, bbox.top = {2:.2f}, bbox.width = {3:.2f}, bbox.height = {4:.2f}".format(prediction.probability * 100, prediction.bounding_box.left, prediction.bounding_box.top, prediction.bounding_box.width, prediction.bounding_box.height))
 
 
 if __name__ == "__main__":

samples/vision/custom_vision_prediction_samples.py

@@ -7,6 +7,8 @@
 TRAINING_KEY_ENV_NAME = "CUSTOMVISION_TRAINING_KEY"
 SUBSCRIPTION_KEY_ENV_NAME = "CUSTOMVISION_PREDICTION_KEY"
 
+PUBLISH_ITERATION_NAME = "classifyModel"
+
 ENDPOINT = "https://southcentralus.api.cognitive.microsoft.com"
 
 # Add this directory to the path so that custom_vision_training_samples can be found
@@ -19,7 +21,7 @@ def find_or_train_project():
         training_key = os.environ[TRAINING_KEY_ENV_NAME]
     except KeyError:
         raise SubscriptionKeyError("You need to set the {} env variable.".format(TRAINING_KEY_ENV_NAME))
-
+        
     # Use the training API to find the SDK sample project created from the training example.
     from custom_vision_training_samples import train_project, SAMPLE_PROJECT_NAME
     trainer = CustomVisionTrainingClient(training_key, endpoint=ENDPOINT)
@@ -38,7 +40,7 @@ def predict_project(subscription_key):
     project = find_or_train_project()
 
     with open(os.path.join(IMAGES_FOLDER, "Test", "test_image.jpg"), mode="rb") as test_data:
-         results = predictor.predict_image(project.id, test_data.read())
+         results = predictor.classify_image(project.id, PUBLISH_ITERATION_NAME, test_data.read())
 
     # Display the results.
     for prediction in results.predictions:

samples/vision/custom_vision_training_multiclass_samples.py

@@ -5,13 +5,27 @@
 from azure.cognitiveservices.vision.customvision.training.models import Classifier
 
 SUBSCRIPTION_KEY_ENV_NAME = "CUSTOMVISION_TRAINING_KEY"
+PREDICTION_RESOURCE_ID_KEY_ENV_NAME = "CUSTOMVISION_PREDICTION_ID"
+
 SAMPLE_PROJECT_NAME = "Python SDK Sample"
 
+# The prediction resource can be found with your keys and is tied to the Prediction Key
+PREDICTION_RESOURCE_ID = "enter your prediction resource"
+
+PUBLISH_ITERATION_NAME = "classifyModel"
+
 ENDPOINT = "https://southcentralus.api.cognitive.microsoft.com"
 
 IMAGES_FOLDER = os.path.join(os.path.dirname(os.path.realpath(__file__)), "images")
 
+class PredictionResourceMissingError(Exception):
+    pass
+
 def train_project(subscription_key):
+    try:
+        prediction_resource_id = os.environ[PREDICTION_RESOURCE_ID_KEY_ENV_NAME]
+    except KeyError:
+        raise PredictionResourceMissingError("Didn't find a prediction resource to publish to. Please set the {} environment variable".format(PREDICTION_RESOURCE_ID_KEY_ENV_NAME))
 
     trainer = CustomVisionTrainingClient(subscription_key, endpoint=ENDPOINT)
 
@@ -43,8 +57,8 @@ def train_project(subscription_key):
         print ("Training status: " + iteration.status)
         time.sleep(1)
 
-    # The iteration is now trained. Make it the default project endpoint
-    trainer.update_iteration(project.id, iteration.id, is_default=True)
+    # The iteration is now trained. Name and publish this iteration to a prediciton endpoint
+    trainer.publish_iteration(project.id, iteration.id, PUBLISH_ITERATION_NAME, prediction_resource_id)
     print ("Done!")
     return project
 

samples/vision/custom_vision_training_samples.py

@@ -4,13 +4,23 @@
 from azure.cognitiveservices.vision.customvision.training import CustomVisionTrainingClient
 
 SUBSCRIPTION_KEY_ENV_NAME = "CUSTOMVISION_TRAINING_KEY"
+PREDICTION_RESOURCE_ID_KEY_ENV_NAME = "CUSTOMVISION_PREDICTION_ID"
+
 SAMPLE_PROJECT_NAME = "Python SDK Sample"
+PUBLISH_ITERATION_NAME = "classifyModel"
 
 ENDPOINT = "https://southcentralus.api.cognitive.microsoft.com"
 
 IMAGES_FOLDER = os.path.join(os.path.dirname(os.path.realpath(__file__)), "images")
 
+class PredictionResourceMissingError(Exception):
+    pass
+
 def train_project(subscription_key):
+    try:
+        prediction_resource_id = os.environ[PREDICTION_RESOURCE_ID_KEY_ENV_NAME]
+    except KeyError:
+        raise PredictionResourceMissingError("Didn't find a prediction resource to publish to. Please set the {} environment variable".format(PREDICTION_RESOURCE_ID_KEY_ENV_NAME))
 
     trainer = CustomVisionTrainingClient(subscription_key, endpoint=ENDPOINT)
 
@@ -40,8 +50,8 @@ def train_project(subscription_key):
         print ("Training status: " + iteration.status)
         time.sleep(1)
 
-    # The iteration is now trained. Make it the default project endpoint
-    trainer.update_iteration(project.id, iteration.id, is_default=True)
+    # The iteration is now trained. Name and publish this iteration to a prediciton endpoint
+    trainer.publish_iteration(project.id, iteration.id, PUBLISH_ITERATION_NAME, prediction_resource_id)
     print ("Done!")
     return project