Add details about dataset and model IDs (versus names) to AutoML Video OT code samples

Rebecca Taylor · Rebecca Taylor · commit 59d442e18e2f · 2019-06-28T19:05:02.000-07:00
diff --git a/video/cloud-client/automl/v1beta1/automl_video_object_tracking_batch_predict.py b/video/cloud-client/automl/v1beta1/automl_video_object_tracking_batch_predict.py
@@ -39,6 +39,7 @@ def sample_batch_predict(gcs_output_prefix, model_id, project):
       request
       in your Google Cloud Storage bucket.
       You must have write permissions to the Google Cloud Storage bucket.
+      model_id Model ID, e.g. VOT1234567890123456789
       project Required. Your Google Cloud Project ID.
     """
 
diff --git a/video/cloud-client/automl/v1beta1/automl_video_object_tracking_create_dataset.py b/video/cloud-client/automl/v1beta1/automl_video_object_tracking_create_dataset.py
@@ -63,8 +63,15 @@ def sample_create_dataset(display_name, project):
     response = client.create_dataset(parent, dataset)
     print(u"Created Dataset.")
     dataset = response
+    # Print out the full name of the created dataset.
+    #
+    # This will have the format:
+    #   projects/[Google Cloud Project Number]/locations/us-central1/datasets/VOT1234567890123456789
+    #
     print(u"Name: {}".format(dataset.name))
+    # Print out the Display Name (the text you provided during creation)
     print(u"Display Name: {}".format(dataset.display_name))
+    # Print out the user-provided description (may be blank)
     print(u"Description: {}".format(dataset.description))
     # The number of examples in the dataset, if any.
     # Added by importing data via import_data
diff --git a/video/cloud-client/automl/v1beta1/automl_video_object_tracking_delete_dataset.py b/video/cloud-client/automl/v1beta1/automl_video_object_tracking_delete_dataset.py
@@ -35,7 +35,7 @@ def sample_delete_dataset(dataset_id, project):
     Delete Dataset
 
     Args:
-      dataset_id Dataset ID
+      dataset_id Dataset ID, e.g. VOT1234567890123456789
       project Required. Your Google Cloud Project ID.
     """
 
diff --git a/video/cloud-client/automl/v1beta1/automl_video_object_tracking_delete_model.py b/video/cloud-client/automl/v1beta1/automl_video_object_tracking_delete_model.py
@@ -35,6 +35,7 @@ def sample_delete_model(model_id, project):
     Delete Model
 
     Args:
+      model_id Model ID, e.g. VOT1234567890123456789
       project Required. Your Google Cloud Project ID.
     """
 
diff --git a/video/cloud-client/automl/v1beta1/automl_video_object_tracking_get_dataset.py b/video/cloud-client/automl/v1beta1/automl_video_object_tracking_get_dataset.py
@@ -21,7 +21,7 @@
 
 # sample-metadata
 #   title: Get Dataset
-#   description: Get Dataset
+#   description: Get dataset and print dataset details
 #   usage: python3 samples/v1beta1/automl_video_object_tracking_get_dataset.py [--dataset_id "[Dataset ID]"] [--project "[Google Cloud Project ID]"]
 import sys
 
@@ -32,10 +32,10 @@
 
 def sample_get_dataset(dataset_id, project):
     """
-    Get Dataset
+    Get dataset and print dataset details
 
     Args:
-      dataset_id Dataset ID
+      dataset_id Dataset ID, e.g. VOT1234567890123456789
       project Required. Your Google Cloud Project ID.
     """
 
@@ -47,8 +47,15 @@ def sample_get_dataset(dataset_id, project):
 
     response = client.get_dataset(name)
     dataset = response
+    # Print out the full name of the created dataset.
+    #
+    # This will have the format:
+    #   projects/[Google Cloud Project Number]/locations/us-central1/datasets/VOT1234567890123456789
+    #
     print(u"Name: {}".format(dataset.name))
+    # Print out the Display Name (the text you provided during creation)
     print(u"Display Name: {}".format(dataset.display_name))
+    # Print out the user-provided description (may be blank)
     print(u"Description: {}".format(dataset.description))
     # The number of examples in the dataset, if any.
     # Added by importing data via import_data
diff --git a/video/cloud-client/automl/v1beta1/automl_video_object_tracking_get_model.py b/video/cloud-client/automl/v1beta1/automl_video_object_tracking_get_model.py
@@ -21,7 +21,7 @@
 
 # sample-metadata
 #   title: Get Model
-#   description: Get Model
+#   description: Get model and print model details
 #   usage: python3 samples/v1beta1/automl_video_object_tracking_get_model.py [--model_id "[Model ID]"] [--project "[Google Cloud Project ID]"]
 import sys
 
@@ -32,9 +32,10 @@
 
 def sample_get_model(model_id, project):
     """
-    Get Model
+    Get model and print model details
 
     Args:
+      model_id Model ID, e.g. VOT1234567890123456789
       project Required. Your Google Cloud Project ID.
     """
 
@@ -46,8 +47,18 @@ def sample_get_model(model_id, project):
 
     response = client.get_model(name)
     model = response
+    # Print out the full name of the created model.
+    #
+    # This will have the format:
+    #   projects/[Google Cloud Project Number]/locations/us-central1/models/VOT1234567890123456789
+    #
     print(u"Model name: {}".format(model.name))
+    # Print out the Display Name (the text you provided during creation)
     print(u"Display name: {}".format(model.display_name))
+    # Print out the ID of the dataset used to create this model.
+    #
+    # Note: this is the Dataset ID, e.g. VOT1234567890123456789
+    #
     print(u"Dataset ID: {}".format(model.dataset_id))
     print(u"Create time: {}".format(model.create_time))
     print(u"Update time: {}".format(model.update_time))
diff --git a/video/cloud-client/automl/v1beta1/automl_video_object_tracking_get_model_evaluation.py b/video/cloud-client/automl/v1beta1/automl_video_object_tracking_get_model_evaluation.py
@@ -35,6 +35,7 @@ def sample_get_model_evaluation(evaluation_id, model_id, project):
     Get Model Evaluation
 
     Args:
+      model_id Model ID, e.g. VOT1234567890123456789
       project Required. Your Google Cloud Project ID.
     """
 
diff --git a/video/cloud-client/automl/v1beta1/automl_video_object_tracking_import_data.py b/video/cloud-client/automl/v1beta1/automl_video_object_tracking_import_data.py
@@ -35,7 +35,7 @@ def sample_import_data(dataset_id, project):
     Import training data into dataset
 
     Args:
-      dataset_id Dataset ID
+      dataset_id Dataset ID, e.g. VOT1234567890123456789
       project Required. Your Google Cloud Project ID.
     """
 
diff --git a/video/cloud-client/automl/v1beta1/automl_video_object_tracking_list_datasets.py b/video/cloud-client/automl/v1beta1/automl_video_object_tracking_list_datasets.py
@@ -21,7 +21,7 @@
 
 # sample-metadata
 #   title: List Datasets
-#   description: List Datasets
+#   description: List datasets and print each details of each dataset
 #   usage: python3 samples/v1beta1/automl_video_object_tracking_list_datasets.py [--project "[Google Cloud Project ID]"]
 import sys
 
@@ -32,7 +32,7 @@
 
 def sample_list_datasets(project):
     """
-    List Datasets
+    List datasets and print each details of each dataset
 
     Args:
       project Required. Your Google Cloud Project ID.
@@ -50,8 +50,15 @@ def sample_list_datasets(project):
     # Iterate over all results
     for response_item in client.list_datasets(parent, filter_=filter_):
         dataset = response_item
+        # Print out the full name of the created dataset.
+        #
+        # This will have the format:
+        #   projects/[Google Cloud Project Number]/locations/us-central1/datasets/VOT1234567890123456789
+        #
         print(u"Name: {}".format(dataset.name))
+        # Print out the Display Name (the text you provided during creation)
         print(u"Display Name: {}".format(dataset.display_name))
+        # Print out the user-provided description (may be blank)
         print(u"Description: {}".format(dataset.description))
         # The number of examples in the dataset, if any.
         # Added by importing data via import_data
diff --git a/video/cloud-client/automl/v1beta1/automl_video_object_tracking_list_model_evaluations.py b/video/cloud-client/automl/v1beta1/automl_video_object_tracking_list_model_evaluations.py
@@ -31,7 +31,12 @@
 
 
 def sample_list_model_evaluations(project, model_id):
-    """List Model Evaluations"""
+    """
+    List Model Evaluations
+
+    Args:
+      model_id Model ID, e.g. VOT1234567890123456789
+    """
 
     client = automl_v1beta1.AutoMlClient()
 
diff --git a/video/cloud-client/automl/v1beta1/automl_video_object_tracking_list_models.py b/video/cloud-client/automl/v1beta1/automl_video_object_tracking_list_models.py
@@ -21,7 +21,7 @@
 
 # sample-metadata
 #   title: List Models
-#   description: List Models
+#   description: List models and print details of each dataset
 #   usage: python3 samples/v1beta1/automl_video_object_tracking_list_models.py [--filter "video_object_tracking_model_metadata:*"] [--project "[Google Cloud Project ID]"]
 import sys
 
@@ -32,7 +32,7 @@
 
 def sample_list_models(filter_, project):
     """
-    List Models
+    List models and print details of each dataset
 
     Args:
       filter_ An expression for filtering the results of the request.
@@ -49,8 +49,18 @@ def sample_list_models(filter_, project):
     # Iterate over all results
     for response_item in client.list_models(parent, filter_=filter_):
         model = response_item
+        # Print out the full name of the created model.
+        #
+        # This will have the format:
+        #   projects/[Google Cloud Project Number]/locations/us-central1/models/VOT1234567890123456789
+        #
         print(u"Model name: {}".format(model.name))
+        # Print out the Display Name (the text you provided during creation)
         print(u"Display name: {}".format(model.display_name))
+        # Print out the ID of the dataset used to create this model.
+        #
+        # Note: this is the Dataset ID, e.g. VOT1234567890123456789
+        #
         print(u"Dataset ID: {}".format(model.dataset_id))
         print(u"Create time: {}".format(model.create_time))
         print(u"Update time: {}".format(model.update_time))
