Merge branch 'master' into batch_prediction_job_samples

README.rst

@@ -4,13 +4,7 @@ Python Client for Cloud AI Platform
 |beta| |pypi| |versions|
 
 
-:Warning: This library is a pre-release product and is subject to breaking changes.
-
-`Cloud AI Platform`_: Cloud AI Platform is a suite of machine learning tools that enables
-    developers to train high-quality models specific to their business needs.
-    It offers both novices and experts the best workbench for machine learning
-    development by leveraging Google's state-of-the-art transfer learning and
-    Neural Architecture Search technology.
+`Cloud AI Platform`_: Google Cloud AI Platform is an integrated suite of machine learning tools and services for building and using ML models with AutoML or custom code. It offers both novices and experts the best workbench for the entire machine learning development lifecycle.
 
 - `Client Library Documentation`_
 - `Product Documentation`_
@@ -21,9 +15,9 @@ Python Client for Cloud AI Platform
    :target: https://pypi.org/project/google-cloud-aiplatform/
 .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-aiplatform.svg
    :target: https://pypi.org/project/google-cloud-aiplatform/
-.. _Cloud AI Platform: https://cloud.google.com/ai-platform/docs
+.. _Cloud AI Platform: https://cloud.google.com/ai-platform-unified/docs
 .. _Client Library Documentation: https://googleapis.dev/python/aiplatform/latest
-.. _Product Documentation:  https://cloud.google.com/ai-platform/docs
+.. _Product Documentation:  https://cloud.google.com/ai-platform-unified/docs
 
 Quick Start
 -----------
@@ -85,5 +79,5 @@ Next Steps
 -  View this `README`_ to see the full list of Cloud
    APIs that we cover.
 
-.. _Cloud AI Platform API Product documentation:  https://cloud.google.com/ai-platform/docs
+.. _Cloud AI Platform API Product documentation:  https://cloud.google.com/ai-platform-unified/docs
 .. _README: https://github.com/googleapis/google-cloud-python/blob/master/README.rst

samples/snippets/create_batch_prediction_job_text_classification_sample.py

@@ -0,0 +1,55 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# [START aiplatform_create_batch_prediction_job_text_classification_sample]
+from google.cloud import aiplatform
+from google.protobuf.struct_pb2 import Value
+
+
+def create_batch_prediction_job_text_classification_sample(
+    project: str,
+    display_name: str,
+    model: str,
+    gcs_source_uri: str,
+    gcs_destination_output_uri_prefix: str,
+    location: str = "us-central1",
+    api_endpoint: str = "us-central1-aiplatform.googleapis.com",
+):
+    client_options = {"api_endpoint": api_endpoint}
+    # Initialize client that will be used to create and send requests.
+    # This client only needs to be created once, and can be reused for multiple requests.
+    client = aiplatform.gapic.JobServiceClient(client_options=client_options)
+
+    batch_prediction_job = {
+        "display_name": display_name,
+        # Format: 'projects/{project}/locations/{location}/models/{model_id}'
+        "model": model,
+        "model_parameters": Value(),
+        "input_config": {
+            "instances_format": "jsonl",
+            "gcs_source": {"uris": [gcs_source_uri]},
+        },
+        "output_config": {
+            "predictions_format": "jsonl",
+            "gcs_destination": {"output_uri_prefix": gcs_destination_output_uri_prefix},
+        },
+    }
+    parent = f"projects/{project}/locations/{location}"
+    response = client.create_batch_prediction_job(
+        parent=parent, batch_prediction_job=batch_prediction_job
+    )
+    print("response:", response)
+
+
+# [END aiplatform_create_batch_prediction_job_text_classification_sample]

samples/snippets/create_batch_prediction_job_text_classification_sample_test.py

