model_garden/notebooks/community/migration/UJ8 unified AutoML Natural Language - Text Sentiment Analysis.ipynb

In [ ]:

# Copyright 2021 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.

Vertex AI AutoML text sentiment analysis model

Installation

Install the latest (preview) version of Vertex SDK.

In [ ]:

! pip3 install -U google-cloud-aiplatform --user

Install the Google cloud-storage library as well.

In [ ]:

! pip3 install google-cloud-storage

Restart the Kernel

Once you've installed the Vertex SDK and Google cloud-storage, you need to restart the notebook kernel so it can find the packages.

In [ ]:

import os

if not os.getenv("AUTORUN"):
    # Automatically restart kernel after installs
    import IPython

    app = IPython.Application.instance()
    app.kernel.do_shutdown(True)

Before you begin

GPU run-time

Make sure you're running this notebook in a GPU runtime if you have that option. In Colab, select Runtime > Change Runtime Type > GPU

Set up your GCP project

The following steps are required, regardless of your notebook environment.

1. Select or create a GCP project. When you first create an account, you get a $300 free credit towards your compute/storage costs.

2. Make sure that billing is enabled for your project.

3. Enable the Vertex APIs and Compute Engine APIs.

4. Google Cloud SDK is already installed in Google Cloud Notebooks.

5. Enter your project ID in the cell below. Then run the cell to make sure the Cloud SDK uses the right project for all the commands in this notebook.

Note: Jupyter runs lines prefixed with ! as shell commands, and it interpolates Python variables prefixed with $ into these commands.

In [ ]:

PROJECT_ID = "[your-project-id]"  # @param {type:"string"}

In [ ]:

if PROJECT_ID == "" or PROJECT_ID is None or PROJECT_ID == "[your-project-id]":
    # Get your GCP project id from gcloud
    shell_output = !gcloud config list --format 'value(core.project)' 2>/dev/null
    PROJECT_ID = shell_output[0]
    print("Project ID:", PROJECT_ID)

In [ ]:

! gcloud config set project $PROJECT_ID

Region

You can also change the REGION variable, which is used for operations throughout the rest of this notebook. Below are regions supported for Vertex AI. We recommend when possible, to choose the region closest to you.

• Americas: us-central1
• Europe: europe-west4
• Asia Pacific: asia-east1

You cannot use a Multi-Regional Storage bucket for training with Vertex. Not all regions provide support for all Vertex services. For the latest support per region, see Region support for Vertex AI services

In [ ]:

REGION = "us-central1"  # @param {type: "string"}

Timestamp

If you are in a live tutorial session, you might be using a shared test account or project. To avoid name collisions between users on resources created, you create a timestamp for each instance session, and append onto the name of resources which will be created in this tutorial.

In [ ]:

from datetime import datetime

TIMESTAMP = datetime.now().strftime("%Y%m%d%H%M%S")

Authenticate your GCP account

If you are using Google Cloud Notebooks, your environment is already authenticated. Skip this step.

Note: If you are on an Vertex notebook and run the cell, the cell knows to skip executing the authentication steps.

In [ ]:

import os
import sys

# If you are running this notebook in Colab, run this cell and follow the
# instructions to authenticate your Google Cloud account. This provides access
# to your Cloud Storage bucket and lets you submit training jobs and prediction
# requests.

# If on Vertex, then don't execute this code
if not os.path.exists("/opt/deeplearning/metadata/env_version"):
    if "google.colab" in sys.modules:
        from google.colab import auth as google_auth

        google_auth.authenticate_user()

    # If you are running this tutorial in a notebook locally, replace the string
    # below with the path to your service account key and run this cell to
    # authenticate your Google Cloud account.
    else:
        %env GOOGLE_APPLICATION_CREDENTIALS your_path_to_credentials.json

    # Log in to your account on Google Cloud
    ! gcloud auth login

Create a Cloud Storage bucket

The following steps are required, regardless of your notebook environment.

