バッチエンドポイントのジョブと入力データを作成する

[アーティクル]
09/03/2024

バッチエンドポイントを使用すると、大量のデータに対して長いバッチ操作を実行できます。データは、分散領域間など、さまざまな場所に配置できます。特定の種類のバッチエンドポイントでは、リテラルパラメーターを入力として受け取ることもできます。

この記事では、バッチエンドポイントのパラメーター入力を指定し、デプロイジョブを作成する方法について説明します。このプロセスでは、さまざまな種類のデータの操作がサポートされています。例については、「入力と出力について」を参照してください。

前提条件

バッチエンドポイントを正常に呼び出してジョブを作成するには、次の前提条件を満たしていることを確認します。

バッチエンドポイントとデプロイ。これらのリソースを持っていない場合は、「バッチエンドポイントにスコアリング用のモデルをデプロイする」を参照してデプロイを作成します。
バッチエンドポイントデプロイを実行するためのアクセス許可。 AzureML データサイエンティスト、共同作成者、所有者 の各ロールを使用して、デプロイを実行できます。カスタムロールの定義については、「バッチエンドポイントでの認可」を参照して、必要な特定のアクセス許可を確認してください。
エンドポイントを呼び出すためのセキュリティプリンシパルを表す有効な Microsoft Entra ID トークン。このプリンシパルには、ユーザープリンシパルまたはサービスプリンシパルを指定できます。エンドポイントを呼び出すと、Azure Machine Learning によって、トークンに関連付けられている ID の下にバッチデプロイジョブが作成されます。次の手順で説明するように、呼び出しには独自の資格情報を使用できます。
- Azure CLI
- Python
- REST
Azure CLI を使用して、対話型認証またはデバイスコード認証でサインインします。
```
az login
```
Azure Machine Learning SDK for Python を使ってサインインします。
```
from azure.ai.ml import MLClient
from azure.identity import DefaultAzureCredential

ml_client = MLClient.from_config(DefaultAzureCredential())
```
構成が Azure Machine Learning コンピューティングの外部で実行されている場合は、エンドポイントがデプロイされるワークスペースを指定する必要があります。
```
from azure.ai.ml import MLClient
from azure.identity import DefaultAzureCredential

subscription_id = "<subscription>"
resource_group = "<resource-group>"
workspace = "<workspace>"

ml_client = MLClient(DefaultAzureCredential(), subscription_id, resource_group, workspace)
```
ユーザーアカウントの有効なトークンを取得する最も簡単な方法は、Azure CLI を使用することです。コンソールで、次の Azure CLI コマンドを実行します。
```
az account get-access-token --resource https://ml.azure.com --query "accessToken" --output tsv
```
ヒント

REST を使用する場合は、サービスプリンシパルを使用してバッチエンドポイントを呼び出すことをお勧めします。詳細については、「サービスプリンシパル (REST) を使用したジョブの実行」を参照して、REST を使用してサービスプリンシパルのトークンを取得する方法を確認してください。
さまざまな種類の資格情報を使用してバッチデプロイジョブを開始する方法の詳細については、「さまざまな種類の資格情報を使用してジョブを実行する方法」を参照してください。
エンドポイントがデプロイされているコンピューティングクラスターは、入力データを読み取るアクセス権を持っています。

ヒント

資格情報のないデータストアまたは外部の Azure Storage アカウントをデータ入力として使う場合は、必ずデータアクセス用にコンピューティングクラスターを構成してください。コンピューティングクラスターのマネージド ID は、ストレージアカウントをマウントするために使われます。ジョブの ID (呼び出し元) は、基になるデータを読み取るために引き続き使用されるので、きめ細かいアクセス制御を実現できます。

ジョブの基本を作成する

バッチエンドポイントからジョブを作成するには、エンドポイントを呼び出します。呼び出しは、Azure CLI、Azure Machine Learning SDK for Python、または REST API 呼び出しを使用して実行できます。次の例は、処理用の単一の入力データフォルダーを受け取るバッチエンドポイントの呼び出しの基本を示しています。さまざまな入力と出力の例については、「入力と出力について」を参照してください。

バッチエンドポイントで invoke 操作を使用します。