@@ -0,0 +1,85 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from uuid import uuid4
+import pytest
+import os
+
+import helpers
+
+import create_batch_prediction_job_text_classification_sample
+import cancel_batch_prediction_job_sample
+import delete_batch_prediction_job_sample
+
+from google.cloud import aiplatform
+
+PROJECT_ID = os.getenv("BUILD_SPECIFIC_GCLOUD_PROJECT")
+LOCATION = "us-central1"
+MODEL_ID = "3863595899074641920"  # Permanent restaurant rating model
+DISPLAY_NAME = f"temp_create_batch_prediction_tcn_test_{uuid4()}"
+GCS_SOURCE_URI = (
+    "gs://ucaip-samples-test-output/inputs/batch_predict_TCN/tcn_inputs.jsonl"
+)
+GCS_OUTPUT_URI = "gs://ucaip-samples-test-output/"
+
+
+@pytest.fixture(scope="function")
+def shared_state():
+
+    shared_state = {}
+
+    yield shared_state
+
+    assert "/" in shared_state["batch_prediction_job_name"]
+
+    batch_prediction_job = shared_state["batch_prediction_job_name"].split("/")[-1]
+
+    # Stop the batch prediction job
+    cancel_batch_prediction_job_sample.cancel_batch_prediction_job_sample(
+        project=PROJECT_ID, batch_prediction_job_id=batch_prediction_job
+    )
+
+    job_client = aiplatform.gapic.JobServiceClient(
+        client_options={"api_endpoint": "us-central1-aiplatform.googleapis.com"}
+    )
+
+    # Waiting for batch prediction job to be in CANCELLED state
+    helpers.wait_for_job_state(
+        get_job_method=job_client.get_batch_prediction_job,
+        name=shared_state["batch_prediction_job_name"],
+    )
+
+    # Delete the batch prediction job
+    delete_batch_prediction_job_sample.delete_batch_prediction_job_sample(
+        project=PROJECT_ID, batch_prediction_job_id=batch_prediction_job
+    )
+
+
+# Creating AutoML Text Classification batch prediction job
+def test_ucaip_generated_create_batch_prediction_tcn_sample(capsys, shared_state):
+
+    model_name = f"projects/{PROJECT_ID}/locations/{LOCATION}/models/{MODEL_ID}"
+
+    create_batch_prediction_job_text_classification_sample.create_batch_prediction_job_text_classification_sample(
+        project=PROJECT_ID,
+        display_name=DISPLAY_NAME,
+        model=model_name,
+        gcs_source_uri=GCS_SOURCE_URI,
+        gcs_destination_output_uri_prefix=GCS_OUTPUT_URI,
+    )
+
+    out, _ = capsys.readouterr()
+
+    # Save resource name of the newly created batch prediction job
+    shared_state["batch_prediction_job_name"] = helpers.get_name(out)

samples/snippets/create_batch_prediction_job_text_entity_extraction_sample.py

@@ -0,0 +1,55 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# [START aiplatform_create_batch_prediction_job_text_entity_extraction_sample]
+from google.cloud import aiplatform
+from google.protobuf.struct_pb2 import Value
+
+
+def create_batch_prediction_job_text_entity_extraction_sample(
+    project: str,
+    display_name: str,
+    model: str,
+    gcs_source_uri: str,
+    gcs_destination_output_uri_prefix: str,
+    location: str = "us-central1",
+    api_endpoint: str = "us-central1-aiplatform.googleapis.com",
+):
+    client_options = {"api_endpoint": api_endpoint}
+    # Initialize client that will be used to create and send requests.
+    # This client only needs to be created once, and can be reused for multiple requests.
+    client = aiplatform.gapic.JobServiceClient(client_options=client_options)
+
+    batch_prediction_job = {
+        "display_name": display_name,
+        # Format: 'projects/{project}/locations/{location}/models/{model_id}'
+        "model": model,
+        "model_parameters": Value(),
+        "input_config": {
+            "instances_format": "jsonl",
+            "gcs_source": {"uris": [gcs_source_uri]},
+        },
+        "output_config": {
+            "predictions_format": "jsonl",
+            "gcs_destination": {"output_uri_prefix": gcs_destination_output_uri_prefix},
+        },
+    }
+    parent = f"projects/{project}/locations/{location}"
+    response = client.create_batch_prediction_job(
+        parent=parent, batch_prediction_job=batch_prediction_job
+    )
+    print("response:", response)
+
+
+# [END aiplatform_create_batch_prediction_job_text_entity_extraction_sample]

samples/snippets/create_batch_prediction_job_text_entity_extraction_sample_test.py

