Merge branch 'main' into batch_custom_text

add back pip install of xai sdk (#935 )
Add automl regression and classification with model evaluation (#911 )
2026-09-26 22:51:56 +00:00 · 2022-09-09 08:44:25 -04:00 · 2022-09-09 01:02:56 +01:00 · 2022-09-08 14:42:04 -07:00 · 2022-09-08 14:00:13 -07:00 · 2022-09-08 20:21:03 +00:00
17 changed files with 5323 additions and 232 deletions
@@ -2,4 +2,5 @@ cpr_model_server.py
 entrypoint.py
 state_dict.pth
 config.json
-**/__pycache__
+**/__pycache__
+!testdata/**
@@ -2,7 +2,7 @@

 ## About CPR

-CPR ([custom prediction routines](https://github.com/googleapis/python-aiplatform/blob/custom-prediction-routine/google/cloud/aiplatform/prediction/README.md)) is a framework designed by Google Cloud developers to make it easier to combine machine learning models with custom preprocessing and postprocessing logic in a real-time serving application. 
+CPR ([custom prediction routines](https://github.com/googleapis/python-aiplatform/blob/main/google/cloud/aiplatform/prediction/README.md)) is a framework designed by Google Cloud developers to make it easier to combine machine learning models with custom preprocessing and postprocessing logic in a real-time serving application. 

 ## Using this example

@@ -34,6 +34,23 @@ Finally, install the Python modules required to build and run the model server:
 pip install -r requirements.txt
 ```

+### Auth
+
+This example uses Google Cloud Storage for hosting model artifacts and Artifact Registry to store the container image. 
+You'll need to authorize yourself before you can interact with these.
+
+First, log in to GCP with application default credentials:
+```sh
+gcloud auth application-default login
+```
+
+Next, if you haven't done so already, set up the [gcloud credential helper](https://cloud.google.com/artifact-registry/docs/docker/authentication)
+for the Artifact Registry region where you intend to host the image.  
+```
+gcloud auth configure-docker <region>-docker.pkg.dev
+```
+
+
 ### Predictor

 The `TimmPredictor` class in `timm_serving/predictor.py` implements most of the important logic for the server.
@@ -60,9 +60,9 @@ class CPRConfig(object):
    image: str = "timm_predictor:latest"
    artifact_local_dir: str = ""
    region: str = "us-central1"
-    project_id: str = "samthrasher-experimental"
+    project_id: str = "<your project ID here>"
    repository: str = "cpr-images"
-    artifact_gcs_dir: str = "gs://samthrasher-cpr-example/timm-vit224/"
+    artifact_gcs_dir: str = "gs://<your bucket ID here>/timm-vit224/"
    model_name: str = ""
    endpoint_name: str = ""
    machine_type: str = "n1-standard-2"
@@ -5,4 +5,4 @@ timm==0.5.4
 smart_open==6.0.0

 google-cloud-storage>=1.26.0,<2.0.0dev
-google-cloud-aiplatform[prediction] @ git+https://github.com/googleapis/python-aiplatform.git@custom-prediction-routine
+google-cloud-aiplatform[prediction]>=1.16.0
@@ -70,7 +70,10 @@ class PredictorUnitTests(absltest.TestCase):
    def setUp(self):
        super().setUp()
        self.config = CPRConfig()
-        self.config.load()
+        try:
+            self.config.load()
+        except FileNotFoundError:
+            logging.info("No saved config file found, using default values.")
        self.predictor = predictor.TimmPredictor()

    def test_load_from_saved_state_dict_ok(self):
@@ -170,7 +173,10 @@ class ServerEndToEndTests(absltest.TestCase):
    def setUp(self):
        super().setUp()
        self.config = CPRConfig()
-        self.config.load()
+        try:
+            self.config.load()
+        except FileNotFoundError:
+            logging.info("No saved config file found, using default values.")
        self.local_model = cpr.LocalModel(
            serving_container_spec=aiplatform.gapic.ModelContainerSpec(
                image_uri=self.config.image
@@ -0,0 +1 @@
+blah
@@ -1309,6 +1309,7 @@
      "source": [
        "### Send the prediction request\n",
        "\n",
+        "\n",
        "To make a batch prediction request, call the model object's `batch_predict` method with the following parameters: \n",
        "- `instances_format`: The format of the batch prediction request file: \"jsonl\", \"csv\", \"bigquery\", \"tf-record\", \"tf-record-gzip\" or \"file-list\"\n",
        "- `prediction_format`: The format of the batch prediction response file: \"jsonl\", \"csv\", \"bigquery\", \"tf-record\", \"tf-record-gzip\" or \"file-list\"\n",
@@ -16,6 +16,7 @@
 /model_monitoring @andrewferlitsch
 /tensorboard @zbl94

+/bigquery_ml/bqml-online-prediction.ipynb @polong-lin
 /model_monitoring/model_monitoring.ipynb @mco-gh
 /ml_metadata/sdk-metric-parameter-tracking-for-custom-jobs.ipynb @jialuzh
 /ml_metadata/sdk-metric-parameter-tracking-for-locally-trained-models.ipynb @jialuzh
@@ -32,18 +32,18 @@
        "<table align=\"left\">\n",
        "\n",
        "  <td>\n",
-        "    <a href=\"https://colab.research.google.com/github/GoogleCloudPlatform/vertex-ai-samples/blob/master/notebooks/community/bigquery_ml/bqml-online-prediction.ipynb\">\n",
+        "    <a href=\"https://colab.research.google.com/github/GoogleCloudPlatform/vertex-ai-samples/blob/master/notebooks/official/bigquery_ml/bqml-online-prediction.ipynb\">\n",
        "      <img src=\"https://cloud.google.com/ml-engine/images/colab-logo-32px.png\" alt=\"Colab logo\"> Run in Colab\n",
        "    </a>\n",
        "  </td>\n",
        "  <td>\n",
-        "    <a href=\"https://github/GoogleCloudPlatform/vertex-ai-samples/blob/master/notebooks/community/bigquery_ml/bqml-online-prediction.ipynb\">\n",
+        "    <a href=\"https://github/GoogleCloudPlatform/vertex-ai-samples/blob/master/notebooks/official/bigquery_ml/bqml-online-prediction.ipynb\">\n",
        "      <img src=\"https://cloud.google.com/ml-engine/images/github-logo-32px.png\" alt=\"GitHub logo\">\n",
        "      View on GitHub\n",
        "    </a>\n",
        "  </td>\n",
        "  <td>\n",
-        "    <a href=\"https://console.cloud.google.com/vertex-ai/workbench/deploy-notebook?download_url=https://raw.githubusercontent.com/GoogleCloudPlatform/vertex-ai-samples/blob/master/notebooks/community/bigquery_ml/bqml-online-prediction.ipynb\">\n",
+        "    <a href=\"https://console.cloud.google.com/vertex-ai/workbench/deploy-notebook?download_url=https://raw.githubusercontent.com/GoogleCloudPlatform/vertex-ai-samples/blob/master/notebooks/official/bigquery_ml/bqml-online-prediction.ipynb\">\n",
        "      <img src=\"https://lh3.googleusercontent.com/UiNooY4LUgW_oTvpsNhPpQzsstV5W8F7rYgxgGBD85cWJoLmrOzhVs_ksK_vgx40SHs7jCqkTkCk=e14-rj-sc0xffffff-h130-w32\" alt=\"Vertex AI logo\">\n",
        "      Open in Vertex AI Workbench\n",
        "    </a>\n",
@@ -63,7 +63,7 @@
        "\n",
        "### Dataset\n",
        "\n",
-        "The dataset, [available publicly on BigQuery](https://console.cloud.google.com/bigquery?project=bigquery-public-data&d=ga4_obfuscated_sample_ecommerce&p=bigquery-public-data&page=dataset), comes from obfuscated [Google Analytics 4 data](https://support.google.com/analytics/answer/10937659) from the [Google Merchandise Store](https://shop.googlemerchandisestore.com/).\n",
+        "The dataset, <a href=\"https://console.cloud.google.com/bigquery?project=bigquery-public-data&d=ga4_obfuscated_sample_ecommerce&p=bigquery-public-data&page=dataset\" target=\"_blank\">available publicly on BigQuery</a>, comes from obfuscated <a href=\"https://support.google.com/analytics/answer/10937659\" target=\"_blank\">Google Analytics 4 data</a> from the <a href=\"https://shop.googlemerchandisestore.com/\" target=\"_blank\">Google Merchandise Store</a>).\n",
        "\n",
        "### Objective\n",
        "\n",
@@ -95,9 +95,9 @@
        "* Vertex AI\n",
        "\n",
        "\n",
-        "Learn about [BigQuery Pricing](https://cloud.google.com/bigquery/pricing), [BigQuery ML pricing](https://cloud.google.com/bigquery-ml/pricing), [Vertex AI\n",
-        "pricing](https://cloud.google.com/vertex-ai/pricing), and use the [Pricing\n",
-        "Calculator](https://cloud.google.com/products/calculator/)\n",
+        "Learn about <a href=\"https://cloud.google.com/bigquery/pricing\" target=\"_blank\">BigQuery Pricing</a>, <a href=\"https://cloud.google.com/bigquery-ml/pricing\" target=\"_blank\">BigQuery ML pricing</a>, <a href=\"https://cloud.google.com/vertex-ai/pricing\" target=\"_blank\">Vertex AI\n",
+        "pricing</a>, and use the <a href=\"https://cloud.google.com/products/calculator/\" target=\"_blank\">Pricing\n",
+        "Calculator</a>\n",
        "to generate a cost estimate based on your projected usage."
      ]
    },
@@ -128,18 +128,18 @@
        "* virtualenv\n",
        "* Jupyter notebook running in a virtual environment with Python 3\n",
        "\n",
-        "The Google Cloud guide to [Setting up a Python development\n",
-        "environment](https://cloud.google.com/python/setup) and the [Jupyter\n",
-        "installation guide](https://jupyter.org/install) provide detailed instructions\n",
+        "The Google Cloud guide to <a href=\"https://cloud.google.com/python/setup\" target=\"_blank\">Setting up a Python development\n",
+        "environment</a> and the <a href=\"https://jupyter.org/install\" target=\"_blank\">Jupyter\n",
+        "installation guide</a> provide detailed instructions\n",
        "for meeting these requirements. The following steps provide a condensed set of\n",
        "instructions:\n",
        "\n",
-        "1. [Install and initialize the Cloud SDK.](https://cloud.google.com/sdk/docs/)\n",
+        "1. <a href=\"https://cloud.google.com/sdk/docs/\" target=\"_blank\">Install and initialize the Cloud SDK.</a>\n",
        "\n",
-        "1. [Install Python 3.](https://cloud.google.com/python/setup#installing_python)\n",
+        "1. <a href=\"https://cloud.google.com/python/setup#installing_python\" target=\"_blank\">Install Python 3.</a>\n",
        "\n",
-        "1. [Install\n",
-        "   virtualenv](https://cloud.google.com/python/setup#installing_and_using_virtualenv)\n",
+        "1. <a href=\"https://cloud.google.com/python/setup#installing_and_using_virtualenv\" target=\"_blank\">Install\n",
+        "   virtualenv</a>\n",
        "   and create a virtual environment that uses Python 3. Activate the virtual environment.\n",
        "\n",
        "1. To install Jupyter, run `pip3 install jupyter` on the\n",
@@ -234,13 +234,13 @@
        "\n",
        "**The following steps are required, regardless of your notebook environment.**\n",
        "\n",
-        "1. [Select or create a Google Cloud project](https://console.cloud.google.com/cloud-resource-manager). When you first create an account, you get a $300 free credit towards your compute/storage costs.\n",
+        "1. <a href=\"https://console.cloud.google.com/cloud-resource-manager\" target=\"_blank\">Select or create a Google Cloud project</a>. When you first create an account, you get a $300 free credit towards your compute/storage costs.\n",
        "\n",
-        "1. [Make sure that billing is enabled for your project](https://cloud.google.com/billing/docs/how-to/modify-project).\n",
+        "1. <a href=\"https://cloud.google.com/billing/docs/how-to/modify-project\" target=\"_blank\">Make sure that billing is enabled for your project</a>.\n",
        "\n",
-        "1. [Enable the Vertex AI API](https://console.cloud.google.com/flows/enableapi?apiid=aiplatform.googleapis.com).\n",
+        "1. <a href=\"https://console.cloud.google.com/flows/enableapi?apiid=aiplatform.googleapis.com\" target=\"_blank\">Enable the Vertex AI API</a>.\n",
        "\n",
-        "1. If you are running this notebook locally, you will need to install the [Cloud SDK](https://cloud.google.com/sdk).\n",
+        "1. If you are running this notebook locally, you will need to install the <a href=\"https://cloud.google.com/sdk\" target=\"_blank\">Cloud SDK</a>.\n",
        "\n",
        "1. Enter your project ID in the cell below. Then run the cell to make sure the\n",
        "Cloud SDK uses the right project for all the commands in this notebook.\n",
@@ -267,7 +267,7 @@
      },
      "outputs": [],
      "source": [
-        "PROJECT_ID = \"YOUR-PROJECT-ID\"\n",
+        "PROJECT_ID = \"[YOUR-PROJECT-ID]\"\n",
        "\n",
        "# Get your Google Cloud project ID from gcloud\n",
        "import os\n",
@@ -314,9 +314,9 @@
        "- Europe: `europe-west4`\n",
        "- Asia Pacific: `asia-east1`\n",
        "\n",
-        "You may not use a multi-regional bucket for training with Vertex AI. Not all regions provide support for all Vertex AI services.\n",
+        "You might not be able to use a multi-regional bucket for training with Vertex AI. Not all regions provide support for all Vertex AI services.\n",
        "\n",
-        "Learn more about [Vertex AI regions](https://cloud.google.com/vertex-ai/docs/general/locations)."
+        "Learn more about <a href=\"https://cloud.google.com/vertex-ai/docs/general/locations\" target=\"_blank\">Vertex AI regions</a>."
      ]
    },
    {
@@ -339,9 +339,9 @@
        "id": "06571eb4063b"
      },
      "source": [
-        "#### Timestamp\n",
+        "#### UUID\n",
        "\n",
-        "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 it onto the name of resources you create in this tutorial."
+        "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 uuid for each instance session, and append it onto the name of resources you create in this tutorial."
      ]
    },
    {
@@ -352,9 +352,16 @@
      },
      "outputs": [],
      "source": [
-        "from datetime import datetime\n",
+        "import random\n",
+        "import string\n",
        "\n",
-        "TIMESTAMP = datetime.now().strftime(\"%Y%m%d%H%M%S\")"
+        "\n",
+        "# Generate a uuid of a specifed length(default=8)\n",
+        "def generate_uuid(length: int = 8) -> str:\n",
+        "    return \"\".join(random.choices(string.ascii_lowercase + string.digits, k=length))\n",
+        "\n",
+        "\n",
+        "UUID = generate_uuid()"
      ]
    },
    {
@@ -380,8 +387,7 @@
        "\n",
        "**Otherwise**, follow these steps:\n",
        "\n",
-        "1. In the Cloud Console, go to the [**Create service account key**\n",
-        "   page](https://console.cloud.google.com/apis/credentials/serviceaccountkey).\n",
+        "1. In the Cloud Console, go to the <a href=\"https://console.cloud.google.com/apis/credentials/serviceaccountkey\" target=\"_blank\">**Create service account key** page</a>.\n",
        "\n",
        "2. Click **Create service account**.\n",
        "\n",
@@ -486,7 +492,10 @@
      },
      "outputs": [],
      "source": [
+        "from typing import Union\n",
+        "\n",
        "import google.cloud.aiplatform as vertex_ai\n",
+        "import pandas as pd\n",
        "from google.cloud import bigquery"
      ]
    },
@@ -550,24 +559,17 @@
      "outputs": [],
      "source": [
        "# Wrapper to use BigQuery client to run query/job, return job ID or result as DF\n",
-        "def bq_query(sql):\n",
+        "def run_bq_query(sql: str) -> Union[str, pd.DataFrame]:\n",
        "    \"\"\"\n",
        "    Input: SQL query, as a string, to execute in BigQuery\n",
        "    Returns the query results as a pandas DataFrame, or error, if any\n",
        "    \"\"\"\n",
-        "    # Import Exceptions library to help with dataset error catching\n",
-        "    from google.cloud.exceptions import BadRequest\n",
        "\n",
        "    # Try dry run before executing query to catch any errors\n",
-        "    try:\n",
-        "        job_config = bigquery.QueryJobConfig(dry_run=True, use_query_cache=False)\n",
-        "\n",
-        "        bq_client.query(sql, job_config=job_config)\n",
-        "\n",
-        "    except BadRequest as err:\n",
-        "        print(err)\n",
-        "        return\n",
+        "    job_config = bigquery.QueryJobConfig(dry_run=True, use_query_cache=False)\n",
+        "    bq_client.query(sql, job_config=job_config)\n",
        "\n",
+        "    # If dry run succeeds without errors, proceed to run query\n",
        "    job_config = bigquery.QueryJobConfig()\n",
        "    client_result = bq_client.query(sql, job_config=job_config)\n",
        "\n",
@@ -589,7 +591,7 @@
        "\n",
        "BigQuery ML (BQML) provides the capability to train ML tabular models, such as classification, regression, forecasting, and matrix factorization, in BigQuery using SQL syntax directly. BigQuery ML uses the scalable infrastructure of BigQuery ML so you don't need to set up additional infrastructure for training or batch serving.\n",
        "\n",
-        "Learn more about [BigQuery ML documentation](https://cloud.google.com/bigquery-ml/docs)."
+        "Learn more about <a href=\"https://cloud.google.com/bigquery-ml/docs\" target=\"_blank\">BigQuery ML documentation</a>."
      ]
    },
    {
@@ -600,9 +602,13 @@
      },
      "outputs": [],
      "source": [
-        "BQ_DATASET_NAME = \"ga4_churnprediction\"\n",
+        "BQ_DATASET_NAME = f\"ga4_churnprediction_{UUID}\"\n",
        "\n",
-        "bq_query(f\"\"\"CREATE SCHEMA IF NOT EXISTS {BQ_DATASET_NAME}\"\"\")"
+        "sql_create_dataset = f\"\"\"CREATE SCHEMA IF NOT EXISTS {BQ_DATASET_NAME}\"\"\"\n",
+        "\n",
+        "print(sql_create_dataset)\n",
+        "\n",
+        "run_bq_query(sql_create_dataset)"
      ]
    },
    {
@@ -620,7 +626,7 @@
        "id": "49dd00d5fbe5"
      },
      "source": [
-        "Inpect data that has been pre-processed from [Google Analytics 4 data from the Google Merchandise Store](https://support.google.com/analytics/answer/10937659) so that it can be used for classification. For more information on how this data was prepared, read [this blog post](https://cloud.google.com/blog/topics/developers-practitioners/churn-prediction-game-developers-using-google-analytics-4-ga4-and-bigquery-ml).\n",
+        "Inpect data that has been pre-processed from <a href=\"https://support.google.com/analytics/answer/10937659\" target=\"_blank\">Google Analytics 4 data from the Google Merchandise Store</a> so that it can be used for classification. For more information on how this data was prepared, read <a href=\"https://cloud.google.com/blog/topics/developers-practitioners/churn-prediction-game-developers-using-google-analytics-4-ga4-and-bigquery-ml\" target=\"_blank\">this blog post</a>.\n",
        "\n",
        "As seen below, each row represents a single user, and the columns represent their demographic features, their aggregated behavioral features in the first 24 hours of visiting the Google Merchandise Store, and the label (whether the user churned or returned any time after the first 24 hours)."
      ]
@@ -641,7 +647,7 @@
        "LIMIT\n",
        "    100\n",
        "\"\"\"\n",
-        "bq_query(sql_inspect)"
+        "run_bq_query(sql_inspect)"
      ]
    },
    {
@@ -662,9 +668,9 @@
        "The query below trains a logistic regression model using BigQuery ML. BigQuery resources are used to train the model.\n",
        "\n",
        "In the `OPTIONS` parameter:\n",
-        "* with `model_registry=\"vertex_ai\"`, the BigQuery ML model will automatically be [registered to Vertex AI Model Registry](https://cloud.google.com/vertex-ai/docs/model-registry/model-registry-bqml), which enables you to view all of your registered models and its versions on Google Cloud in one place.\n",
+        "* with `model_registry=\"vertex_ai\"`, the BigQuery ML model will automatically be <a href=\"https://cloud.google.com/vertex-ai/docs/model-registry/model-registry-bqml\" target=\"_blank\">registered to Vertex AI Model Registry</a>, which enables you to view all of your registered models and its versions on Google Cloud in one place.\n",
        "\n",
-        "* `vertex_ai_model_version_aliases allows you to set aliases to help you keep track of your model version ([documentation](https://cloud.google.com/vertex-ai/docs/model-registry/model-alias))."
+        "* `vertex_ai_model_version_aliases allows you to set aliases to help you keep track of your model version (<a href=\"https://cloud.google.com/vertex-ai/docs/model-registry/model-alias\" target=\"_blank\">documentation</a>)."
      ]
    },
    {
@@ -677,7 +683,7 @@
      "source": [
        "# this cell may take ~1 min to run\n",
        "\n",
-        "BQML_MODEL_NAME = \"bqmlmodelchurn\"\n",
+        "BQML_MODEL_NAME = f\"bqml_model_churn_{UUID}\"\n",
        "\n",
        "sql_train_model_bqml = f\"\"\"\n",
        "CREATE OR REPLACE MODEL {BQ_DATASET_NAME}.{BQML_MODEL_NAME}    \n",
@@ -696,7 +702,7 @@
        "\n",
        "print(sql_train_model_bqml)\n",
        "\n",
-        "bq_query(sql_train_model_bqml)"
+        "run_bq_query(sql_train_model_bqml)"
      ]
    },
    {
@@ -714,7 +720,7 @@
        "id": "2aaaae772f67"
      },
      "source": [
-        "With the model created, you can now evaluate the logistic regression model. Behind the scenes, BigQuery ML automatically [split the data](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#data_split_method), which makes it easier to quickly train and evaluate models."
+        "With the model created, you can now evaluate the logistic regression model. Behind the scenes, BigQuery ML automatically <a href=\"https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#data_split_method\" target=\"_blank\">split the data</a>, which makes it easier to quickly train and evaluate models."
      ]
    },
    {
@@ -734,7 +740,7 @@
        "\n",
        "print(sql_evaluate_model)\n",
        "\n",
-        "bq_query(sql_evaluate_model)"
+        "run_bq_query(sql_evaluate_model)"
      ]
    },
    {
@@ -745,7 +751,7 @@
      "source": [
        "These metrics help you understand the performance of the model. \n",
        "\n",
-        "There are various metrics for logistic regression and other model types (full list of metrics can be found in the [documentation](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-evaluate#mlevaluate_output))."
+        "There are various metrics for logistic regression and other model types (full list of metrics can be found in the <a href=\"https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-evaluate#mlevaluate_output\" target=\"_blank\">documentation</a>)."
      ]
    },
    {
@@ -765,7 +771,7 @@
      "source": [
        "Make a batch prediction in BigQuery ML on the original training data to check the probability of churn for each of the users, as seen in the `probability` column, with the predicted label under the `predicted_churn` column.\n",
        "\n",
-        "[ML.EXPLAIN_PREDICT](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-explain-predict) has built-in [Explainable AI](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-xai-overview). This allows you to see the top contributing features to each prediction and interpret how it was computed."
+        "<a href=\"https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-explain-predict\" target=\"_blank\">ML.EXPLAIN_PREDICT</a> has built-in <a href=\"https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-xai-overview\" target=\"_blank\">Explainable AI</a>. This allows you to see the top contributing features to each prediction and interpret how it was computed."
      ]
    },
    {
@@ -787,7 +793,7 @@
        "\n",
        "print(sql_explain_predict)\n",
        "\n",
-        "bq_query(sql_explain_predict)"
+        "run_bq_query(sql_explain_predict)"
      ]
    },
    {
@@ -796,7 +802,7 @@
        "id": "fa1f96c0f452"
      },
      "source": [
-        "Since the `top_feature_attributions` is a nested column, you can unnest the array ([documentation](https://cloud.google.com/bigquery/docs/reference/standard-sql/arrays)) into separate rows for each of the features. In other words, since ML.EXPLAIN_PREDICT provides the top 5 most important features, using `UNNEST` results in 5 rows per prediction:"
+        "Since the `top_feature_attributions` is a nested column, you can unnest the array (<a href=\"https://cloud.google.com/bigquery/docs/reference/standard-sql/arrays\" target=\"_blank\">documentation</a>) into separate rows for each of the features. In other words, since ML.EXPLAIN_PREDICT provides the top 5 most important features, using `UNNEST` results in 5 rows per prediction:"
      ]
    },
    {
@@ -827,7 +833,7 @@
        "\n",
        "print(sql_explain_predict)\n",
        "\n",
-        "bq_query(sql_explain_predict)"
+        "run_bq_query(sql_explain_predict)"
      ]
    },
    {
@@ -847,7 +853,7 @@
      "source": [
        "When the model was trained in BigQuery ML, the line `model_registry=\"vertex_ai\"` registered the model to Vertex AI Model Registry automatically upon completion.\n",
        "\n",
-        "You can view the model on the [Vertex AI Model Registry page](https://console.cloud.google.com/vertex-ai/models), or use the code below to check that it was successfully registered:"
+        "You can view the model on the <a href=\"https://console.cloud.google.com/vertex-ai/models\" target=\"_blank\">Vertex AI Model Registry page</a>, or use the code below to check that it was successfully registered:"
      ]
    },
    {
@@ -858,12 +864,7 @@
      },
      "outputs": [],
      "source": [
-        "print(f\"BQML_MODEL_NAME = {BQML_MODEL_NAME}\")\n",
-        "\n",
-        "models = vertex_ai.Model.list(\n",
-        "    filter=f\"display_name={BQML_MODEL_NAME}\", order_by=\"update_time\"\n",
-        ")\n",
-        "model = models[0]\n",
+        "model = vertex_ai.Model(model_name=BQML_MODEL_NAME)\n",
        "\n",
        "print(model.gca_resource)"
      ]
@@ -883,7 +884,7 @@
        "id": "b6120dcc1ff6"
      },
      "source": [
-        "While BigQuery ML supports batch prediction with [ML.PREDICT](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-predict) and [ML.EXPLAIN_PREDICT](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-explain-predict), BigQuery ML is not suitable for real-time predictions where you need low latency predictions with potentially high frequency of requests.\n",
+        "While BigQuery ML supports batch prediction with <a href=\"https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-predict\" target=\"_blank\">ML.PREDICT</a> and <a href=\"https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-explain-predict\" target=\"_blank\">ML.EXPLAIN_PREDICT</a>, BigQuery ML is not suitable for real-time predictions where you need low latency predictions with potentially high frequency of requests.\n",
        "\n",
        "In other words, deploying the BigQuery ML model to an endpoint enables you to do online predictions."
      ]
@@ -906,30 +907,6 @@
        "To deploy your model to an endpoint, you will first need to create an endpoint before you deploy the model to it."
      ]
    },
-    {
-      "cell_type": "code",
-      "execution_count": null,
-      "metadata": {
-        "id": "3ce73125dff6"
-      },
-      "outputs": [],
-      "source": [
-        "def create_endpoint(\n",
-        "    project: str,\n",
-        "    display_name: str,\n",
-        "    location: str,\n",
-        "):\n",
-        "    endpoint = vertex_ai.Endpoint.create(\n",
-        "        display_name=display_name,\n",
-        "        project=project,\n",
-        "        location=location,\n",
-        "    )\n",
-        "\n",
-        "    print(endpoint.display_name)\n",
-        "    print(endpoint.resource_name)\n",
-        "    return endpoint"
-      ]
-    },
    {
      "cell_type": "code",
      "execution_count": null,
@@ -938,17 +915,16 @@
      },
      "outputs": [],
      "source": [
-        "endpoint_name = f\"{BQML_MODEL_NAME}-{TIMESTAMP}\"\n",
+        "ENDPOINT_NAME = f\"{BQML_MODEL_NAME}-endpoint\"\n",
        "\n",
-        "print(\n",
-        "    f\"\"\"\n",
-        "PROJECT_ID: {PROJECT_ID},\n",
-        "endpoint_name: {endpoint_name}\n",
-        "REGION: {REGION}\n",
-        "\"\"\"\n",
+        "endpoint = vertex_ai.Endpoint.create(\n",
+        "    display_name=ENDPOINT_NAME,\n",
+        "    project=PROJECT_ID,\n",
+        "    location=REGION,\n",
        ")\n",
        "\n",
-        "create_endpoint(PROJECT_ID, endpoint_name, REGION)"
+        "print(endpoint.display_name)\n",
+        "print(endpoint.resource_name)"
      ]
    },
    {
@@ -966,31 +942,7 @@
        "id": "951ed1693f6b"
      },
      "source": [
-        "List the endpoints to make sure it has successfully been created. You can also view your endpoints on the [Vertex AI Endpoints page](https://console.cloud.google.com/vertex-ai/endpoints?project=polong-contentdev)."
-      ]
-    },
-    {
-      "cell_type": "code",
-      "execution_count": null,
-      "metadata": {
-        "id": "0a9bad8d9ad4"
-      },
-      "outputs": [],
-      "source": [
-        "endpoint = vertex_ai.Endpoint.list(\n",
-        "    # filter=f'display_name={endpoint_name}', # optional: filter by specific endpoint name\n",
-        "    order_by=\"update_time\"\n",
-        ")\n",
-        "endpoint[-1]"
-      ]
-    },
-    {
-      "cell_type": "markdown",
-      "metadata": {
-        "id": "2431a4d28d97"
-      },
-      "source": [
-        "Retrieve the endpoint id so you can use it in the next step."
+        "List the endpoints to make sure it has successfully been created. (You can also view your endpoints on the <a href=\"https://console.cloud.google.com/vertex-ai/endpoints\" target=\"_blank\">Vertex AI Endpoints page</a>)."
      ]
    },
    {
@@ -1001,7 +953,7 @@
      },
      "outputs": [],
      "source": [
-        "endpoint[-1].to_dict()"
+        "endpoint.list()"
      ]
    },
    {
@@ -1019,74 +971,19 @@
        "id": "6a90be5b77a2"
      },
      "source": [
-        "With the model, you can now deploy it to an endpoint. "
+        "With the new endpoint, you can now deploy your model."
      ]
    },
    {
      "cell_type": "code",
      "execution_count": null,
      "metadata": {
-        "id": "af323ea42c5b"
-      },
-      "outputs": [],
-      "source": [
-        "from typing import Dict, Optional, Sequence, Tuple\n",
-        "\n",
-        "\n",
-        "def deploy_model_with_automatic_resources_sample(\n",
-        "    project,\n",
-        "    location,\n",
-        "    model_name: str,\n",
-        "    endpoint: Optional[vertex_ai.Endpoint] = None,\n",
-        "    deployed_model_display_name: Optional[str] = None,\n",
-        "    traffic_percentage: Optional[int] = 0,\n",
-        "    traffic_split: Optional[Dict[str, int]] = None,\n",
-        "    min_replica_count: int = 1,\n",
-        "    max_replica_count: int = 1,\n",
-        "    metadata: Optional[Sequence[Tuple[str, str]]] = (),\n",
-        "    sync: bool = True,\n",
-        "):\n",
-        "    \"\"\"\n",
-        "    model_name: A fully-qualified model resource name or model ID.\n",
-        "          Example: \"projects/123/locations/us-central1/models/456\" or\n",
-        "          \"456\" when project and location are initialized or passed.\n",
-        "    \"\"\"\n",
-        "\n",
-        "    model = vertex_ai.Model(model_name=model_name)\n",
-        "\n",
-        "    model.deploy(\n",
-        "        endpoint=endpoint,\n",
-        "        deployed_model_display_name=deployed_model_display_name,\n",
-        "        traffic_percentage=traffic_percentage,\n",
-        "        traffic_split=traffic_split,\n",
-        "        min_replica_count=min_replica_count,\n",
-        "        max_replica_count=max_replica_count,\n",
-        "        metadata=metadata,\n",
-        "        sync=sync,\n",
-        "    )\n",
-        "\n",
-        "    model.wait()\n",
-        "\n",
-        "    print(model.display_name)\n",
-        "    print(model.resource_name)\n",
-        "    return"
-      ]
-    },
-    {
-      "cell_type": "code",
-      "execution_count": null,
-      "metadata": {
-        "id": "9e6763369af4"
+        "id": "c70ecc568ee5"
      },
      "outputs": [],
      "source": [
        "# deploying the model to the endpoint may take 10-15 minutes\n",
-        "deploy_model_with_automatic_resources_sample(\n",
-        "    project=PROJECT_ID,\n",
-        "    location=REGION,\n",
-        "    model_name=BQML_MODEL_NAME,\n",
-        "    endpoint=endpoint[-1],\n",
-        ")"
+        "model.deploy(endpoint=endpoint)"
      ]
    },
    {
@@ -1095,7 +992,7 @@
        "id": "c303d779477b"
      },
      "source": [
-        "You can also check on the status of your model by visiting the [Vertex AI Endpoints page](https://console.cloud.google.com/vertex-ai/endpoints)."
+        "You can also check on the status of your model by visiting the <a href=\"https://console.cloud.google.com/vertex-ai/endpoints\" target=\"_blank\">Vertex AI Endpoints page</a>."
      ]
    },
    {
@@ -1168,35 +1065,12 @@
      "cell_type": "code",
      "execution_count": null,
      "metadata": {
-        "id": "2c6093ce9f8a"
+        "id": "b4839f31d2f8"
      },
      "outputs": [],
      "source": [
-        "def endpoint_predict_sample(\n",
-        "    project: str, location: str, instances: list, endpoint: str\n",
-        "):\n",
-        "    endpoint = vertex_ai.Endpoint(endpoint)\n",
-        "\n",
-        "    prediction = endpoint.predict(instances=instances)\n",
-        "    return prediction"
-      ]
-    },
-    {
-      "cell_type": "code",
-      "execution_count": null,
-      "metadata": {
-        "id": "0c41fd6eeb6f"
-      },
-      "outputs": [],
-      "source": [
-        "prediction_response = endpoint_predict_sample(\n",
-        "    project=PROJECT_ID,\n",
-        "    location=REGION,\n",
-        "    instances=df_sample_requests_list,\n",
-        "    endpoint=endpoint[-1].name,\n",
-        ")\n",
-        "\n",
-        "prediction_response"
+        "prediction = endpoint.predict(df_sample_requests_list)\n",
+        "print(prediction)"
      ]
    },
    {
@@ -1216,7 +1090,7 @@
      },
      "outputs": [],
      "source": [
-        "prediction_response.predictions"
+        "prediction.predictions"
      ]
    },
    {
@@ -1227,8 +1101,8 @@
      "source": [
        "## Cleaning up\n",
        "\n",
-        "To clean up all Google Cloud resources used in this project, you can [delete the Google Cloud\n",
-        "project](https://cloud.google.com/resource-manager/docs/creating-managing-projects#shutting_down_projects) you used for the tutorial.\n",
+        "To clean up all Google Cloud resources used in this project, you can <a href=\"https://cloud.google.com/resource-manager/docs/creating-managing-projects#shutting_down_projects\" target=\"_blank\">delete the Google Cloud\n",
+        "project</a> you used for the tutorial.\n",
        "\n",
        "Otherwise, you can delete the individual resources you created in this tutorial:"
      ]
@@ -1241,18 +1115,12 @@
      },
      "outputs": [],
      "source": [
-        "# MODEL_ID = model.name\n",
+        "# Undeploy model from endpoint and delete endpoint\n",
+        "endpoint.undeploy_all()\n",
+        "endpoint.delete()\n",
        "\n",
-        "ENDPOINT_ID = int(endpoint[-1].name)\n",
-        "\n",
-        "# Undeploy model from endpoint\n",
-        "endpoint[-1].undeploy_all()\n",
-        "\n",
-        "# Delete endpoint resource\n",
-        "! gcloud ai endpoints delete $ENDPOINT_ID --quiet --region $REGION\n",
-        "\n",
-        "# Delete BigQuery ML model\n",
-        "! bq rm -f --model $PROJECT_ID\\:$BQ_DATASET_NAME\\.$BQML_MODEL_NAME"
+        "# Delete BigQuery dataset, including the BigQuery ML model\n",
+        "! bq rm -r -f $PROJECT_ID:$BQ_DATASET_NAME"
      ]
    }
  ],
@@ -223,12 +223,22 @@
        "if IS_WORKBENCH_NOTEBOOK:\n",
        "    USER_FLAG = \"--user\"\n",
        "\n",
+        "# Don't bother installing tensorflow or explainable_ai_sdk on Colab\n",
+        "extra_pkgs = \"tensorflow explainable_ai_sdk\"\n",
+        "if \"google.colab\" in sys.modules:\n",
+        "  extra_pkgs = \"\"\n",
+        "\n",
        "# Install required packages.\n",
-        "! pip3 install {USER_FLAG} --quiet --upgrade google-cloud-aiplatform\n",
-        "! pip3 install {USER_FLAG} --quiet --upgrade tensorflow\n",
-        "! pip3 install {USER_FLAG} --quiet --upgrade explainable_ai_sdk\n",
-        "! pip3 install {USER_FLAG} --quiet --upgrade google-api-python-client google-auth-oauthlib google-auth-httplib2 oauth2client requests\n",
-        "! pip3 install {USER_FLAG} --quiet --upgrade google-cloud-storage==1.32.0"
+        "! pip3 install {USER_FLAG} \\\n",
+        "    google-cloud-aiplatform \\\n",
+        "    explainable_ai_sdk \\\n",
+        "    $extra_pkgs \\\n",
+        "    google-api-python-client \\\n",
+        "    google-auth-oauthlib \\\n",
+        "    google-auth-httplib2 \\\n",
+        "    oauth2client \\\n",
+        "    requests \\\n",
+        "    google-cloud-storage==1.32.0"
      ]
    },
    {
@@ -562,7 +572,7 @@
      "cell_type": "code",
      "execution_count": null,
      "metadata": {
-        "id": "init_aip:mbsdk,region"
+        "id": "wGa5T9eRR8Mz"
      },
      "outputs": [],
      "source": [
Author	SHA1	Message	Date
gericdongandGitHub	b7afec4eb8	Merge branch 'main' into batch_custom_text	2022-09-09 08:44:25 -04:00
MarcandGitHub	ce9e6ecf62	add back pip install of xai sdk (#935 )	2022-09-09 01:02:56 +01:00
Soheila Zangeneh GitHub krishr2d2 sudarshan-SpringML Andrew Ferlitsch	9ab5f4274a	Add automl regression and classification with model evaluation (#911 ) * Add automl regression model eval first draft * Remove extra file * Pring evaluation results * adds the automl-tabular-classification notebook in model_evaluation folder * removes unnecessary imports * adjusts the imports inside the pipeline * adjusts the imports * elaborates imports inside pipeline * modified regression notebook * renamed pipeline displayname to resolve error * Add automl regression model eval first draft * Remove extra file * Pring evaluation results * modified some text * added suggested updates from review: remove dataflow params, add/change textual descriptions, add UUID * removes the output from the notebooks * removes the extra matplotlib import * ran linter test * addressed soheila's comments * ran linter * addresses the review comments * ran linter test * removes the artifacts comment * ran linter test * reviewed comments * ran linter * addresses review comments: textual updates, removes unnecessary parameters * ran linter test * addressed comments * ran linter * removed unwanted variables * ran linter * addresses the tech-writer's comments + updates the pipeline image with data-sampler task * ran linter test Co-authored-by: krishr2d2 <krishna.movva@springml.com> Co-authored-by: sudarshan-SpringML <sudarshan.c@springml.com> Co-authored-by: Andrew Ferlitsch <aferlitsch@google.com>	2022-09-08 14:42:04 -07:00
Andrew FerlitschandGitHub	371628b8ff	Merge branch 'main' into batch_custom_text	2022-09-08 14:00:13 -07:00
Andrew Ferlitsch	52958a8da6	feat: notebook for custom text model batch prediction	2022-09-08 20:21:03 +00:00
Andrew Ferlitsch	c4dcac147e	feat: notebook for custom text model batch prediction	2022-09-08 20:18:33 +00:00
Andrew FerlitschandGitHub	29e584a422	feat: add batch automl video notebook (#933 ) * feat: batch for automl video * feat: batch for automl video * feat: batch for automl video	2022-09-08 11:34:29 -07:00
MarcandGitHub	beabb87cff	fix import problem described in b/245553683 (#932 ) * fix aiplatform import problem * lint fix * build fix, missing tensforflow * lint fixes	2022-09-08 16:47:20 +01:00
Polong Lin GitHub Ivan Cheung	e3f6717ff6	community -> official for bqml-online-prediction.ipynb (#788 ) * move bqml-vertex notebook from community to official * add to CODEOWNERS official * fix errors for execution-test * fix project_id line * fix linting * fixes re: comments from sarahcdugan * fix links at top of notebook from community/ to official/ * added UUID to model name * fix linting * fix error in TIMESTAMP --> UUID * fixing linting double space * fixes re: ivanmkc comments * fixed notebook after linting issues * linting via cloud shell * simplified run_bq_query function * linting Co-authored-by: Ivan Cheung <ivans.mailbox@gmail.com>	2022-09-07 18:20:02 -04:00
samthrasher GitHub Andrew Ferlitsch	fd30c4014a	Minor fixes for CPR Pytorch sample (#744 ) * Minor fixes for CPR Pytorch sample: Add missing test data, add auth info to readme, scrub private project and bucket names from config, tolerate missing config.json in unit tests. * Minor fixes for CPR Pytorch sample: Add missing test data, add auth info to readme, scrub private project and bucket names from config, tolerate missing config.json in unit tests. * Fix merge conflicts * fix typo * Point CPR links to main branch of SDK repo. Co-authored-by: Andrew Ferlitsch <aferlitsch@google.com>	2022-09-07 13:02:55 -07:00