az ml batch-endpoint invoke --name $ENDPOINT_NAME \
                            --input https://azuremlexampledata.blob.core.windows.net/data/heart-disease-uci/data

MLClient.batch_endpoints.invoke() メソッドを使って実験の名前を指定します。

job = ml_client.batch_endpoints.invoke(
    endpoint_name=endpoint.name,
    inputs={
        "heart_dataset": Input("https://azuremlexampledata.blob.core.windows.net/data/heart-disease-uci/data")
    }
)

エンドポイントの呼び出し URL に POST 要求を行います。呼び出し URL は、エンドポイントの詳細ページで Azure Machine Learning ポータルから取得できます。

本文

{
    "properties": {
        "InputData": {
           "heart_dataset": {
               "JobInputType" : "UriFolder",
               "Uri": "https://azuremlexampledata.blob.core.windows.net/data/heart-disease-uci/data"
           }
        }
    }
}

Request

POST jobs HTTP/1.1
Host: <ENDPOINT_URI>
Authorization: Bearer <TOKEN>
Content-Type: application/json

特定のデプロイを呼び出す

バッチエンドポイントは、同じエンドポイントで複数のデプロイをホストできます。ユーザーが特に指定しない限り、既定のエンドポイントが使われます。次の手順で使用するようにデプロイを変更できます。

引数 --deployment-name または -d を使ってデプロイの名前を指定します。

az ml batch-endpoint invoke --name $ENDPOINT_NAME \
                            --deployment-name $DEPLOYMENT_NAME \
                            --input https://azuremlexampledata.blob.core.windows.net/data/heart-disease-uci/data

パラメーター deployment_name を使ってデプロイの名前を指定します。

job = ml_client.batch_endpoints.invoke(
    endpoint_name=endpoint.name,
    deployment_name=deployment.name,
    inputs={
        "heart_dataset": Input("https://azuremlexampledata.blob.core.windows.net/data/heart-disease-uci/data")
    }
)

ヘッダー azureml-model-deployment を要求に追加し、呼び出すデプロイの名前を含めます。

本文

{
    "properties": {
        "InputData": {
           "heart_dataset": {
               "JobInputType" : "UriFolder",
               "Uri": "https://azuremlexampledata.blob.core.windows.net/data/heart-disease-uci/data"
           }
        }
    }
}

Request

POST jobs HTTP/1.1
Host: <ENDPOINT_URI>
Authorization: Bearer <TOKEN>
Content-Type: application/json
azureml-model-deployment: DEPLOYMENT_NAME

ジョブのプロパティを構成する

作成されたジョブでは、呼び出し時にいくつかのプロパティを構成できます。

Note

現在、ジョブのプロパティを構成する機能は、パイプラインコンポーネントのデプロイを使用するバッチエンドポイントでのみ使用できます。

実験名を構成する

実験名を構成するには、次の手順に従います。

引数 --experiment-name を使って実験の名前を指定します。

az ml batch-endpoint invoke --name $ENDPOINT_NAME \
                            --experiment-name "my-batch-job-experiment" \
                            --input https://azuremlexampledata.blob.core.windows.net/data/heart-disease-uci/data

パラメーター experiment_name を使って実験の名前を指定します。

job = ml_client.batch_endpoints.invoke(
    endpoint_name=endpoint.name,
    experiment_name="my-batch-job-experiment",
    inputs={
        "heart_dataset": Input("https://azuremlexampledata.blob.core.windows.net/data/heart-disease-uci/data"),
    }
)

properties セクションで experimentName キーを使用して実験名を指定します。

本文

{
    "properties": {
        "InputData": {
           "heart_dataset": {
               "JobInputType" : "UriFolder",
               "Uri": "https://azuremlexampledata.blob.core.windows.net/data/heart-disease-uci/data"
           }
        },
        "properties":
        {
            "experimentName": "my-batch-job-experiment"
        }
    }
}

Request

POST jobs HTTP/1.1
Host: <ENDPOINT_URI>
Authorization: Bearer <TOKEN>
Content-Type: application/json

入力と出力について

