By deploying or using this software you agree to comply with the AI Hub Terms of Service and the Google APIs Terms of Service. To the extent of a direct conflict of terms, the AI Hub Terms of Service will control.
This notebook provides an example workflow of using the Distributed XGBoost ML container for training a regression ML model.
The notebook uses the Boston housing price regression dataset. It containers 506 observations with 13 features describing a house in Boston and a corresponding house price, stored in a 506x14 table.
The goal of this notebook is to go through a common training workflow:
This tutorial uses billable components of Google Cloud Platform (GCP):
Learn about Cloud AI Platform pricing and Cloud Storage pricing, and use the Pricing Calculator to generate a cost estimate based on your projected usage.
Otherwise, make sure your environment meets this notebook's requirements. You need the following:
The Google Cloud guide to Setting up a Python development environment and the Jupyter installation guide provide detailed instructions for meeting these requirements. The following steps provide a condensed set of instructions:
Install virtualenv and create a virtual environment that uses Python 3.
Activate that environment and run pip install jupyter in a shell to install
Jupyter.
Run jupyter notebook in a shell to launch Jupyter.
Open this notebook in the Jupyter Notebook Dashboard.
The following steps are required, regardless of your notebook environment.
Select or create a GCP project.. When you first create an account, you get a $300 free credit towards your compute/storage costs.
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"}
! gcloud config set project $PROJECT_ID
If you are using Colab, run the cell below and follow the instructions when prompted to authenticate your account via oAuth.
Otherwise, follow these steps:
In the GCP Console, go to the Create service account key page.
From the Service account drop-down list, select New service account.
In the Service account name field, enter a name.
From the Role drop-down list, select Machine Learning Engine > AI Platform Admin and Storage > Storage Object Admin.
Click Create. A JSON file that contains your key downloads to your local environment.
Enter the path to your service account key as the
GOOGLE_APPLICATION_CREDENTIALS variable in the cell below and run the cell.
In [ ]:
import sys
# If you are running this notebook in Colab, run this cell and follow the
# instructions to authenticate your GCP account. This provides access to your
# Cloud Storage bucket and lets you submit training jobs and prediction
# requests.
if 'google.colab' in sys.modules:
from google.colab import auth as google_auth
google_auth.authenticate_user()
# If you are running this notebook locally, replace the string below with the
# path to your service account key and run this cell to authenticate your GCP
# account.
else:
%env GOOGLE_APPLICATION_CREDENTIALS ''
The following steps are required, regardless of your notebook environment.
You need to have a "workspace" bucket that will hold the dataset and the output from the ML Container. Set the name of your Cloud Storage bucket below. It must be unique across all Cloud Storage buckets.
You may also change the REGION variable, which is used for operations
throughout the rest of this notebook. Make sure to choose a region where Cloud AI Platform services are available. You may not use a Multi-Regional Storage bucket for training with AI Platform.
In [ ]:
BUCKET_NAME = "[your-bucket-name]" #@param {type:"string"}
REGION = 'us-central1' #@param {type:"string"}
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
In [ ]:
! pip install witwidget
In [ ]:
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
import os
import time
import pandas as pd
import tensorflow as tf
from IPython.core.display import HTML
from googleapiclient import discovery
import numpy as np
from sklearn.metrics import r2_score
In [4]:
bh = tf.keras.datasets.boston_housing
(X_train, y_train), (X_eval, y_eval) = bh.load_data()
data_mean = X_train.mean(axis=0)
data_std = X_train.std(axis=0)
X_train = (X_train - data_mean) / data_std
X_eval = (X_eval - data_mean) / data_std
training = pd.DataFrame(X_train)
training.columns = ["f{}".format(c) for c in training.columns]
training['target'] = y_train
validation = pd.DataFrame(X_eval)
validation.columns = ["f{}".format(c) for c in validation.columns]
validation['target'] = y_eval
print('Training data head')
display(training.head())
training_data = os.path.join('gs://', BUCKET_NAME, 'data/train.csv')
validation_data = os.path.join('gs://', BUCKET_NAME, 'data/valid.csv')
print('Copy the data in bucket ...')
with tf.io.gfile.GFile(training_data, 'w') as f:
training.to_csv(f, index=False)
with tf.io.gfile.GFile(validation_data, 'w') as f:
validation.to_csv(f, index=False)
| GPU | Multi-GPU Node | TPU | Workers | Parameter Server |
|---|---|---|---|---|
| Yes | No | No | Yes | No |
To have distribution and/or accelerators to your AI Platform training call, use parameters similar to the examples as shown below.
--master-machine-type standard_gpu \
--worker-machine-type standard_gpu \
--worker-count 2 \
In [ ]:
output_location = os.path.join('gs://', BUCKET_NAME, 'output')
job_name = "xgboost_regression_{}".format(time.strftime("%Y%m%d%H%M%S"))
!gcloud ai-platform jobs submit training $job_name \
--master-image-uri gcr.io/aihub-c2t-containers/kfp-components/trainer/dist_xgboost:latest \
--region $REGION \
--scale-tier CUSTOM \
--master-machine-type standard \
-- \
--output-location {output_location} \
--training-data {training_data} \
--validation-data {validation_data} \
--target-column target \
--data-type csv \
--objective reg:tweedie
Note that the training can also be done locally with Docker
docker run \
-v /tmp:/tmp \
-it gcr.io/aihub-c2t-containers/kfp-components/trainer/dist_xgboost:latest \
--training-data /tmp/train.csv \
--validation-data /tmp/valid.csv \
--output-location /tmp/output \
--target-column target \
--data-type csv \
--objective reg:tweedie
In [6]:
if not tf.io.gfile.exists(os.path.join(output_location, 'report.html')):
raise RuntimeError('The file report.html was not found. Did the training job finish?')
with tf.io.gfile.GFile(os.path.join(output_location, 'report.html')) as f:
display(HTML(f.read()))
In [12]:
#@markdown ---
model = 'xgboost_boston_housing' #@param {type:"string"}
version = 'v1' #@param {type:"string"}
#@markdown ---
In [ ]:
# the exact location of the model is in model_uri.txt
with tf.io.gfile.GFile(os.path.join(output_location, 'model_uri.txt')) as f:
model_uri = f.read().replace('/model.bst', '')
# create a model
! gcloud ai-platform models create $model --regions $REGION
# create a version
! gcloud ai-platform versions create $version \
--model $model \
--runtime-version 1.15 \
--origin $model_uri \
--framework XGBOOST \
--project $PROJECT_ID
In [14]:
# format the data for serving
instances = validation.drop(columns='target').values.tolist()
validation_targets = validation['target']
display(instances[:2])
service = discovery.build('ml', 'v1')
name = 'projects/{project}/models/{model}/versions/{version}'.format(project=PROJECT_ID,
model=model,
version=version)
body = {'instances': instances}
response = service.projects().predict(name=name, body=body).execute()
if 'error' in response:
raise RuntimeError(response['error'])
predictions = [row for row in response['predictions']]
R2 = r2_score(validation_targets, predictions)
print('Coefficient of dermination for the predictions: {}'.format(R2))
In [15]:
import witwidget
from witwidget.notebook.visualization import WitWidget, WitConfigBuilder
config_builder = WitConfigBuilder(examples=validation.values.tolist(),
feature_names=validation.columns.tolist())
config_builder.set_ai_platform_model(project=PROJECT_ID,
model=model,
version=version)
config_builder.set_model_type('regression')
config_builder.set_target_feature('target')
WitWidget(config_builder)
To clean up all GCP resources used in this project, you can delete the GCP project you used for the tutorial.
In [ ]:
# Delete model version resource
! gcloud ai-platform versions delete $version --quiet --model $model
# Delete model resource
! gcloud ai-platform models delete $model --quiet
# If training job is still running, cancel it
! gcloud ai-platform jobs cancel $job_name --quiet
# Delete Cloud Storage objects that were created
! gsutil -m rm -r $BUCKET_NAME