This tutorial is designed to use training data that is in a public Cloud Storage bucket and a local Cloud Storage bucket for your batch predictions. You may alternatively use your own training data that you have stored in a local Cloud Storage bucket.

Set the name of your Cloud Storage bucket below. It must be unique across all Cloud Storage buckets.

In [ ]:

BUCKET_NAME = "[your-bucket-name]"  # @param {type:"string"}

In [ ]:

if BUCKET_NAME == "" or BUCKET_NAME is None or BUCKET_NAME == "[your-bucket-name]":
    BUCKET_NAME = PROJECT_ID + "aip-" + TIMESTAMP

Only if your bucket doesn't already exist: Run the following cell to create your Cloud Storage bucket.

In [ ]:

! gsutil mb -l $REGION gs://$BUCKET_NAME

Finally, validate access to your Cloud Storage bucket by examining its contents:

In [ ]:

! gsutil ls -al gs://$BUCKET_NAME

Set up variables

Next, set up some variables used throughout the tutorial.

Import libraries and define constants

Import Vertex SDK

Import the Vertex SDK into our Python environment.

In [ ]:

import json
import os
import sys
import time

from google.cloud.aiplatform import gapic as aip
from google.protobuf import json_format
from google.protobuf.json_format import MessageToJson
from google.protobuf.struct_pb2 import Struct, Value

Vertex AI constants

Setup up the following constants for Vertex AI:

• API_ENDPOINT: The Vertex AI API service endpoint for dataset, model, job, pipeline and endpoint services.
• PARENT: The Vertex AI location root path for dataset, model and endpoint resources.

In [ ]:

# API Endpoint
API_ENDPOINT = "us-central1-aiplatform.googleapis.com"

# Vertex AI location root path for your dataset, model and endpoint resources
PARENT = "projects/" + PROJECT_ID + "/locations/" + REGION

AutoML constants

Next, setup constants unique to AutoML Text Entity Extraction datasets and training:

• Dataset Schemas: Tells the managed dataset service which type of dataset it is.
• Data Labeling (Annotations) Schemas: Tells the managed dataset service how the data is labeled (annotated).
• Dataset Training Schemas: Tells the managed pipelines service the task (e.g., classification) to train the model for.

In [ ]:

# Text Dataset type
TEXT_SCHEMA = "google-cloud-aiplatform/schema/dataset/metadata/text_1.0.0.yaml"
# Text Labeling type
IMPORT_SCHEMA_TEXT_SENTIMENT = "gs://google-cloud-aiplatform/schema/dataset/ioformat/text_sentiment_io_format_1.0.0.yaml"
# Text Training task
TRAINING_TEXT_SENTIMENT_SCHEMA = "gs://google-cloud-aiplatform/schema/trainingjob/definition/automl_text_sentiment_1.0.0.yaml"

Clients

The Vertex SDK works as a client/server model. On your side (the Python script) you will create a client that sends requests and receives responses from the server (Vertex).

You will use several clients in this tutorial, so set them all up upfront.

• Dataset Service for managed datasets.
• Model Service for managed models.
• Pipeline Service for training.
• Endpoint Service for deployment.
• Job Service for batch jobs and custom training.
• Prediction Service for serving. Note: Prediction has a different service endpoint.

In [ ]:

# client options same for all services
client_options = {"api_endpoint": API_ENDPOINT}


def create_dataset_client():
    client = aip.DatasetServiceClient(client_options=client_options)
    return client


def create_model_client():
    client = aip.ModelServiceClient(client_options=client_options)
    return client


def create_pipeline_client():
    client = aip.PipelineServiceClient(client_options=client_options)
    return client


def create_endpoint_client():
    client = aip.EndpointServiceClient(client_options=client_options)
    return client


def create_prediction_client():
    client = aip.PredictionServiceClient(client_options=client_options)
    return client


def create_job_client():
    client = aip.JobServiceClient(client_options=client_options)
    return client


clients = {}
clients["dataset"] = create_dataset_client()
clients["model"] = create_model_client()
clients["pipeline"] = create_pipeline_client()
clients["endpoint"] = create_endpoint_client()
clients["prediction"] = create_prediction_client()
clients["job"] = create_job_client()