バッチエンドポイントは、コンシューマーがバッチジョブの作成に使用できる永続的な API を提供します。同じインターフェイスを使用して、デプロイで想定される入力と出力を指定できます。入力を使用して、ジョブを実行するためにエンドポイントに必要な情報を渡します。

バッチエンドポイントで入力と出力がどのように使用されるかを示す図。

バッチエンドポイントは次の 2 種類の入力をサポートします。

データ入力: 特定の保存場所または Azure Machine Learning 資産へのポインターです。
リテラル入力: ジョブに渡すリテラル値 (数値や文字列など) です。

入力と出力の数と種類は、バッチデプロイの種類によって異なります。モデルデプロイは、常に 1 つのデータ入力を必要とし、1 つのデータ出力を生成します。リテラル入力はサポートされていません。ただし、パイプラインコンポーネントデプロイを使用すると、エンドポイントを構築するためのより一般的なコンストラクトが提供され、任意の数の入力 (データとリテラル) と出力を指定できます。

次の表は、バッチデプロイの入力と出力をまとめたものです。

デプロイの種類	入力の数	サポートされている入力の種類	出力の数	サポートされている出力の種類
モデルデプロイ	1	データ入力	1	データ出力
パイプラインコンポーネントデプロイ	[0..N]	データ入力とリテラル入力	[0..N]	データ出力

ヒント

入力と出力は常に名前付きです。これらの名前は、呼び出し中にデータを識別し、実際の値を渡すためのキーとして機能します。モデルデプロイでは、常に 1 つの入力と出力が必要であるため、呼び出し中に名前は無視されます。 "sales_estimation" のように、ユースケースを最もよく表す名前を割り当てることができます。

データ入力を調べる

データ入力とは、データが配置されている場所を指す入力のことです。バッチエンドポイントは通常、大量のデータを消費するため、呼び出し要求の一部として入力データを渡すことはできません。代わりに、バッチエンドポイントがデータを検索する場所を指定します。パフォーマンスを向上させるために、入力データはターゲットコンピューティングにマウントされ、ストリーミングされます。

バッチエンドポイントでは、次のストレージオプションに配置されているファイルの読み取りがサポートされています。

Azure Machine Learning データ資産。フォルダー (uri_folder)、ファイル (uri_file) などです。
Azure Machine Learning データストア。Azure Blob Storage、Azure Data Lake Storage Gen1、Azure Data Lake Storage Gen2 などです。
Azure Storage アカウント。Azure Data Lake Storage Gen1、Azure Data Lake Storage Gen2、Azure Blob Storage などです。
ローカルデータフォルダーまたはファイル (Azure Machine Learning CLI または Azure Machine Learning SDK for Python)。ただし、その操作により、作業中のワークスペースの既定の Azure Machine Learning データストアにローカルデータがアップロードされます。

重要

非推奨の通知: 型 FileDataset (V1) のデータセットは非推奨となり、今後廃止される予定です。この機能に依存する既存のバッチエンドポイントは引き続き機能します。 GA CLIv2 (2.4.0 以降) または GA REST API (2022-05-01 以降) で作成されたバッチエンドポイントでは、V1 データセットはサポートされません。

リテラル入力を調べる

リテラル入力とは文字列、数値、ブール値など、呼び出し時に表現および解決できる入力のことです。通常は、リテラル入力を使用して、パイプラインコンポーネントデプロイの一部としてエンドポイントにパラメーターを渡します。バッチエンドポイントでは、次のリテラル型がサポートされています。

string
boolean
float
integer

リテラル入力は、パイプラインコンポーネントのデプロイでのみサポートされます。それらを指定する方法については、「リテラル入力を使ってジョブを作成する」を参照してください。

データ出力を調べる

データ出力とは、バッチジョブの結果が配置される場所のことです。各出力には識別可能な名前が付けられ、Azure Machine Learning によって、名前付き出力のそれぞれに一意のパスが自動的に割り当てられます。必要に応じて、別のパスを指定できます。

重要

