Amazon SageMaker Model Monitor with TensorFlow

This notebook’s CI test result for us-west-2 is as follows. CI test results in other regions can be found at the end of the notebook.

This notebook shows how to: * Host a machine learning model in Amazon SageMaker and capture inference requests, results, and metadata * Analyze a training dataset to generate baseline constraints * Monitor a live endpoint for violations against constraints

Setup

To get started, make sure you have these prerequisites completed.

Specify an AWS Region to host your model.
An IAM role ARN exists that is used to give Amazon SageMaker access to your data in Amazon Simple Storage Service (Amazon S3). See the documentation for how to fine tune the permissions needed.
Create an S3 bucket used to store the data used to train your model, any additional model data, and the data captured from model invocations. For demonstration purposes, you are using the same bucket for these. In reality, you might want to separate them with different security policies.

[ ]:

! pip install s3fs

[ ]:

import boto3
import os
import sagemaker
from sagemaker import get_execution_role

region = boto3.Session().region_name
role = get_execution_role()
sess = sagemaker.session.Session()
bucket = sess.default_bucket()
prefix = "sagemaker/DEMO-tf2-ModelMonitor"

data_capture_prefix = "{}/monitoring/datacapture".format(prefix)
s3_capture_upload_path = "s3://{}/{}".format(bucket, data_capture_prefix)

reports_prefix = "{}/reports".format(prefix)
s3_report_path = "s3://{}/{}".format(bucket, reports_prefix)

print("Capture path: {}".format(s3_capture_upload_path))
print("Report path: {}".format(s3_report_path))

PART A: Capturing real-time inference data from Amazon SageMaker endpoints

Create an endpoint to showcase the data capture capability in action.

Upload the pre-trained model to Amazon S3

This code uploads a pre-trained Tensorflow model that is ready for you to deploy. This model was trained using the on the well-known California Housing data. You can also use your own pre-trained model in this step. If you already have a pretrained model in Amazon S3, you can add it instead by specifying the s3_key.

[ ]:

model_file = open("model/tensorflow_california_housing_model.tar.gz", "rb")
s3_key = os.path.join(prefix, "tensorflow_california_housing_model.tar.gz")
boto3.Session().resource("s3").Bucket(bucket).Object(s3_key).upload_fileobj(model_file)

Deploy the model to Amazon SageMaker

Start with deploying a pre-trained california housing model. Here, you create the model object with the image and model data.

[ ]:

model_path = "s3://{}/{}/tensorflow_california_housing_model.tar.gz".format(bucket, prefix)
model_path

Here, you create the model object with the image and model data.

[ ]:

from sagemaker.tensorflow.model import TensorFlowModel

tensorflow_model = TensorFlowModel(model_data=model_path, role=role, framework_version="2.3.1")

To enable data capture for monitoring the model data quality, you specify the new capture option called DataCaptureConfig. You can capture the request payload, the response payload or both with this configuration. The capture config applies to all variants. Go ahead with the deployment.

[ ]:

from time import gmtime, strftime
from sagemaker.model_monitor import DataCaptureConfig

endpoint_name = "DEMO-tf2-california-housing-model-monitor-" + strftime(
    "%Y-%m-%d-%H-%M-%S", gmtime()
)
print(endpoint_name)

predictor = tensorflow_model.deploy(
    initial_instance_count=1,
    instance_type="ml.m5.xlarge",
    endpoint_name=endpoint_name,
    data_capture_config=DataCaptureConfig(
        enable_capture=True, sampling_percentage=100, destination_s3_uri=s3_capture_upload_path
    ),
)

Prepare dataset

Next, we’ll import the dataset. The dataset itself is small and relatively issue-free. For example, there are no missing values, a common problem for many other datasets. Accordingly, preprocessing just involves normalizing the data.

[ ]:

import pandas as pd
import numpy as np
from sklearn.datasets import *
import sklearn.model_selection
from sklearn.preprocessing import StandardScaler

data_set = fetch_california_housing()

X = pd.DataFrame(data_set.data, columns=data_set.feature_names)
Y = pd.DataFrame(data_set.target)