for client in clients.items():
    print(client)

In [ ]:

IMPORT_FILE = "gs://cloud-samples-data/language/claritin-split.csv"

In [ ]:

! gsutil cat $IMPORT_FILE | head -n 10

Example output:

TRAINING,@freewrytin God is way too good for Claritin,2,4
TRAINING,I need Claritin. So bad. When did I become cursed with allergies?,3,4
TRAINING,Thank god for Claritin.,4,4
TRAINING,"And what's worse is that I reached my 3-day limit on the nose spray yesterday, which means I have to rely on Claritin.",2,4
TRAINING,Time to take some Claritin or Allegra or something. I need my voice,3,4
TRAINING,Oh my RT @imsydneycharles: I just want it to be on record somewhere that I took Claritin and Benadryl together...just in case I pass out,2,4
TRAINING,Bouta take a Claritin _‰Ûª‰Û_‰Ûª_‰ÛªÌâ FML !!,3,4
TRAINING,Commander Loratadine Generic A Sarcelles: Commander Loratadine Generic A Sarcelles Claritin =‰Ûª_‰Ûª__ http://t.co/mOleL8AM,2,4
TRAINING,"Zyrtec, Claritin, Suddafed, Nasal Spray.. I feel like a drug addict taking these Allergy medicine. Please Allergy season.. DISAPPEAR!!",1,4
TRAINING,"‰Ûª_‰Ûª_‰ÛªÕ@SheLovesThatD: If she has allergies, give her the Claritin D.‰Ûª_‰Ûª_Ì_å @Sweeno_thakid41 @B_Original16 @luke_CYwalker14",3,4

Create a dataset

Prepare data

projects.locations.datasets.create

Request

In [ ]:

DATA_SCHEMA = TEXT_SCHEMA

dataset = {
    "display_name": "claritin_" + TIMESTAMP,
    "metadata_schema_uri": "gs://" + DATA_SCHEMA,
}

print(
    MessageToJson(
        aip.CreateDatasetRequest(parent=PARENT, dataset=dataset).__dict__["_pb"]
    )
)

Example output:

{
  "parent": "projects/migration-ucaip-training/locations/us-central1",
  "dataset": {
    "displayName": "claritin_20210301212135",
    "metadataSchemaUri": "gs://google-cloud-aiplatform/schema/dataset/metadata/text_1.0.0.yaml"
  }
}

Call

In [ ]:

request = clients["dataset"].create_dataset(parent=PARENT, dataset=dataset)

Response

In [ ]:

result = request.result()

print(MessageToJson(result.__dict__["_pb"]))

Example output:

{
  "name": "projects/116273516712/locations/us-central1/datasets/3047617533776494592",
  "displayName": "claritin_20210301212135",
  "metadataSchemaUri": "gs://google-cloud-aiplatform/schema/dataset/metadata/text_1.0.0.yaml",
  "labels": {
    "aiplatform.googleapis.com/dataset_metadata_schema": "TEXT"
  },
  "metadata": {
    "dataItemSchemaUri": "gs://google-cloud-aiplatform/schema/dataset/dataitem/text_1.0.0.yaml"
  }
}

In [ ]:

# The full unique ID for the dataset
dataset_id = result.name
# The short numeric ID for the dataset
dataset_short_id = dataset_id.split("/")[-1]

print(dataset_id)

projects.locations.datasets.import

Request

In [ ]:

LABEL_SCHEMA = IMPORT_SCHEMA_TEXT_SENTIMENT

import_config = {
    "gcs_source": {"uris": [IMPORT_FILE]},
    "import_schema_uri": LABEL_SCHEMA,
}

print(
    MessageToJson(
        aip.ImportDataRequest(name=dataset_id, import_configs=[import_config]).__dict__[
            "_pb"
        ]
    )
)

Example output:

{
  "name": "projects/116273516712/locations/us-central1/datasets/3047617533776494592",
  "importConfigs": [
    {
      "gcsSource": {
        "uris": [
          "gs://cloud-samples-data/language/claritin-split.csv"
        ]
      },
      "importSchemaUri": "gs://google-cloud-aiplatform/schema/dataset/ioformat/text_sentiment_io_format_1.0.0.yaml"
    }
  ]
}

Call

In [ ]:

request = clients["dataset"].import_data(
    name=dataset_id, import_configs=[import_config]
)

Response

In [ ]:

result = request.result()

print(MessageToJson(result.__dict__["_pb"]))

Example output:

{}

Train a model

projects.locations.trainingPipelines.create

Request

In [ ]:

TRAINING_SCHEMA = TRAINING_TEXT_SENTIMENT_SCHEMA

task = Value(struct_value=Struct(fields={"sentiment_max": Value(number_value=4)}))

training_pipeline = {
    "display_name": "claritin_" + TIMESTAMP,
    "input_data_config": {"dataset_id": dataset_short_id},
    "model_to_upload": {"display_name": "claritin_" + TIMESTAMP},
    "training_task_definition": TRAINING_SCHEMA,
    "training_task_inputs": task,
}

print(
    MessageToJson(
        aip.CreateTrainingPipelineRequest(
            parent=PARENT,
            training_pipeline=training_pipeline,
        ).__dict__["_pb"]
    )
)

Example output:

{
  "parent": "projects/migration-ucaip-training/locations/us-central1",
  "trainingPipeline": {
    "displayName": "claritin_20210301212135",
    "inputDataConfig": {
      "datasetId": "3047617533776494592"
    },
    "trainingTaskDefinition": "gs://google-cloud-aiplatform/schema/trainingjob/definition/automl_text_sentiment_1.0.0.yaml",
    "trainingTaskInputs": {
      "sentiment_max": 4.0
    },
    "modelToUpload": {
      "displayName": "claritin_20210301212135"
    }
  }
}

Call

In [ ]:

request = clients["pipeline"].create_training_pipeline(
    parent=PARENT, training_pipeline=training_pipeline
)

Response

In [ ]:

print(MessageToJson(request.__dict__["_pb"]))

Example output:

{
  "name": "projects/116273516712/locations/us-central1/trainingPipelines/5293990158067040256",
  "displayName": "claritin_20210301212135",
  "inputDataConfig": {
    "datasetId": "3047617533776494592"
  },
  "trainingTaskDefinition": "gs://google-cloud-aiplatform/schema/trainingjob/definition/automl_text_sentiment_1.0.0.yaml",
  "trainingTaskInputs": {
    "sentimentMax": 4.0
  },
  "modelToUpload": {
    "displayName": "claritin_20210301212135"
  },
  "state": "PIPELINE_STATE_PENDING",
  "createTime": "2021-03-01T21:32:03.085444Z",
  "updateTime": "2021-03-01T21:32:03.085444Z"
}

In [ ]:

# The full unique ID for the training pipeline
training_pipeline_id = request.name
# The short numeric ID for the training pipeline
training_pipeline_short_id = training_pipeline_id.split("/")[-1]

print(training_pipeline_id)

projects.locations.trainingPipelines.get

Call

In [ ]:

request = clients["pipeline"].get_training_pipeline(name=training_pipeline_id)

Response

In [ ]:

print(MessageToJson(request.__dict__["_pb"]))

Example output:

{
  "name": "projects/116273516712/locations/us-central1/trainingPipelines/5293990158067040256",
  "displayName": "claritin_20210301212135",
  "inputDataConfig": {
    "datasetId": "3047617533776494592"
  },
  "trainingTaskDefinition": "gs://google-cloud-aiplatform/schema/trainingjob/definition/automl_text_sentiment_1.0.0.yaml",
  "trainingTaskInputs": {
    "sentimentMax": 4.0
  },
  "modelToUpload": {
    "displayName": "claritin_20210301212135"
  },
  "state": "PIPELINE_STATE_PENDING",
  "createTime": "2021-03-01T21:32:03.085444Z",
  "updateTime": "2021-03-01T21:32:03.085444Z"
}