バッチエンドポイントでは、Azure Blob Storage データストアでの出力の書き込みのみがサポートされます。階層型名前空間が有効なストレージアカウント (Azure Datalake Gen2 または ADLS Gen2 とも呼ばれます) に書き込む必要がある場合、サービスは完全に互換性があるため、ストレージサービスを Azure Blob Storage データストアとして登録できます。このように、バッチエンドポイントからの出力を ADLS Gen2 に書き込むことができます。

データ入力を使ってジョブを作成する

次の例は、データ資産、データストア、Azure Storage アカウントからデータ入力を取得してジョブを作成する方法を示しています。

データ資産からの入力データを使用する

Azure Machine Learning のデータ資産 (以前のデータセット) は、ジョブへの入力としてサポートされています。 Azure Machine Learning の登録済みデータ資産に格納されているデータを使用してバッチエンドポイントジョブを実行するには、次の手順に従います。

警告

型 Table (MLTable) のデータ資産は、現在サポートされていません。

最初にデータ資産を作成します。このデータ資産は、バッチエンドポイントを使って並列処理する複数の CSV ファイルを含む、1 つのフォルダーで構成されています。データが既にデータ資産として登録されている場合は、この手順をスキップできます。
- Azure CLI
- Python
- REST
YAML にデータ資産定義を作成します。

heart-dataset-unlabeled.yml
```
$schema: https://azuremlschemas.azureedge.net/latest/data.schema.json
name: heart-dataset-unlabeled
description: An unlabeled dataset for heart classification.
type: uri_folder
path: heart-classifier-mlflow/data
```
次にデータ資産を作成します。
```
az ml data create -f heart-dataset-unlabeled.yml
```
データ資産定義を作成します。
```
data_path = "heart-classifier-mlflow/data"
dataset_name = "heart-dataset-unlabeled"

heart_dataset_unlabeled = Data(
    path=data_path,
    type=AssetTypes.URI_FOLDER,
    description="An unlabeled dataset for heart classification",
    name=dataset_name,
)
```
データ資産を作成します。
```
ml_client.data.create_or_update(heart_dataset_unlabeled)
```
新しく作成されたデータ資産を取得するには、次のコマンドを使用します。
```
heart_dataset_unlabeled = ml_client.data.get(name=dataset_name, label="latest")
```
Azure Machine Learning CLI、Azure Machine Learning SDK for Python、Azure Machine Learning スタジオのいずれかを使用して、場所 (リージョン)、ワークスペース、データ資産の名前とバージョンを取得します。これらの項目は、後の手順で必要になります。

入力または要求を作成します。

DATASET_ID=$(az ml data show -n heart-dataset-unlabeled --label latest | jq -r .id)

input = Input(path=heart_dataset_unlabeled.id)

本文

{
    "properties": {
        "InputData": {
            "heart_dataset": {
                "JobInputType" : "UriFolder",
                "Uri": "azureml://locations/<location>/workspaces/<workspace>/data/<dataset_name>/versions/labels/latest"
            }
        }
    }
}

データ資産 ID は /subscriptions/<subscription>/resourcegroups/<resource-group>/providers/Microsoft.MachineLearningServices/workspaces/<workspace>/data/<data-asset>/versions/<version> のようになります。 azureml:<datasset_name>@latest 形式を使用して入力を指定することもできます。

エンドポイントを実行します。
- Azure CLI
- Python
- REST
--set 引数を使用して入力を指定します。
```
az ml batch-endpoint invoke --name $ENDPOINT_NAME \
    --set inputs.heart_dataset.type="uri_folder" inputs.heart_dataset.path=$DATASET_ID
```
モデルデプロイにサービスを提供するエンドポイントの場合、--input 引数を使用してデータ入力を指定できます。これは、モデルのデプロイで必要なデータ入力が常に 1 つだけであるためです。
```
az ml batch-endpoint invoke --name $ENDPOINT_NAME --input $DATASET_ID
```
複数の入力が指定されている場合、引数 --set は長いコマンドを生成する傾向があります。そのような場合は、YAML ファイルに入力を配置し、--file 引数を使用して、エンドポイント呼び出しに必要な入力を指定します。

inputs.yml
```
inputs:
  heart_dataset: azureml:/<datasset_name>@latest
```
次のコマンドを実行します。
```
az ml batch-endpoint invoke --name $ENDPOINT_NAME --file inputs.yml
```
ヒント

