既存のパイプライン ジョブをバッチ エンドポイントにデプロイする

適用対象:Azure CLI ml extension v2 (現行)Python SDK azure-ai-ml v2 (現行)

Azure Machine Learning でパイプラインを操作するための便利な方法が提供されるため、バッチ エンドポイントを使用するとパイプライン コンポーネントをデプロイできます。 バッチ エンドポイントは、デプロイ用のパイプライン コンポーネントを受け入れます。 ただし、正常に実行されるパイプライン ジョブが既にある場合、Azure Machine Learning はそのジョブをバッチ エンドポイントへの入力として受け入れ、パイプライン コンポーネントを自動的に作成できます。 この記事では、既存のパイプライン ジョブをバッチ デプロイの入力として使用する方法について説明します。

次のことを学習します。

• デプロイするパイプライン ジョブを実行して作成する
• 既存のジョブからバッチ デプロイを作成する
• 展開をテスト

この例の概要

この例では、"hello world!" を出力する単純なコマンド ジョブで構成されるパイプラインをデプロイします。 デプロイの前にパイプライン コンポーネントを登録する代わりに、デプロイに使用する既存のパイプライン ジョブを指定します。 その後、Azure Machine Learning によってパイプライン コンポーネントが自動的に作成され、バッチ エンドポイントのパイプライン コンポーネント デプロイとしてデプロイされます。

この記事の例は、azureml-examples リポジトリに含まれているコード サンプルを基にしています。 YAML などのファイルをコピーして貼り付けることなくコマンドをローカルで実行するには、最初にリポジトリを複製してから、ディレクトリをそのフォルダーに変更します。

Azure CLI

git clone https://github.com/Azure/azureml-examples --depth 1
cd azureml-examples/cli

Python

git clone https://github.com/Azure/azureml-examples --depth 1
cd azureml-examples/sdk/python

この例のファイルは、次の場所にあります。

cd endpoints/batch/deploy-pipelines/hello-batch

前提条件

この記事の手順に従う前に、次の前提条件が満たされていることをご確認ください。

• Azure サブスクリプション。 Azure サブスクリプションをお持ちでない場合は、開始する前に無料アカウントを作成してください。 無料版または有料版の Azure Machine Learning をお試しください。

• Azure Machine Learning ワークスペース。 準備できていない場合は、Microsoft Azure Machine Learning ワークスペースの管理に関する記事の手順を使用して作成します。

