建立 Vertex AI Vizier 研究

本頁說明如何使用 Python 向 Vertex AI Vizier 發出 API 要求。如要瞭解 Vertex AI Vizier 的運作方式，請參閱 Vertex AI Vizier 總覽。

如要查看最佳化多個目標的範例，瞭解更全面的工作流程，請在下列其中一個環境中執行「Optimizing multiple objectives」筆記本：

在 Colab 中開啟 | 在 Colab Enterprise 中開啟 | 在 Vertex AI Workbench 中開啟 | 在 GitHub 上查看

事前準備

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Enable the Vertex AI API.

Enable the API

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Enable the Vertex AI API.

Enable the API

1. If you're using a local shell, then create local authentication credentials for your user account:

   gcloud auth application-default login

   You don't need to do this if you're using Cloud Shell.

   If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.

2. 安裝 Python 適用的 Vertex AI SDK。

定義常數

如要定義常數，請執行下列指令，並將 REGION 和 PROJECT_ID 替換為您的區域和專案 ID。自行建立研究名稱或使用建議值。

import json
import datetime
from google.cloud import aiplatform

REGION = "REGION"
PROJECT_ID = "PROJECT_ID"

# The following placeholder variables are automatically filled in.
STUDY_DISPLAY_NAME = '{}_study_{}'.format(PROJECT_ID.replace('-', ''), datetime.datetime.now().strftime('%Y%m%d_%H%M%S')) #@param {type: 'string'}
ENDPOINT = REGION + '-aiplatform.googleapis.com'
PARENT = 'projects/{}/locations/{}'.format(PROJECT_ID, REGION)

建構 API 要求

下列指令列 API 要求是以 Python 編寫。

建立研究

研究是一系列實驗或試驗，可協助您最佳化超參數或參數。

在以下範例中，目標是盡可能提高 y = x^2，且 x 的範圍為 [-10。10]。這個範例只有一個參數，並使用計算函式，協助示範如何使用 Vertex AI Vizier。

param_x = {
    'parameter_id': 'x',
    'double_value_spec': {
        'min_value': -10.0,
        'max_value': 10.0
    }
}

metric_y = {
    'metric_id': 'y',
    'goal': 'MAXIMIZE'
}

study = {
    'display_name': STUDY_DISPLAY_NAME,
    'study_spec': {
      'algorithm': 'RANDOM_SEARCH',
      'parameters': [param_x],
      'metrics': [metric_y],
    }
}

如要使用研究設定建立研究，請透過 VizierServiceClient 傳送下列要求。使用傳回的 STUDY_NAME 查詢研究。

vizier_client = aiplatform.gapic.VizierServiceClient(client_options=dict(api_endpoint=ENDPOINT))
study = vizier_client.create_study(parent=PARENT, study=study)
STUDY_NAME = study.name

查看研究

建立研究後，您可以在Google Cloud 控制台的 Vertex AI 專區，透過「實驗」頁面找到研究。

前往「實驗」頁面

取得研究報告

如要取得研究，請傳送下列要求。

vizier_client.get_study({'name': STUDY_NAME})

列出研究

如要列出特定專案和區域中的研究，請傳送下列要求：

vizier_client.list_studies({'parent': PARENT})

取得建議的試驗

如要從 Vertex AI Vizier 取得試驗建議，請建立包含 SUGGEST_COUNT 和 CLIENT_ID 的要求。傳送要求，將這項資訊傳遞至 Vertex AI Vizier。

使用下列指令建立要求。將 SUGGEST_COUNT 變更為您希望每次要求取得的建議數量。

suggest_response = vizier_client.suggest_trials({
    'parent': STUDY_NAME,
    'suggestion_count': SUGGEST_COUNT,
    'client_id': CLIENT_ID
    })

suggest_trials 會啟動長時間執行的作業，以生成試用版。 回應會顯示 Vertex AI Vizier 正在處理試用建議。

如要等待傳回的結果，請使用 result() 函式。

suggest_response.result().trials

以下格式顯示試用期範例。這項試用功能建議為參數 x 使用值 0.1。

name: "TRIAL_ID"
state: ACTIVE
parameters {
  parameter_id: "x"
  value {
    number_value: 0.1
  }
}
start_time {
  seconds: 1618011215
}

使用先前回應中的 TRIAL_ID 取得試用資格：

vizier_client.get_trial({
        'name': TRIAL_ID
      })

評估結果

收到試用建議後，請評估每項試用結果，並將每項結果記錄為評估。

舉例來說，如果您要最佳化的函式是 y = x^2，則可使用試驗建議的 x 值評估函式。使用建議的 0.1 值，函式會評估為 y = 0.1 * 0.1，進而產生 0.01。

新增測量結果

評估試用建議並取得測量結果後，請將這項測量結果新增至試用。

請使用下列指令儲存評估結果並傳送要求。 在本例中，請將 RESULT 替換為測量值。假設您要最佳化的函式為 y = x^2，而 x 的建議值為 0.1，則結果為 0.01。

vizier_client.add_trial_measurement({
        'trial_name': TRIAL_ID,
        'measurement': {
            'metrics': [{'metric_id': 'y', 'value':RESULT }]
        }
    })

注意： 如果評估程序包含多個步驟，且可產生多個中繼指標，您可以透過不同的 stepCount 和 metrics 值多次呼叫這個方法。舉例來說，如果您正在訓練機器學習模型，可以針對每個訓練週期回報中繼評估結果。

完成試用

新增試驗的所有測量結果後，您必須傳送指令來完成試驗。

完成試用後，您可以傳送指令只完成試用，也可以傳送指令新增最終測量並完成試用。

未完成最終評估

如要完成試驗，但不新增最終測量結果，請傳送下列要求：

vizier_client.complete_trial({
      'name': TRIAL_ID
  })

最終測量結果

如要完成試驗並納入最終評估，請使用下列指令，並將 RESULT 替換為最終評估。

vizier_client.complete_trial({
      'name': TRIAL_ID
      'final_measurement': {
        'metrics': [{'metric_id': 'y', 'value': RESULT}]
      }
  })

列出試用期

如要列出特定研究中的試驗，請傳送下列要求：

vizier_client.list_trials({
    'parent': STUDY_NAME
})

完成所有待處理的試用後，您可以呼叫 suggestTrials 取得更多建議，並重複試用評估程序。

列出最佳試驗

以下範例顯示 list_optimal_trials，會傳回多目標研究的最佳帕累托試驗，或單一目標研究的最佳試驗：

vizier_client.list_optimal_trials({
    'parent': STUDY_NAME
})

後續步驟

• 請參閱研究的 REST 參考資料。