エンドポイントを呼び出すときのパラメーター inputs と input の違いは何ですか?

一般的には invoke メソッドで辞書パラメーター inputs = {} を使用すると、"モデルデプロイ" または "パイプラインデプロイ" を含むバッチエンドポイントに任意の個数の必須入力を与えることができます。

"モデルデプロイ" の場合は、デプロイの入力データの場所を指定する簡単な方法として input パラメーターを使用できます。このアプローチが機能するのは、モデルデプロイが常に 1 つだけのデータ入力を受け取るためです。

inputs パラメーターを使用して invoke メソッドを呼び出し、必要な入力を指定します。
```
job = ml_client.batch_endpoints.invoke(
    endpoint_name=endpoint.name,
    inputs={
        "heart_dataset": input,
    }
)
```
input パラメーターを使用して入力データの場所を指定することで、モデルデプロイに対する invoke 呼び出しをさらに簡略化します。
```
job = ml_client.batch_endpoints.invoke(
   endpoint_name=endpoint.name,
   input=input,
)
```
Request
```
POST jobs HTTP/1.1
Host: <ENDPOINT_URI>
Authorization: Bearer <TOKEN>
Content-Type: application/json
```

データストアからの入力データを使用する

Azure Machine Learning に登録済みのデータストアのデータをバッチデプロイジョブで直接参照できます。この例では、まず Azure Machine Learning ワークスペース内の既定のデータストアにある程度のデータをアップロードした後、それに対してバッチデプロイを実行します。データストアの格納データを使用してバッチエンドポイントジョブを実行するには、次の手順に従います。

Azure Machine Learning ワークスペースの既定のデータストアにアクセスします。データが別のストアにある場合は、代わりにそのストアを使用できます。既定のデータストアを使用しなくてもかまいません。
- Azure CLI
- Python
- REST
```
DATASTORE_ID=$(az ml datastore show -n workspaceblobstore | jq -r '.id')
```
データストア ID は /subscriptions/<subscription>/resourceGroups/<resource-group>/providers/Microsoft.MachineLearningServices/workspaces/<workspace>/datastores/<data-store> のようになります。
```
default_ds = ml_client.datastores.get_default()
```
Azure Machine Learning CLI、Azure Machine Learning SDK for Python、またはスタジオを使用してデータストア情報を取得します。
ヒント

ワークスペース内の既定の BLOB データストアの名前は workspaceblobstore です。ワークスペース内の既定のデータストアのリソース ID が既にわかっている場合は、この手順をスキップできます。
サンプルデータをいくつかデータストアにアップロードします。

この例では、リポジトリに含まれるサンプルデータを、BLOB ストレージアカウントのフォルダー heart-disease-uci-unlabeled にあるフォルダー sdk/python/endpoints/batch/deploy-models/heart-classifier-mlflow/data に既にアップロード済みであることを前提としています。続行する前に、必ずこの手順を完了してください。
入力または要求を作成します。
- Azure CLI
- Python
- REST
ファイルパスを INPUT_PATH 変数に配置します。
```
DATA_PATH="heart-disease-uci-unlabeled"
INPUT_PATH="$DATASTORE_ID/paths/$DATA_PATH"
```
ファイルパスを input 変数に配置します。
```
data_path = "heart-disease-uci-unlabeled"
input = Input(type=AssetTypes.URI_FOLDER, path=f"{default_ds.id}/paths/{data_path})
```
データがファイルの場合は、入力の種類を type=AssetTypes.URI_FILE に変更します。
本文
```
{
    "properties": {
        "InputData": {
            "heart_dataset": {
                "JobInputType" : "UriFolder",
                "Uri": "azureml:/subscriptions/<subscription>/resourceGroups/<resource-group/providers/Microsoft.MachineLearningServices/workspaces/<workspace>/datastores/<data-store>/paths/<data-path>"
            }
        }
    }
}
```
データがファイルの場合は、代わりに入力に UriFile 型を使用します。
パスの paths 変数がデータストアのリソース ID にどのように追加されるかに注目してください。この形式は、後続の値がパスであることを示します。