In [ ]:

while True:
    response = clients["pipeline"].get_training_pipeline(name=training_pipeline_id)
    if response.state != aip.PipelineState.PIPELINE_STATE_SUCCEEDED:
        print("Training job has not completed:", response.state)
        if response.state == aip.PipelineState.PIPELINE_STATE_FAILED:
            break
    else:
        model_id = response.model_to_upload.name
        print("Training Time:", response.end_time - response.start_time)
        break
    time.sleep(20)

print(model_id)

Evaluate the model

projects.locations.models.evaluations.list

Call

In [ ]:

request = clients["model"].list_model_evaluations(parent=model_id)

Response

In [ ]:

model_evaluations = [json.loads(MessageToJson(mel.__dict__["_pb"])) for mel in request]

# The evaluation slice
evaluation_slice = request.model_evaluations[0].name

print(json.dumps(model_evaluations, indent=2))

Example output:

[
  {
    "name": "projects/116273516712/locations/us-central1/models/5497364624833511424/evaluations/412684097299677184",
    "metricsSchemaUri": "gs://google-cloud-aiplatform/schema/modelevaluation/text_sentiment_metrics_1.0.0.yaml",
    "metrics": {
      "linearKappa": 0.4001057,
      "quadraticKappa": 0.48378703,
      "precision": 0.59030837,
      "confusionMatrix": {
        "rows": [
          [
            3.0,
            4.0,
            1.0,
            1.0,
            0.0
          ],
          [
            2.0,
            19.0,
            25.0,
            18.0,
            0.0
          ],
          [
            0.0,
            10.0,
            72.0,
            57.0,
            0.0
          ],
          [
            0.0,
            16.0,
            34.0,
            169.0,
            5.0
          ],
          [
            0.0,
            0.0,
            2.0,
            11.0,
            5.0
          ]
        ],
        "annotationSpecs": [
          {
            "displayName": "0",
            "id": "7302033741432487936"
          },
          {
            "id": "1537426218398253056",
            "displayName": "1"
          },
          {
            "displayName": "2",
            "id": "6149112236825640960"
          },
          {
            "displayName": "3",
            "id": "3843269227611947008"
          },
          {
            "displayName": "4",
            "id": "8454955246039334912"
          }
        ]
      },
      "meanAbsoluteError": 0.4955947,
      "f1Score": 0.59030837,
      "recall": 0.59030837,
      "meanSquaredError": 0.67180616
    },
    "createTime": "2021-03-02T01:41:13.130713Z",
    "sliceDimensions": [
      "annotationSpec"
    ]
  }
]

projects.locations.models.evaluations.get

Call

In [ ]:

request = clients["model"].get_model_evaluation(name=evaluation_slice)

Response

In [ ]:

print(MessageToJson(request.__dict__["_pb"]))

Example output:

{
  "name": "projects/116273516712/locations/us-central1/models/5497364624833511424/evaluations/412684097299677184",
  "metricsSchemaUri": "gs://google-cloud-aiplatform/schema/modelevaluation/text_sentiment_metrics_1.0.0.yaml",
  "metrics": {
    "meanSquaredError": 0.67180616,
    "linearKappa": 0.4001057,
    "precision": 0.59030837,
    "recall": 0.59030837,
    "confusionMatrix": {
      "annotationSpecs": [
        {
          "id": "7302033741432487936",
          "displayName": "0"
        },
        {
          "id": "1537426218398253056",
          "displayName": "1"
        },
        {
          "displayName": "2",
          "id": "6149112236825640960"
        },
        {
          "id": "3843269227611947008",
          "displayName": "3"
        },
        {
          "id": "8454955246039334912",
          "displayName": "4"
        }
      ],
      "rows": [
        [
          3.0,
          4.0,
          1.0,
          1.0,
          0.0
        ],
        [
          2.0,
          19.0,
          25.0,
          18.0,
          0.0
        ],
        [
          0.0,
          10.0,
          72.0,
          57.0,
          0.0
        ],
        [
          0.0,
          16.0,
          34.0,
          169.0,
          5.0
        ],
        [
          0.0,
          0.0,
          2.0,
          11.0,
          5.0
        ]
      ]
    },
    "meanAbsoluteError": 0.4955947,
    "quadraticKappa": 0.48378703,
    "f1Score": 0.59030837
  },
  "createTime": "2021-03-02T01:41:13.130713Z",
  "sliceDimensions": [
    "annotationSpec"
  ]
}