x_train, x_test, y_train, y_test = sklearn.model_selection.train_test_split(X, Y, test_size=0.33)
scaler = StandardScaler()
scaler.fit(x_train)
x_train = scaler.transform(x_train)
x_test = scaler.transform(x_test)

Invoke the deployed model

You can now send data to this endpoint to get inferences in real time. Because you enabled the data capture in the previous steps, the request and response payload, along with some additional metadata, is saved in the Amazon Simple Storage Service (Amazon S3) location you have specified in the DataCaptureConfig.

We will invoke the endpoint to see a single prediction. Note that the TensorFlow Serving returns a JSON with array of predictions here.

[ ]:

result = predictor.predict(x_test[0])
result

This step invokes the endpoint with included sample data for about 3 minutes. Data is captured based on the sampling percentage specified and the capture continues until the data capture option is turned off.

[ ]:

%%time

import time

print("Sending test traffic to the endpoint {}. \nPlease wait...".format(endpoint_name))

flat_list = []
for i in range(360):
    result = predictor.predict(x_test[i])["predictions"]
    flat_list.append(float("%.1f" % (np.array(result))))
    time.sleep(0.5)

print("Done!")
print("predictions: \t{}".format(np.array(flat_list)))

View captured data

Now list the data capture files stored in Amazon S3. You should expect to see different files from different time periods organized based on the hour in which the invocation occurred. The format of the Amazon S3 path is:

s3://{destination-bucket-prefix}/{endpoint-name}/{variant-name}/yyyy/mm/dd/hh/filename.jsonl

Note that the delivery of capture data to Amazon S3 can require a couple of minutes so next cell might error. If this happens, please retry after a minute.

[ ]:

s3_client = boto3.Session().client("s3")
result = s3_client.list_objects(Bucket=bucket, Prefix=data_capture_prefix)
capture_files = [capture_file.get("Key") for capture_file in result.get("Contents")]
print("Found Capture Files:")
print("\n ".join(capture_files))

Next, view the contents of a single capture file. Here you should see all the data captured in an Amazon SageMaker specific JSON-line formatted file. Take a quick peek at the first few lines in the captured file.

[ ]:

def get_obj_body(obj_key):
    return s3_client.get_object(Bucket=bucket, Key=obj_key).get("Body").read().decode("utf-8")


capture_file = get_obj_body(capture_files[-1])
print(capture_file[:2000])

Finally, the contents of a single line is present below in a formatted JSON file so that you can observe a little better.

[ ]:

import json

print(json.dumps(json.loads(capture_file.split("\n")[0]), indent=2))

As you can see, each inference request is captured in one line in the jsonl file. The line contains both the input and output merged together. In the example, you provided the ContentType as text/csv which is reflected in the observedContentType value. Also, you expose the encoding that you used to encode the input and output payloads in the capture format with the encoding value.

To recap, you observed how you can enable capturing the input or output payloads to an endpoint with a new parameter. You have also observed what the captured format looks like in Amazon S3. Next, continue to explore how Amazon SageMaker helps with monitoring the data collected in Amazon S3.

PART B: Model Monitor - Baselining and continuous monitoring

In addition to collecting the data, Amazon SageMaker provides the capability for you to monitor and evaluate the data observed by the endpoints. For this: 1. Create a baseline with which you compare the realtime traffic. 1. Once a baseline is ready, setup a schedule to continously evaluate and compare against the baseline.

1. Constraint suggestion with baseline/training dataset

The training dataset with which you trained the model is usually a good baseline dataset. Note that the training dataset data schema and the inference dataset schema should exactly match (i.e. the number and order of the features).

From the training dataset you can ask Amazon SageMaker to suggest a set of baseline constraints and generate descriptive statistics to explore the data. For this example, upload the training dataset that was used to train the pre-trained model included in this example. If you already have it in Amazon S3, you can directly point to it.

Prepare testing dataset with headers

[ ]:

import pandas as pd

df = pd.DataFrame(data=x_test, columns=X.columns)

df.head(500).to_csv("testing_dataset_with_headers.csv", index=False)

[ ]:

# copy over the training dataset to Amazon S3 (if you already have it in Amazon S3, you could reuse it)
baseline_prefix = prefix + "/baselining"
baseline_data_prefix = baseline_prefix + "/data"
baseline_results_prefix = baseline_prefix + "/results"

baseline_data_uri = "s3://{}/{}".format(bucket, baseline_data_prefix)
baseline_results_uri = "s3://{}/{}".format(bucket, baseline_results_prefix)
print("Baseline data uri: {}".format(baseline_data_uri))
print("Baseline results uri: {}".format(baseline_results_uri))

[ ]:

training_data_file = open("testing_dataset_with_headers.csv", "rb")
s3_key = os.path.join(baseline_prefix, "data", "testing_dataset_with_headers.csv")
boto3.Session().resource("s3").Bucket(bucket).Object(s3_key).upload_fileobj(training_data_file)

Create a baselining job with training dataset

Now that you have the training data ready in Amazon S3, start a job to suggest constraints. DefaultModelMonitor.suggest_baseline(..) starts a ProcessingJob using an Amazon SageMaker provided Model Monitor container to generate the constraints.

[ ]:

from sagemaker.model_monitor import DefaultModelMonitor
from sagemaker.model_monitor.dataset_format import DatasetFormat

my_default_monitor = DefaultModelMonitor(
    role=role,
    instance_count=1,
    instance_type="ml.m5.xlarge",
    volume_size_in_gb=20,
    max_runtime_in_seconds=3600,
)

my_default_monitor.suggest_baseline(
    baseline_dataset=baseline_data_uri + "/testing_dataset_with_headers.csv",
    dataset_format=DatasetFormat.csv(header=True),
    output_s3_uri=baseline_results_uri,
    wait=True,
)

Explore the generated constraints and statistics

[ ]:

s3_client = boto3.Session().client("s3")
result = s3_client.list_objects(Bucket=bucket, Prefix=baseline_results_prefix)
report_files = [report_file.get("Key") for report_file in result.get("Contents")]
print("Found Files:")
print("\n".join(report_files))

[ ]:

import pandas as pd

baseline_job = my_default_monitor.latest_baselining_job
schema_df = pd.io.json.json_normalize(baseline_job.baseline_statistics().body_dict["features"])
schema_df.head(10)

[ ]:

constraints_df = pd.io.json.json_normalize(
    baseline_job.suggested_constraints().body_dict["features"]
)
constraints_df.head(10)

2. Analyzing collected data for data quality issues

Create a schedule

You can create a model monitoring schedule for the endpoint created earlier. Use the baseline resources (constraints and statistics) to compare against the realtime traffic.

From the analysis above, you saw how the captured data is saved - that is the standard input and output format for Tensorflow models. But Model Monitor is framework-agnostic, and expects a specific format explained in the docs: - Input - Flattened JSON {"feature0": <value>, "feature1": <value>...} - Tabular "<value>, <value>..." - Output: - Flattened JSON {"prediction0": <value>, "prediction1": <value>...} - Tabular "<value>, <value>..."

We need to transform the input records to comply with this requirement. Model Monitor offers pre-processing scripts in Python to transform the input. The cell below has the script that will work for our case.

[ ]:

%%writefile preprocessing.py

import json


def preprocess_handler(inference_record):
    input_data = json.loads(inference_record.endpoint_input.data)
    input_data = {f"feature{str(i).zfill(10)}": val for i, val in enumerate(input_data)}

    output_data = json.loads(inference_record.endpoint_output.data)["predictions"][0][0]
    output_data = {"prediction0": output_data}

    return {**input_data}

We’ll upload this script to an s3 destination and pass it as the record_preprocessor_script parameter to the create_monitoring_schedule call.

[ ]:

preprocessor_s3_dest_path = f"s3://{bucket}/{prefix}/artifacts/modelmonitor"
preprocessor_s3_dest = sagemaker.s3.S3Uploader.upload("preprocessing.py", preprocessor_s3_dest_path)
print(preprocessor_s3_dest)

[ ]:

from sagemaker.model_monitor import CronExpressionGenerator
from time import gmtime, strftime