ヒント

azureml://datastores/<data-store>/paths/<data-path> 形式を使用して入力を指定することもできます。
エンドポイントを実行します。
- Azure CLI
- Python
- REST
--set 引数を使用して入力を指定します。
```
az ml batch-endpoint invoke --name $ENDPOINT_NAME \
    --set inputs.heart_dataset.type="uri_folder" inputs.heart_dataset.path=$INPUT_PATH
```
モデルデプロイにサービスを提供するエンドポイントの場合、--input 引数を使用してデータ入力を指定できます。これは、モデルのデプロイで必要なデータ入力が常に 1 つだけであるためです。
```
az ml batch-endpoint invoke --name $ENDPOINT_NAME --input $INPUT_PATH --input-type uri_folder
```
複数の入力が指定されている場合、引数 --set は長いコマンドを生成する傾向があります。そのような場合は、YAML ファイルに入力を配置し、--file 引数を使用して、エンドポイント呼び出しに必要な入力を指定します。

inputs.yml
```
inputs:
  heart_dataset:
    type: uri_folder
    path: azureml://datastores/<data-store>/paths/<data-path>
```
次のコマンドを実行します。
```
az ml batch-endpoint invoke --name $ENDPOINT_NAME --file inputs.yml
```
データがファイルの場合は、代わりに入力に uri_file 型を使用します。
ヒント

エンドポイントを呼び出すときのパラメーター inputs と input の違いは何ですか?

一般的には invoke メソッドで辞書パラメーター inputs = {} を使用すると、"モデルデプロイ" または "パイプラインデプロイ" を含むバッチエンドポイントに任意の個数の必須入力を与えることができます。

"モデルデプロイ" の場合は、デプロイの入力データの場所を指定する簡単な方法として input パラメーターを使用できます。このアプローチが機能するのは、モデルデプロイが常に 1 つだけのデータ入力を受け取るためです。

inputs パラメーターを使用して invoke メソッドを呼び出し、必要な入力を指定します。
```
job = ml_client.batch_endpoints.invoke(
    endpoint_name=endpoint.name,
    inputs={
        "heart_dataset": input,
    }
)
```
input パラメーターを使用して入力データの場所を指定することで、モデルデプロイに対する invoke 呼び出しをさらに簡略化します。
```
job = ml_client.batch_endpoints.invoke(
   endpoint_name=endpoint.name,
   input=input,
)
```
Request
```
POST jobs HTTP/1.1
Host: <ENDPOINT_URI>
Authorization: Bearer <TOKEN>
Content-Type: application/json
```

Azure Storage アカウントからの入力データを使用する

Azure Machine Learning バッチエンドポイントでは、Azure Storage アカウント内のクラウドの場所 (パブリックとプライベートの両方) からデータを読み取ることができます。ストレージアカウントに格納されているデータを使用してバッチエンドポイントジョブを実行するには、次の手順に従います。

ストレージアカウントからデータを読み取るために必要な追加の構成の詳細については、「データアクセス用にコンピューティングクラスターを構成する」を参照してください。

入力または要求を作成します。

INPUT_DATA 変数を設定します。

INPUT_DATA = "https://azuremlexampledata.blob.core.windows.net/data/heart-disease-uci/data"

データがファイルの場合は、次の形式で変数を設定します。

INPUT_DATA = "https://azuremlexampledata.blob.core.windows.net/data/heart-disease-uci/data/heart.csv"

input 変数を設定します。

input = Input(
    type=AssetTypes.URI_FOLDER, 
    path="https://azuremlexampledata.blob.core.windows.net/data/heart-disease-uci/data"
)

データがファイルの場合は、入力の種類を type=AssetTypes.URI_FILE に変更します。

input = Input(
    type=AssetTypes.URI_FILE,
    path="https://azuremlexampledata.blob.core.windows.net/data/heart-disease-uci/data/heart.csv"
)

本文

{
   "properties": {
       "InputData": {
           "heart_dataset": {
               "JobInputType" : "UriFolder",
               "Uri": "https://azuremlexampledata.blob.core.windows.net/data/heart-disease-uci/data"
           }
       }
   }
}