• ワークスペースに次のアクセス許可があることを確認します。

  • バッチ エンドポイントとバッチ デプロイを作成または管理する: 所有者または共同作成者のロール、あるいは Microsoft.MachineLearningServices/workspaces/batchEndpoints/* を許可するカスタム ロールを使用します。

  • ワークスペース リソース グループに ARM デプロイを作成する: 所有者または共同作成者のロール、あるいはワークスペースがデプロイされているリソース グループで Microsoft.Resources/deployments/write を許可するカスタム ロールを使用します。

• Azure Machine Learning を使用するには、次のソフトウェアをインストールする必要があります。

  Azure CLI

  Azure CLI と mlAzure Machine Learning 用の 拡張機能。

  az extension add -n ml
  

  注意

  Batch エンドポイントのパイプライン コンポーネント デプロイは、Azure CLI 用 ml 拡張機能のバージョン 2.7 で導入されました。 az extension update --name ml を使用して、最新バージョンを取得します。

  Python

  Azure Machine Learning SDK for Python。

  pip install azure-ai-ml
  

  注意

  クラス ModelBatchDeployment と PipelineComponentBatchDeployment は、SDK のバージョン 1.7.0 で導入されました。 pip install -U azure-ai-ml を使用して、最新バージョンを取得します。

ワークスペースに接続する

ワークスペースは、Azure Machine Learning の最上位のリソースで、Azure Machine Learning を使用するときに作成するすべての成果物を操作するための一元的な場所を提供します。 このセクションでは、デプロイ タスクを実行するワークスペースに接続します。

Azure CLI

次のコードで、サブスクリプション ID、ワークスペース、場所、リソース グループの値を渡します。

az account set --subscription <subscription>
az configure --defaults workspace=<workspace> group=<resource-group> location=<location>

Python

1. 必要なライブラリをインポートします。

   from azure.ai.ml import MLClient, Input, load_component
   from azure.ai.ml.entities import BatchEndpoint, ModelBatchDeployment, ModelBatchDeploymentSettings, PipelineComponentBatchDeployment, Model, AmlCompute, Data, BatchRetrySettings, CodeConfiguration, Environment, Data
   from azure.ai.ml.constants import AssetTypes, BatchDeploymentOutputAction
   from azure.ai.ml.dsl import pipeline
   from azure.identity import DefaultAzureCredential
   

2. ワークスペースの詳細を構成し、ワークスペースへのハンドルを取得します。

   次のコードで、サブスクリプション ID、ワークスペース、リソース グループの値を渡します。

   subscription_id = "<subscription>"
   resource_group = "<resource-group>"
   workspace = "<workspace>"
   
   ml_client = MLClient(DefaultAzureCredential(), subscription_id, resource_group, workspace)
   

デプロイするパイプライン ジョブを実行する

このセクションでは、まずパイプライン ジョブを実行します。

Azure CLI

次の pipeline-job.yml ファイルには、パイプライン ジョブの構成が含まれます。

pipeline-job.yml

$schema: https://azuremlschemas.azureedge.net/latest/pipelineJob.schema.json
type: pipeline

experiment_name: hello-pipeline-batch
display_name: hello-pipeline-batch-job
description: This job demonstrates how to run the a pipeline component in a pipeline job. You can use this example to test a component in an standalone job before deploying it in an endpoint.

compute: batch-cluster
component: hello-component/hello.yml

Python

パイプライン コンポーネントを読み込み、そのインスタンスを作成します。

hello_batch = load_component(source="hello-component/hello.yml")
pipeline_job = hello_batch()

次に、テストを実行するためにいくつかの実行設定を構成します。 この記事では、batch-cluster という名前のコンピューティング クラスターがあることを前提としています。 クラスターは、独自の名前に置き換えることができます。

pipeline_job.settings.default_compute = "batch-cluster"
pipeline_job.settings.default_datastore = "workspaceblobstore"

パイプライン ジョブを作成します。

Azure CLI

JOB_NAME=$(az ml job create -f pipeline-job.yml --query name -o tsv)

Python

pipeline_job_run = ml_client.jobs.create_or_update(
    pipeline_job, experiment_name="hello-batch-pipeline"
)
pipeline_job_run

バッチ エンドポイントを作成する

パイプライン ジョブをデプロイする前に、バッチ エンドポイントをデプロイしてデプロイをホストする必要があります。

1. エンドポイントの名前を指定します。 バッチ エンドポイントの名前は、呼び出し URI の構成に使用されるため、各リージョンで一意である必要があります。 一意性を確保するために、次のコードで指定する名前に末尾文字を追加します。

   Azure CLI

   ENDPOINT_NAME="hello-batch"
   

   Python

   endpoint_name="hello-batch"
   

2. エンドポイントを構成します。

   Azure CLI

   endpoint.yml ファイルには、エンドポイントの構成が含まれます。

   endpoint.yml

   $schema: https://azuremlschemas.azureedge.net/latest/batchEndpoint.schema.json
   name: hello-batch
   description: A hello world endpoint for component deployments.
   auth_mode: aad_token
   

   Python

   endpoint = BatchEndpoint(
       name=endpoint_name,
       description="A hello world endpoint for component deployments",
   )
   

3. エンドポイントを作成します。

   Azure CLI

   az ml batch-endpoint create --name $ENDPOINT_NAME  -f endpoint.yml
   

   Python

   ml_client.batch_endpoints.begin_create_or_update(endpoint).result()
   

4. エンドポイント URI にクエリを実行します。

   Azure CLI

   az ml batch-endpoint show --name $ENDPOINT_NAME
   

   Python

   endpoint = ml_client.batch_endpoints.get(name=endpoint_name)
   print(endpoint)
   

パイプライン ジョブをデプロイする

パイプライン コンポーネントをデプロイするには、既存のジョブからバッチ デプロイを作成する必要があります。

1. デプロイするジョブの名前を Azure Machine Learning に知らせる必要があります。 この場合、そのジョブは次の変数で指定されます。

   Azure CLI

   echo $JOB_NAME
   

   Python

   print(job.name)
   

2. デプロイを構成します。

   Azure CLI

   deployment-from-job.yml ファイルには、デプロイの構成が含まれます。 このデプロイがパイプライン ジョブから作成されていることを示すために、component の代わりにキー job_definition が使用されていることに注目してください。

   deployment-from-job.yml

   $schema: https://azuremlschemas.azureedge.net/latest/pipelineComponentBatchDeployment.schema.json
   name: hello-batch-from-job
   endpoint_name: hello-pipeline-batch
   type: pipeline
   job_definition: azureml:job_name_placeholder
   settings:
       continue_on_step_failure: false
       default_compute: batch-cluster
   

   Python

   ここでは、component の代わりにプロパティ job_definition が使用されていることに注目してください。

   deployment = PipelineComponentBatchDeployment(
       name="hello-batch-from-job",
       description="A hello world deployment with a single step. This deployment is created from a pipeline job.",
       endpoint_name=endpoint.name,
       job_definition=pipeline_job_run,
       settings={
           "default_compute": "batch-cluster",
           "continue_on_step_failure": False
       }
   )
   

   ヒント

   この構成では、batch-cluster という名前のコンピューティング クラスターがあることを前提としています。 この値は、お使いのクラスターの名前に置き換えることができます。

3. デプロイを作成します。

   Azure CLI

   次のコードを実行して、バッチ エンドポイントの下にバッチ デプロイを作成し、それを既定のデプロイとして設定します。

   az ml batch-deployment create --endpoint $ENDPOINT_NAME --set job_definition=azureml:$JOB_NAME -f deployment-from-job.yml
   

   ヒント

   --set job_definition=azureml:$JOB_NAME が使用されていることに注目してください。 ジョブ名は一意であるため、ここではコマンド --set を使用して、ワークスペースで実行するときにジョブの名前を変更しています。

   Python

   このコマンドでは、デプロイの作成を開始し、デプロイの作成が続行されている間に確認応答を返します。

   ml_client.batch_deployments.begin_create_or_update(deployment).result()
   

   作成したら、この新しいデプロイを既定として構成します。

   endpoint = ml_client.batch_endpoints.get(endpoint.name)
   endpoint.defaults.deployment_name = deployment.name
   ml_client.batch_endpoints.begin_create_or_update(endpoint).result()
   

4. デプロイを使用する準備が整いました。

展開をテスト

デプロイが作成されると、ジョブを受け取る準備が整います。 次のように、既定のデプロイを呼び出すことができます。

Azure CLI

JOB_NAME=$(az ml batch-endpoint invoke -n $ENDPOINT_NAME --query name -o tsv)

Python

job = ml_client.batch_endpoints.invoke(
    endpoint_name=endpoint.name, 
)

次を使用して、ログの表示およびストリーミングの進行状況を監視できます。

Azure CLI

az ml job stream -n $JOB_NAME

Python

ml_client.jobs.get(name=job.name)

ジョブが完了するまで待つには、次のコードを実行します。

ml_client.jobs.stream(name=job.name)

リソースをクリーンアップする

完了したら、関連付けられているリソースをワークスペースから削除します。

Azure CLI

次のコードを実行して、バッチ エンドポイントとその基になっているデプロイを削除します。 --yes は、削除を確認するために使用します。

az ml batch-endpoint delete -n $ENDPOINT_NAME --yes

Python

エンドポイントを削除します:

ml_client.batch_endpoints.begin_delete(endpoint.name).result()

次のステップ

• バッチ エンドポイントを使用してトレーニング パイプラインをデプロイする方法
• 前処理を使用してバッチ スコアリングを実行するパイプラインをデプロイする方法
• バッチ エンドポイント ジョブからデータにアクセスする
• バッチ エンドポイントのトラブルシューティング