Make batch predictions

Make the batch input file

Let's now make a batch input file, which you will store in your local Cloud Storage bucket. The batch input file can be either CSV or JSONL. You will use JSONL in this tutorial. For JSONL file, you make one dictionary entry per line for each data item (instance). The dictionary contains the key/value pairs:

• content: The Cloud Storage path to the image.
• mime_type: The content type. In our example, it is an test/plain file.

In [ ]:

import json

import tensorflow as tf

test_data = ! gsutil cat $IMPORT_FILE | head -n1

test_item = str(test_data[0]).split(",")[1]
test_label = str(test_data[0]).split(",")[2]

gcs_test_item = "gs://" + BUCKET_NAME + "/test.txt"
with tf.io.gfile.GFile(gcs_test_item, "w") as f:
    f.write(test_item + "\n")

gcs_input_uri = "gs://" + BUCKET_NAME + "/test.jsonl"
with tf.io.gfile.GFile(gcs_input_uri, "w") as f:
    data = {"content": gcs_test_item, "mime_type": "text/plain"}
    f.write(json.dumps(data) + "\n")

! gsutil cat $gcs_input_uri
! gsutil cat $gcs_test_item

Example output:

{"content": "gs://migration-ucaip-trainingaip-20210301212135/test.txt", "mime_type": "text/plain"}
@freewrytin God is way too good for Claritin

projects.locations.batchPredictionJobs.create

Request

In [ ]:

batch_prediction_job = {
    "display_name": "claritin_" + TIMESTAMP,
    "model": model_id,
    "input_config": {
        "instances_format": "jsonl",
        "gcs_source": {"uris": [gcs_input_uri]},
    },
    "output_config": {
        "predictions_format": "jsonl",
        "gcs_destination": {
            "output_uri_prefix": "gs://" + f"{BUCKET_NAME}/batch_output/"
        },
    },
    "dedicated_resources": {
        "machine_spec": {"machine_type": "n1-standard-2", "accelerator_count": 0},
        "starting_replica_count": 1,
        "max_replica_count": 1,
    },
}

print(
    MessageToJson(
        aip.CreateBatchPredictionJobRequest(
            parent=PARENT, batch_prediction_job=batch_prediction_job
        ).__dict__["_pb"]
    )
)

Example output:

{
  "parent": "projects/migration-ucaip-training/locations/us-central1",
  "batchPredictionJob": {
    "displayName": "claritin_20210301212135",
    "model": "projects/116273516712/locations/us-central1/models/5497364624833511424",
    "inputConfig": {
      "instancesFormat": "jsonl",
      "gcsSource": {
        "uris": [
          "gs://migration-ucaip-trainingaip-20210301212135/test.jsonl"
        ]
      }
    },
    "outputConfig": {
      "predictionsFormat": "jsonl",
      "gcsDestination": {
        "outputUriPrefix": "gs://migration-ucaip-trainingaip-20210301212135/batch_output/"
      }
    },
    "dedicatedResources": {
      "machineSpec": {
        "machineType": "n1-standard-2"
      },
      "startingReplicaCount": 1,
      "maxReplicaCount": 1
    }
  }
}

Call

In [ ]:

request = clients["job"].create_batch_prediction_job(
    parent=PARENT, batch_prediction_job=batch_prediction_job
)

Response

In [ ]:

print(MessageToJson(request.__dict__["_pb"]))

Warning:

Output truncated. This notebook contains too many cells to display efficiently.