@@ -0,0 +1,85 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from uuid import uuid4
+import pytest
+import os
+
+import helpers
+
+import create_batch_prediction_job_text_entity_extraction_sample
+import cancel_batch_prediction_job_sample
+import delete_batch_prediction_job_sample
+
+from google.cloud import aiplatform
+
+PROJECT_ID = os.getenv("BUILD_SPECIFIC_GCLOUD_PROJECT")
+LOCATION = "us-central1"
+MODEL_ID = "5216364637146054656"  # Permanent medical entity NL model
+DISPLAY_NAME = f"temp_create_batch_prediction_ten_test_{uuid4()}"
+GCS_SOURCE_URI = (
+    "gs://ucaip-samples-test-output/inputs/batch_predict_TEN/ten_inputs.jsonl"
+)
+GCS_OUTPUT_URI = "gs://ucaip-samples-test-output/"
+
+
+@pytest.fixture(scope="function")
+def shared_state():
+
+    shared_state = {}
+
+    yield shared_state
+
+    assert "/" in shared_state["batch_prediction_job_name"]
+
+    batch_prediction_job = shared_state["batch_prediction_job_name"].split("/")[-1]
+
+    # Stop the batch prediction job
+    cancel_batch_prediction_job_sample.cancel_batch_prediction_job_sample(
+        project=PROJECT_ID, batch_prediction_job_id=batch_prediction_job
+    )
+
+    job_client = aiplatform.gapic.JobServiceClient(
+        client_options={"api_endpoint": "us-central1-aiplatform.googleapis.com"}
+    )
+
+    # Waiting for batch prediction job to be in CANCELLED state
+    helpers.wait_for_job_state(
+        get_job_method=job_client.get_batch_prediction_job,
+        name=shared_state["batch_prediction_job_name"],
+    )
+
+    # Delete the batch prediction job
+    delete_batch_prediction_job_sample.delete_batch_prediction_job_sample(
+        project=PROJECT_ID, batch_prediction_job_id=batch_prediction_job
+    )
+
+
+# Creating AutoML Text Entity Extraction batch prediction job
+def test_ucaip_generated_create_batch_prediction_ten_sample(capsys, shared_state):
+
+    model_name = f"projects/{PROJECT_ID}/locations/{LOCATION}/models/{MODEL_ID}"
+
+    create_batch_prediction_job_text_entity_extraction_sample.create_batch_prediction_job_text_entity_extraction_sample(
+        project=PROJECT_ID,
+        display_name=DISPLAY_NAME,
+        model=model_name,
+        gcs_source_uri=GCS_SOURCE_URI,
+        gcs_destination_output_uri_prefix=GCS_OUTPUT_URI,
+    )
+
+    out, _ = capsys.readouterr()
+
+    # Save resource name of the newly created batch prediction job
+    shared_state["batch_prediction_job_name"] = helpers.get_name(out)

samples/snippets/create_batch_prediction_job_text_sentiment_analysis_sample.py

@@ -0,0 +1,55 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# [START aiplatform_create_batch_prediction_job_text_sentiment_analysis_sample]
+from google.cloud import aiplatform
+from google.protobuf.struct_pb2 import Value
+
+
+def create_batch_prediction_job_text_sentiment_analysis_sample(
+    project: str,
+    display_name: str,
+    model: str,
+    gcs_source_uri: str,
+    gcs_destination_output_uri_prefix: str,
+    location: str = "us-central1",
+    api_endpoint: str = "us-central1-aiplatform.googleapis.com",
+):
+    client_options = {"api_endpoint": api_endpoint}
+    # Initialize client that will be used to create and send requests.
+    # This client only needs to be created once, and can be reused for multiple requests.
+    client = aiplatform.gapic.JobServiceClient(client_options=client_options)
+
+    batch_prediction_job = {
+        "display_name": display_name,
+        # Format: 'projects/{project}/locations/{location}/models/{model_id}'
+        "model": model,
+        "model_parameters": Value(),
+        "input_config": {
+            "instances_format": "jsonl",
+            "gcs_source": {"uris": [gcs_source_uri]},
+        },
+        "output_config": {
+            "predictions_format": "jsonl",
+            "gcs_destination": {"output_uri_prefix": gcs_destination_output_uri_prefix},
+        },
+    }
+    parent = f"projects/{project}/locations/{location}"
+    response = client.create_batch_prediction_job(
+        parent=parent, batch_prediction_job=batch_prediction_job
+    )
+    print("response:", response)
+
+
+# [END aiplatform_create_batch_prediction_job_text_sentiment_analysis_sample]