データがファイルの場合は、入力の種類を JobInputType に変更します。

本文

{
   "properties": {
       "InputData": {
           "heart_dataset": {
               "JobInputType" : "UriFile",
               "Uri": "https://azuremlexampledata.blob.core.windows.net/data/heart-disease-uci/data/heart.csv"
           }
       }
   }
}

エンドポイントを実行します。
- Azure CLI
- Python
- REST
--set 引数を使用して入力を指定します。
```
az ml batch-endpoint invoke --name $ENDPOINT_NAME \
    --set inputs.heart_dataset.type="uri_folder" inputs.heart_dataset.path=$INPUT_DATA
```
モデルデプロイにサービスを提供するエンドポイントの場合、--input 引数を使用してデータ入力を指定できます。これは、モデルのデプロイで必要なデータ入力が常に 1 つだけであるためです。
```
az ml batch-endpoint invoke --name $ENDPOINT_NAME --input $INPUT_DATA --input-type uri_folder
```
複数の入力が指定されている場合、引数 --set は長いコマンドを生成する傾向があります。そのような場合は、YAML ファイルに入力を配置し、--file 引数を使用して、エンドポイント呼び出しに必要な入力を指定します。

inputs.yml
```
inputs:
  heart_dataset:
    type: uri_folder
    path: https://azuremlexampledata.blob.core.windows.net/data/heart-disease-uci/data
```
次のコマンドを実行します。
```
az ml batch-endpoint invoke --name $ENDPOINT_NAME --file inputs.yml
```
データがファイルの場合は、代わりに入力に uri_file 型を使用します。
ヒント

エンドポイントを呼び出すときのパラメーター inputs と input の違いは何ですか?

一般的には invoke メソッドで辞書パラメーター inputs = {} を使用すると、"モデルデプロイ" または "パイプラインデプロイ" を含むバッチエンドポイントに任意の個数の必須入力を与えることができます。

"モデルデプロイ" の場合は、デプロイの入力データの場所を指定する簡単な方法として input パラメーターを使用できます。このアプローチが機能するのは、モデルデプロイが常に 1 つだけのデータ入力を受け取るためです。

inputs パラメーターを使用して invoke メソッドを呼び出し、必要な入力を指定します。
```
job = ml_client.batch_endpoints.invoke(
    endpoint_name=endpoint.name,
    inputs={
        "heart_dataset": input,
    }
)
```
input パラメーターを使用して入力データの場所を指定することで、モデルデプロイに対する invoke 呼び出しをさらに簡略化します。
```
job = ml_client.batch_endpoints.invoke(
   endpoint_name=endpoint.name,
   input=input,
)
```
Request
```
POST jobs HTTP/1.1
Host: <ENDPOINT_URI>
Authorization: Bearer <TOKEN>
Content-Type: application/json
```

リテラル入力を使ってジョブを作成する

パイプラインコンポーネントのデプロイでは、リテラル入力を受け取ることができます。次の例は、名前が score_mode、型が string、値が append の入力を指定する方法を示します。

YAML ファイルに入力を配置し、--file を使用して、エンドポイント呼び出しに必要な入力を指定します。

inputs.yml

inputs:
  score_mode:
    type: string
    default: append

次のコマンドを実行します。

az ml batch-endpoint invoke --name $ENDPOINT_NAME --file inputs.yml

引数 --set を使用して値を指定することもできます。ただし、複数の入力が指定されている場合、このアプローチでは長いコマンドが生成される傾向があります。

az ml batch-endpoint invoke --name $ENDPOINT_NAME \
    --set inputs.score_mode.type="string" inputs.score_mode.default="append"

job = ml_client.batch_endpoints.invoke(
    endpoint_name=endpoint.name, 
    inputs = { 
        'score_mode': Input(type="string", default="append")
        }
)

本文

{
    "properties": {
        "InputData": {
            "score_mode": {
                "JobInputType" : "Literal",
                "Value": "append"
            }
        }
    }
}

Request

POST jobs HTTP/1.1
Host: <ENDPOINT_URI>
Authorization: Bearer <TOKEN>
Content-Type: application/json

データ出力を使ってジョブを作成する