mon_schedule_name = "DEMO-tf2-model-monitor-schedule-" + strftime("%Y-%m-%d-%H-%M-%S", gmtime())
my_default_monitor.create_monitoring_schedule(
    monitor_schedule_name=mon_schedule_name,
    endpoint_input=predictor.endpoint,
    record_preprocessor_script=preprocessor_s3_dest,
    output_s3_uri=s3_report_path,
    statistics=my_default_monitor.baseline_statistics(),
    constraints=my_default_monitor.suggested_constraints(),
    schedule_cron_expression=CronExpressionGenerator.hourly(),
    enable_cloudwatch_metrics=True,
)

Generating violations artificially

In order to get some result relevant to monitoring analysis, you can try and generate artificially some inferences with feature values causing specific violations, and then invoke the endpoint with this data

Looking at our MedInc and HouseAge features:

MedInc - median income.
HouseAge - housing median age.

Let’s simulate a situation where both the median income and the housing median age are -10, and proportion of owner-occupied units built is 0.

[ ]:

df_with_violations = pd.read_csv("testing_dataset_with_headers.csv")
df_with_violations["MedInc"] = -10
df_with_violations["HouseAge"] = -10
df_with_violations

Start generating some artificial traffic

The cell below starts a thread to send some traffic to the endpoint. Note that you need to stop the kernel to terminate this thread. If there is no traffic, the monitoring jobs are marked as Failed since there is no data to process.

[ ]:

from threading import Thread
from time import sleep
import time


def invoke_endpoint():
    for item in df_with_violations.to_numpy():
        result = predictor.predict(item)["predictions"]
        time.sleep(0.5)


def invoke_endpoint_forever():
    while True:
        invoke_endpoint()


thread = Thread(target=invoke_endpoint_forever)
thread.start()

# Note that you need to stop the kernel to stop the invocations

Describe and inspect the schedule

Once you describe, observe that the MonitoringScheduleStatus changes to Scheduled.

[ ]:

desc_schedule_result = my_default_monitor.describe_schedule()
print("Schedule status: {}".format(desc_schedule_result["MonitoringScheduleStatus"]))

List executions

The schedule starts jobs at the previously specified intervals. Here, you list the latest five executions. Note that if you are kicking this off after creating the hourly schedule, you might find the executions empty. You might have to wait until you cross the hour boundary (in UTC) to see executions kick off. The code below has the logic for waiting.

Note: Even for an hourly schedule, Amazon SageMaker has a buffer period of 20 minutes to schedule your execution. You might see your execution start in anywhere from zero to ~20 minutes from the hour boundary. This is expected and done for load balancing in the backend.

[ ]:

mon_executions = my_default_monitor.list_executions()
print(
    "We created a hourly schedule above and it will kick off executions ON the hour (plus 0 - 20 min buffer.\nWe will have to wait till we hit the hour..."
)

while len(mon_executions) == 0:
    print("Waiting for the 1st execution to happen...")
    time.sleep(60)
    mon_executions = my_default_monitor.list_executions()

Inspect a specific execution (latest execution)

In the previous cell, you picked up the latest completed or failed scheduled execution. Here are the possible terminal states and what each of them mean: * Completed - This means the monitoring execution completed and no issues were found in the violations report. * CompletedWithViolations - This means the execution completed, but constraint violations were detected. * Failed - The monitoring execution failed, maybe due to client error (perhaps incorrect role premissions) or infrastructure issues. Further examination of FailureReason and ExitMessage is necessary to identify what exactly happened. * Stopped - job exceeded max runtime or was manually stopped.

[ ]:

latest_execution = mon_executions[
    -1
]  # latest execution's index is -1, second to last is -2 and so on..
latest_execution.wait(logs=False)

print("Latest execution status: {}".format(latest_execution.describe()["ProcessingJobStatus"]))
print("Latest execution result: {}".format(latest_execution.describe()["ExitMessage"]))

latest_job = latest_execution.describe()
if latest_job["ProcessingJobStatus"] != "Completed":
    print(
        "====STOP==== \n No completed executions to inspect further. Please wait till an execution completes or investigate previously reported failures."
    )

[ ]:

report_uri = latest_execution.output.destination
print("Report Uri: {}".format(report_uri))

