Merge branch 'main' into feat--Made-display_name-optional-for-most-calls

Author: Ark-kun

.github/.OwlBot.lock.yaml

@@ -1,3 +1,3 @@
 docker:
   image: gcr.io/cloud-devrel-public-resources/owlbot-python:latest
-  digest: sha256:0e18b9475fbeb12d9ad4302283171edebb6baf2dfca1bd215ee3b34ed79d95d7
+  digest: sha256:36a95b8f494e4674dc9eee9af98961293b51b86b3649942aac800ae6c1f796d4

.repo-metadata.json

@@ -4,10 +4,11 @@
     "product_documentation": "https://cloud.google.com/ai-platform",
     "client_documentation": "https://cloud.google.com/python/docs/reference/aiplatform/latest",
     "issue_tracker": "https://issuetracker.google.com/savedsearches/559744",
-    "release_level": "ga",
+    "release_level": "stable",
     "language": "python",
     "library_type": "GAPIC_COMBO",
     "repo": "googleapis/python-aiplatform",
     "distribution_name": "google-cloud-aiplatform",
-    "api_id": "aiplatform.googleapis.com"
+    "api_id": "aiplatform.googleapis.com",
+    "api_shortname": "aiplatform"
 }

.sample_configs/process_configs.yaml

@@ -266,7 +266,7 @@ predict_image_classification_sample:
     instance_dict: predict.instance.ImageClassificationPredictionInstance
     parameters_dict: predict.params.ImageClassificationPredictionParams
   comments:
-    predictions: See gs://google-cloud-aiplatform/schema/predict/prediction/classification.yaml
+    predictions: See gs://google-cloud-aiplatform/schema/predict/prediction/image_classification_1.0.0.yaml
       for the format of the predictions.
 predict_image_file_sample:
   max_depth: 1
@@ -278,7 +278,7 @@ predict_image_object_detection_sample:
     instance_dict: predict.instance.ImageObjectDetectionPredictionInstance
     parameters_dict: predict.params.ImageObjectDetectionPredictionParams
   comments:
-    predictions: See gs://google-cloud-aiplatform/schema/predict/prediction/image_object_detection.yaml
+    predictions: See gs://google-cloud-aiplatform/schema/predict/prediction/image_object_detection_1.0.0.yaml
       for the format of the predictions.
 predict_sample:
   max_depth: 1
@@ -290,38 +290,35 @@ predict_tabular_classification_sample:
   max_depth: 1
   resource_name: endpoint
   comments:
-    predictions: See gs://google-cloud-aiplatform/schema/predict/prediction/tables_classification.yaml
+    predictions: See gs://google-cloud-aiplatform/schema/predict/prediction/tabular_classification_1.0.0.yaml
       for the format of the predictions.
 predict_tabular_forecasting_sample: {}
 predict_tabular_regression_sample:
   max_depth: 1
   resource_name: endpoint
   comments:
-    predictions: See gs://google-cloud-aiplatform/schema/predict/prediction/tables_regression.yaml
+    predictions: See gs://google-cloud-aiplatform/schema/predict/prediction/tabular_regression_1.0.0.yaml
       for the format of the predictions.
 predict_text_classification_single_label_sample:
   max_depth: 1
   resource_name: endpoint
   schema_types:
     instance_dict: predict.instance.TextClassificationPredictionInstance
-  comments:
-    predictions: See gs://google-cloud-aiplatform/schema/predict/prediction/text_classification.yaml
-      for the format of the predictions.
 predict_text_entity_extraction_sample:
   max_depth: 1
   resource_name: endpoint
   schema_types:
     instance_dict: predict.instance.TextExtractionPredictionInstance
   comments:
-    predictions: See gs://google-cloud-aiplatform/schema/predict/prediction/text_extraction.yaml
+    predictions: See gs://google-cloud-aiplatform/schema/predict/prediction/text_extraction_1.0.0.yaml
       for the format of the predictions.
 predict_text_sentiment_analysis_sample:
   max_depth: 1
   resource_name: endpoint
   schema_types:
     instance_dict: predict.instance.TextSentimentPredictionInstance
   comments:
-    predictions: See gs://google-cloud-aiplatform/schema/predict/prediction/text_sentiment.yaml
+    predictions: See gs://google-cloud-aiplatform/schema/predict/prediction/text_sentiment_1.0.0.yaml
       for the format of the predictions.
 search_migratable_resources_sample: {}
 undeploy_model_sample:

CHANGELOG.md

@@ -1,5 +1,72 @@
 # Changelog
 
+## [1.9.0](https://www.github.com/googleapis/python-aiplatform/compare/v1.8.1...v1.9.0) (2021-12-29)
+
+
+### Features
+
+* add create in Featurestore, EntityType, Feature; add create_entity_type in Featurestore; add create_feature, batch_create_features in EntityType; add ingest_from_* for bq and gcs in EntityType; add and update delete with force delete nested resources ([#872](https://www.github.com/googleapis/python-aiplatform/issues/872)) ([ba11c3d](https://www.github.com/googleapis/python-aiplatform/commit/ba11c3d3cd8d3869e2deb3207a8698fa7ce284ec))
+* Add LIT methods for Pandas DataFrame and TensorFlow saved model. ([#874](https://www.github.com/googleapis/python-aiplatform/issues/874)) ([03cf301](https://www.github.com/googleapis/python-aiplatform/commit/03cf301989a5802b122803eac7a2d03f2d1769fb))
+* Add support to create TensorboardExperiment ([#909](https://www.github.com/googleapis/python-aiplatform/issues/909)) ([96ce738](https://www.github.com/googleapis/python-aiplatform/commit/96ce7387ac58e0ec7cb6a7f6d6a6e422eae5da96))
+* Add support to create TensorboardRun ([#912](https://www.github.com/googleapis/python-aiplatform/issues/912)) ([8df74a2](https://www.github.com/googleapis/python-aiplatform/commit/8df74a29df0adb95fff5500fcc9d7a025012ab5e))
+
+
+### Bug Fixes
+
+* Fix timestamp proto util to default to timestamp at call time. ([#933](https://www.github.com/googleapis/python-aiplatform/issues/933)) ([d72a254](https://www.github.com/googleapis/python-aiplatform/commit/d72a254e97cf74f3fdd55a32a4af86737243593a))
+* Improve handling of undeploying model without redistributing remaining traffic ([#898](https://www.github.com/googleapis/python-aiplatform/issues/898)) ([8a8a4fa](https://www.github.com/googleapis/python-aiplatform/commit/8a8a4faa667bde2a4df04afa23a6dd5b1856f958))
+* issues/192254729 ([#914](https://www.github.com/googleapis/python-aiplatform/issues/914)) ([3ec620c](https://www.github.com/googleapis/python-aiplatform/commit/3ec620c64bd60ceb5b89918200e11e3fbff67370))
+* issues/192254729 ([#915](https://www.github.com/googleapis/python-aiplatform/issues/915)) ([0f22ff6](https://www.github.com/googleapis/python-aiplatform/commit/0f22ff61460a3f2bd55d2c10c4ee06e582f03944))
+* use open_in_new_tab in the render method. ([#926](https://www.github.com/googleapis/python-aiplatform/issues/926)) ([04618e0](https://www.github.com/googleapis/python-aiplatform/commit/04618e0563b8588eec2ccd8342c6085ca08b5adb))
+
+### [1.8.1](https://www.github.com/googleapis/python-aiplatform/compare/v1.8.0...v1.8.1) (2021-12-14)
+
+
+### Bug Fixes
+
+* add clarity to param model_name ([#888](https://www.github.com/googleapis/python-aiplatform/issues/888)) ([1d81783](https://www.github.com/googleapis/python-aiplatform/commit/1d81783b2f914dd7606ee884ca31c1a594e5135f))
+* add clarity to parameters per user feedback ([#886](https://www.github.com/googleapis/python-aiplatform/issues/886)) ([37ee0a1](https://www.github.com/googleapis/python-aiplatform/commit/37ee0a1dc6e0105e19aca18f44995a352bfc40cb))
+* add param for multi-label per user's feedback ([#887](https://www.github.com/googleapis/python-aiplatform/issues/887)) ([fda942f](https://www.github.com/googleapis/python-aiplatform/commit/fda942ffbe009077b47f36aad1c29603a451e38b))
+* add support for API base path overriding ([#908](https://www.github.com/googleapis/python-aiplatform/issues/908)) ([45c4086](https://www.github.com/googleapis/python-aiplatform/commit/45c4086dd07dd7d3d3b7417196ff61a7107d8a1a))
+* Important the correct constants and use v1 for tensorboard experiments ([#905](https://www.github.com/googleapis/python-aiplatform/issues/905)) ([48c2bf1](https://www.github.com/googleapis/python-aiplatform/commit/48c2bf1ea2fa42afea1b5d419527bfb8e49e0ac0))
+* incorrect uri for IOD yaml ([#889](https://www.github.com/googleapis/python-aiplatform/issues/889)) ([e108ef8](https://www.github.com/googleapis/python-aiplatform/commit/e108ef8250c77c8a8edeccb6b601cbe0b0380c89))
+* Minor docstring and snippet fixes ([#873](https://www.github.com/googleapis/python-aiplatform/issues/873)) ([578e06d](https://www.github.com/googleapis/python-aiplatform/commit/578e06df481c3d60074a7b8e9365f8361b04e32b))
+
+
+### Documentation
+
+* Update references to containers and notebook samples. ([#890](https://www.github.com/googleapis/python-aiplatform/issues/890)) ([67fa1f1](https://www.github.com/googleapis/python-aiplatform/commit/67fa1f179af66686339d797e5b368e96816ed1c5))
+* Updated docstrings with exception error classes ([#894](https://www.github.com/googleapis/python-aiplatform/issues/894)) ([f9aecd2](https://www.github.com/googleapis/python-aiplatform/commit/f9aecd22fe08a97e45187b4d11c755ac3b9dfadd))
+
+## [1.8.0](https://www.github.com/googleapis/python-aiplatform/compare/v1.7.1...v1.8.0) (2021-12-03)
+
+
+### Features
+
+* Add cloud profiler to training_utils ([6d5c7c4](https://www.github.com/googleapis/python-aiplatform/commit/6d5c7c42d1c352f161e4738c6dbbf540a032017b))
+* add enable_private_service_connect field to Endpoint feat: add id field to DeployedModel feat: add service_attachment field to PrivateEndpoints feat: add endpoint_id to CreateEndpointRequest and method signature to CreateEndpoint feat: add method... ([#878](https://www.github.com/googleapis/python-aiplatform/issues/878)) ([ca813be](https://www.github.com/googleapis/python-aiplatform/commit/ca813be08ec2620380b5a12b0d6cdc079e27ba79))
+* add enable_private_service_connect field to Endpoint feat: add id field to DeployedModel feat: add service_attachment field to PrivateEndpoints feat: add endpoint_id to CreateEndpointRequest and method signature to CreateEndpoint feat: add method... ([#879](https://www.github.com/googleapis/python-aiplatform/issues/879)) ([47e93b2](https://www.github.com/googleapis/python-aiplatform/commit/47e93b20843f30805b73cd6db214c8743f8bfc97))
+* add featurestore module including Featurestore, EntityType, and Feature classes; add get, update, delete, list methods in all featurestore classes; add search method in Feature class ([#850](https://www.github.com/googleapis/python-aiplatform/issues/850)) ([66745a6](https://www.github.com/googleapis/python-aiplatform/commit/66745a6ce13fb8b32dd7fbf3eb86e71bd291869b))
+* Add prediction container URI builder method ([#805](https://www.github.com/googleapis/python-aiplatform/issues/805)) ([91dd3c0](https://www.github.com/googleapis/python-aiplatform/commit/91dd3c0d5de72fac5b1dc8a9bc23d6cb431061a4))
+* default to custom job display name if experiment name looks like a custom job ID ([#833](https://www.github.com/googleapis/python-aiplatform/issues/833)) ([8b9376e](https://www.github.com/googleapis/python-aiplatform/commit/8b9376e9c961a751799f5b80d1b19917c8c353f8))
+* Support uploading local models ([#779](https://www.github.com/googleapis/python-aiplatform/issues/779)) ([bffbd9d](https://www.github.com/googleapis/python-aiplatform/commit/bffbd9d359edb099e661736a0c77269bb3a0c746))
+* Tensorboard v1 protos release ([#847](https://www.github.com/googleapis/python-aiplatform/issues/847)) ([e0fc3d9](https://www.github.com/googleapis/python-aiplatform/commit/e0fc3d9e4e8a7911f21671ea49818c5f84798d12))
+* updating Tensorboard related code to use v1 ([#851](https://www.github.com/googleapis/python-aiplatform/issues/851)) ([b613b26](https://www.github.com/googleapis/python-aiplatform/commit/b613b264524aaab2cb65e63a5487770736faa7c8))
+* Upgrade Tensorboard from v1beta1 to v1 ([#849](https://www.github.com/googleapis/python-aiplatform/issues/849)) ([c40ec85](https://www.github.com/googleapis/python-aiplatform/commit/c40ec85e1fca2bee6813f52712d063f96264ec2c))
+
+
+### Bug Fixes
+
+* Import error for cloud_profiler ([#869](https://www.github.com/googleapis/python-aiplatform/issues/869)) ([0f124e9](https://www.github.com/googleapis/python-aiplatform/commit/0f124e93a1ddead16c0018970f34e45c73d5ed81))
+* Support multiple instances in custom predict sample ([#857](https://www.github.com/googleapis/python-aiplatform/issues/857)) ([8cb4839](https://www.github.com/googleapis/python-aiplatform/commit/8cb483918bdbaeae34935eef2b3cd997c1ae89a3))
+
+
+### Documentation
+
+* Added comment for evaluation_id to python examples ([#860](https://www.github.com/googleapis/python-aiplatform/issues/860)) ([004bf5f](https://www.github.com/googleapis/python-aiplatform/commit/004bf5fa4cb2d66e36de7ec52dee8e2c8dd438ee))
+* Reverted IDs in model_service snippets test ([#871](https://www.github.com/googleapis/python-aiplatform/issues/871)) ([da747b5](https://www.github.com/googleapis/python-aiplatform/commit/da747b5ffca3c12b8d64bc80bfe93da5afde0d43))
+* Update name of BQ source parameter in samples ([#859](https://www.github.com/googleapis/python-aiplatform/issues/859)) ([f11b598](https://www.github.com/googleapis/python-aiplatform/commit/f11b598f9069f77e86631ada53941876aea010bc))
+
 ### [1.7.1](https://www.github.com/googleapis/python-aiplatform/compare/v1.7.0...v1.7.1) (2021-11-16)
 
 

README.rst

@@ -1,4 +1,4 @@
-Vertex SDK for Python
+Vertex AI SDK for Python
 =================================================
 
 |GA| |pypi| |versions| |unit-tests| |system-tests| |sample-tests|
@@ -78,9 +78,9 @@ Windows
 
 Overview
 ~~~~~~~~
-This section provides a brief overview of the Vertex SDK for Python. You can also reference the notebooks in `vertex-ai-samples`_ for examples.
+This section provides a brief overview of the Vertex AI SDK for Python. You can also reference the notebooks in `vertex-ai-samples`_ for examples.
 
-.. _vertex-ai-samples: https://github.com/GoogleCloudPlatform/ai-platform-samples/tree/master/ai-platform-unified/notebooks/unofficial/sdk
+.. _vertex-ai-samples: https://github.com/GoogleCloudPlatform/vertex-ai-samples/tree/main/notebooks/community/sdk
 
 Importing
 ^^^^^^^^^
@@ -106,7 +106,7 @@ Initialize the SDK to store common configurations that you use with the SDK.
         # defaults to us-central1
         location='us-central1',
 
-        # Googlge Cloud Stoage bucket in same region as location
+        # Google Cloud Storage bucket in same region as location
         # used to stage artifacts
         staging_bucket='gs://my_staging_bucket',
 
@@ -166,7 +166,7 @@ Vertex AI supports a variety of dataset schemas. References to these schemas are
 
 Training
 ^^^^^^^^
-The Vertex SDK for Python allows you train Custom and AutoML Models.
+The Vertex AI SDK for Python allows you train Custom and AutoML Models.
 
 You can train custom models using a custom Python script, custom Python package, or container.
 
@@ -201,9 +201,9 @@ It must write the model artifact to the environment variable populated by the tr
   job = aiplatform.CustomTrainingJob(
       display_name="my-training-job",
       script_path="training_script.py",
-      container_uri="gcr.io/cloud-aiplatform/training/tf-cpu.2-2:latest",
+      container_uri="us-docker.pkg.dev/vertex-ai/training/tf-cpu.2-2:latest",
       requirements=["gcsfs==0.7.1"],
-      model_serving_container_image_uri="gcr.io/cloud-aiplatform/prediction/tf2-cpu.2-2:latest",
+      model_serving_container_image_uri="us-docker.pkg.dev/vertex-ai/prediction/tf2-cpu.2-2:latest",
   )
 
   model = job.run(my_dataset,
@@ -217,7 +217,7 @@ In the code block above `my_dataset` is managed dataset created in the `Dataset`
 
 AutoMLs
 -------
-The Vertex SDK for Python supports AutoML tabular, image, text, video, and forecasting.
+The Vertex AI SDK for Python supports AutoML tabular, image, text, video, and forecasting.
 
 To train an AutoML tabular model:
 
@@ -266,7 +266,7 @@ To upload a model:
   model = aiplatform.Model.upload(
       display_name='my-model',
       artifact_uri="gs://python/to/my/model/dir",
-      serving_container_image_uri="gcr.io/cloud-aiplatform/prediction/tf2-cpu.2-2:latest",
+      serving_container_image_uri="us-docker.pkg.dev/vertex-ai/prediction/tf2-cpu.2-2:latest",
   )
 
 To get a model:
@@ -358,7 +358,7 @@ To delete an endpoint:
 Pipelines
 ---------
 
-To create a Vertex Pipeline run and monitor until completion:
+To create a Vertex AI Pipeline run and monitor until completion:
 
 .. code-block:: Python
 
@@ -382,7 +382,7 @@ To create a Vertex Pipeline run and monitor until completion:
       pipeline_root=pipeline_root,
   )
 
-  # Execute pipeline in Vertex and monitor until completion
+  # Execute pipeline in Vertex AI and monitor until completion
   pl.run(
     # Email address of service account to use for the pipeline run
     # You must have iam.serviceAccounts.actAs permission on the service account to use it
@@ -393,7 +393,7 @@ To create a Vertex Pipeline run and monitor until completion:
     sync=True
   )
 
-To create a Vertex Pipeline without monitoring until completion, use `submit` instead of `run`:
+To create a Vertex AI Pipeline without monitoring until completion, use `submit` instead of `run`:
 
 .. code-block:: Python
 
@@ -417,7 +417,7 @@ To create a Vertex Pipeline without monitoring until completion, use `submit` in
       pipeline_root=pipeline_root,
   )
 
-  # Submit the Pipeline to Vertex
+  # Submit the Pipeline to Vertex AI
   pl.submit(
     # Email address of service account to use for the pipeline run
     # You must have iam.serviceAccounts.actAs permission on the service account to use it
@@ -467,7 +467,7 @@ To use Explanation Metadata in endpoint deployment and model upload:
 Cloud Profiler
 ----------------------------
 
-Cloud Profiler allows you to profile your remote Vertex AI Training jobs on demand and visualize the results in Vertex Tensorboard.
+Cloud Profiler allows you to profile your remote Vertex AI Training jobs on demand and visualize the results in Vertex AI Tensorboard.
 
 To start using the profiler with TensorFlow, update your training script to include the following:
 
@@ -477,7 +477,7 @@ To start using the profiler with TensorFlow, update your training script to incl
     ...
     cloud_profiler.init()
 
-Next, run the job with with a Vertex TensorBoard instance. For full details on how to do this, visit https://cloud.google.com/vertex-ai/docs/experiments/tensorboard-overview
+Next, run the job with with a Vertex AI TensorBoard instance. For full details on how to do this, visit https://cloud.google.com/vertex-ai/docs/experiments/tensorboard-overview
 
 Finally, visit your TensorBoard in your Google Cloud Console, navigate to the "Profile" tab, and click the `Capture Profile` button. This will allow users to capture profiling statistics for the running jobs.