次の例は、score という名前の出力が配置される場所を変更する方法を示しています。完全にするために、これらの例では heart_dataset という名前の入力も構成します。

Azure Machine Learning ワークスペース内の既定のデータストアを使用して、出力の保存します。 BLOB ストレージアカウントであれば、ワークスペース内の他の任意のデータストアを使用できます。
- Azure CLI
- Python
- REST
```
DATASTORE_ID=$(az ml datastore show -n workspaceblobstore | jq -r '.id')
```
データストア ID は /subscriptions/<subscription>/resourceGroups/<resource-group>/providers/Microsoft.MachineLearningServices/workspaces/<workspace>/datastores/<data-store> のようになります。
```
default_ds = ml_client.datastores.get_default()
```
Azure Machine Learning CLI、Azure Machine Learning SDK for Python、またはスタジオを使用してデータストア情報を取得します。

データ出力を作成します。

OUTPUT_PATH 変数を設定します。

DATA_PATH="batch-jobs/my-unique-path"
OUTPUT_PATH="$DATASTORE_ID/paths/$DATA_PATH"

完全にするために、データ入力も作成します。

INPUT_PATH="https://azuremlexampledata.blob.core.windows.net/data/heart-disease-uci/data"

output パス変数を設定します。

data_path = "batch-jobs/my-unique-path"
output = Output(type=AssetTypes.URI_FILE, path=f"{default_ds.id}/paths/{data_path})

完全にするために、データ入力も作成しましょう。

input="https://azuremlexampledata.blob.core.windows.net/data/heart-disease-uci/data"

本文

{
    "properties": {
        "InputData": {
           "heart_dataset": {
               "JobInputType" : "UriFolder",
               "Uri": "https://azuremlexampledata.blob.core.windows.net/data/heart-disease-uci/data"
           }
        },
        "OutputData": {
            "score": {
                "JobOutputType" : "UriFile",
                "Uri": "azureml:/subscriptions/<subscription>/resourceGroups/<resource-group/providers/Microsoft.MachineLearningServices/workspaces/<workspace>/datastores/<data-store>/paths/<data-path>"
            }
        }
    }
}

Note

パスの paths 変数がデータストアのリソース ID にどのように追加されるかに注目してください。この形式は、後続の値がパスであることを示します。

デプロイを実行します。

--set 引数を使用して入力を指定します。

az ml batch-endpoint invoke --name $ENDPOINT_NAME \
    --set inputs.heart_dataset.path=$INPUT_PATH \
    --set outputs.score.path=$OUTPUT_PATH

job = ml_client.batch_endpoints.invoke(
   endpoint_name=endpoint.name,
   inputs={ "heart_dataset": input },
   outputs={ "score": output }
)

Request

POST jobs HTTP/1.1
Host: <ENDPOINT_URI>
Authorization: Bearer <TOKEN>
Content-Type: application/json

次の方法で共有

バッチエンドポイントのジョブと入力データを作成する

前提条件

ジョブの基本を作成する

特定のデプロイを呼び出す

ジョブのプロパティを構成する

実験名を構成する

入力と出力について

データ入力を調べる

リテラル入力を調べる

データ出力を調べる

データ入力を使ってジョブを作成する

データ資産からの入力データを使用する

データストアからの入力データを使用する

Azure Storage アカウントからの入力データを使用する

リテラル入力を使ってジョブを作成する

データ出力を使ってジョブを作成する

フィードバック

その他のリソース

次の方法で共有

バッチ エンドポイントのジョブと入力データを作成する

前提条件

ジョブの基本を作成する

特定のデプロイを呼び出す

ジョブのプロパティを構成する

実験名を構成する

入力と出力について

データ入力を調べる

リテラル入力を調べる

データ出力を調べる

データ入力を使ってジョブを作成する

データ資産からの入力データを使用する

データ ストアからの入力データを使用する

Azure Storage アカウントからの入力データを使用する

リテラル入力を使ってジョブを作成する

データ出力を使ってジョブを作成する

関連するコンテンツ

フィードバック

その他のリソース

バッチエンドポイントのジョブと入力データを作成する

データストアからの入力データを使用する