List the generated reports

[ ]:

from urllib.parse import urlparse

s3uri = urlparse(report_uri)
report_bucket = s3uri.netloc
report_key = s3uri.path.lstrip("/")
print("Report bucket: {}".format(report_bucket))
print("Report key: {}".format(report_key))

s3_client = boto3.Session().client("s3")
result = s3_client.list_objects(Bucket=report_bucket, Prefix=report_key)
report_files = [report_file.get("Key") for report_file in result.get("Contents")]
print("Found Report Files:")
print("\n ".join(report_files))

Violations report

If there are any violations compared to the baseline, they will be listed here.

[ ]:

violations = my_default_monitor.latest_monitoring_constraint_violations()
pd.set_option("display.max_colwidth", -1)
constraints_df = pd.io.json.json_normalize(violations.body_dict["violations"])
constraints_df.head(10)

Triggering execution manually

In oder to trigger the execution manually, we first get all paths to data capture, baseline statistics, baseline constraints, etc. Then, we use a utility fuction, defined in monitoringjob_utils.py, to run the processing job.

[ ]:

result = s3_client.list_objects(Bucket=bucket, Prefix=data_capture_prefix)
capture_files = [
    "s3://{0}/{1}".format(bucket, capture_file.get("Key"))
    for capture_file in result.get("Contents")
]

print("Capture Files: ")
print("\n".join(capture_files))

data_capture_path = capture_files[len(capture_files) - 1][
    : capture_files[len(capture_files) - 1].rfind("/")
]
statistics_path = baseline_results_uri + "/statistics.json"
constraints_path = baseline_results_uri + "/constraints.json"

print(data_capture_path)
print(preprocessor_s3_dest)
print(statistics_path)
print(constraints_path)
print(s3_report_path)

[ ]:

from monitoringjob_utils import run_model_monitor_job_processor

processor = run_model_monitor_job_processor(
    region,
    "ml.m5.xlarge",
    role,
    data_capture_path,
    statistics_path,
    constraints_path,
    s3_report_path,
    preprocessor_path=preprocessor_s3_dest,
)

Inspect the execution

[ ]:

import boto3


def get_latest_model_monitor_processing_job_name(base_job_name):
    client = boto3.client("sagemaker")
    response = client.list_processing_jobs(
        NameContains=base_job_name,
        SortBy="CreationTime",
        SortOrder="Descending",
        StatusEquals="Completed",
    )
    if len(response["ProcessingJobSummaries"]) > 0:
        return response["ProcessingJobSummaries"][0]["ProcessingJobName"]
    else:
        raise Exception("Processing job not found.")


def get_model_monitor_processing_job_s3_report(job_name):
    client = boto3.client("sagemaker")
    response = client.describe_processing_job(ProcessingJobName=job_name)
    s3_report_path = response["ProcessingOutputConfig"]["Outputs"][0]["S3Output"]["S3Uri"]
    return s3_report_path


MODEL_MONITOR_JOB_NAME = "sagemaker-model-monitor-analyzer"
latest_model_monitor_processing_job_name = get_latest_model_monitor_processing_job_name(
    MODEL_MONITOR_JOB_NAME
)
print(latest_model_monitor_processing_job_name)
report_path = get_model_monitor_processing_job_s3_report(latest_model_monitor_processing_job_name)
print(report_path)

[ ]:

pd.set_option("display.max_colwidth", -1)
constraint_violations_df = pd.read_json("{}/constraint_violations.json".format(report_path))
constraint_violations_df.head(10)

Delete the resources

You can keep your endpoint running to continue capturing data. If you do not plan to collect more data or use this endpoint further, you should delete the endpoint to avoid incurring additional charges. Note that deleting your endpoint does not delete the data that was captured during the model invocations. That data persists in Amazon S3 until you delete it yourself.

But before that, you need to delete the schedule first.

[ ]:

my_default_monitor.delete_monitoring_schedule()
time.sleep(120)  # actually wait for the deletion

[ ]:

predictor.delete_endpoint()

Notebook CI Test Results

This notebook was tested in multiple regions. The test results are as follows, except for us-west-2 which is shown at the top of the notebook.