Show Menu
トピック×

パッケージ化されたレシピ(API)の読み込み

This tutorial uses the Sensei Machine Learning API to create an Engine , also known as a Recipe in the user interface.
Before getting started, it is important to note that Adobe Experience Platform Data Science Workspace uses different terms to refer to similar elements within the API and UI. API の用語はこのチュートリアル全体で使用され、次の表に、関連する用語の概要を示します。
UI の用語
API 用語
レシピ
モデル
トレーニングと評価
サービス
エンジンには、特定の問題を解決するための機械学習アルゴリズムとロジックが含まれています。The diagram below provides a visualization showing the API workflow in Data Science Workspace. このチュートリアルでは、機械学習モデルの頭脳であるエンジンの作成に焦点を当てます。

はじめに

このチュートリアルでは、Docker URLの形式でパッケージ化されたレシピファイルが必要です。 「 ソースファイルをレシピにパッケージ化する 」チュートリアルに従ってパッケージ化されたレシピファイルを作成するか、独自のレシピファイルを提供します。
  • {DOCKER_URL} :インテリジェントサービスの Docker イメージへの URL アドレス。
このチュートリアルでは、 API への呼び出しをおこなうために、 Adobe Experience Platform 認証チュートリアル を完了している必要があります。PlatformCompleting the authentication tutorial provides the values for each of the required headers in all Experience Platform API calls, as shown below:
  • {ACCESS_TOKEN} :認証後に提供される特定の Bearer トークン値。
  • {IMS_ORG} :固有の Adobe Experience Platform 統合にある IMS 組織の資格情報。
  • {API_KEY} :固有の Adobe Experience Platform 統合で見つかった特定の API キーの値。

エンジンの作成

エンジンは、/enginesエンドポイントにPOSTリクエストを行うことで作成できます。 作成したエンジンは、パッケージ化されたレシピファイルの形式に基づいて設定されます。この形式は、APIリクエストの一部として含める必要があります。

Docker URL を使用したエンジンの作成

パッケージ化されたレシピファイルを Docker コンテナに格納してエンジンを作成するには、パッケージ化されたレシピファイルの Docker URL を指定する必要があります。
またはRを使用している場合は、以下のリクエストを使用し Python てください。 PySparkまたはScalaを使用している場合は、Python/Rの例の下にあるPySpark/Scalaリクエストの例を使用してください。
API 形式
POST /engines

Python/Rの要求
curl -X POST \
    https://platform.adobe.io/data/sensei/engines \
    -H 'Authorization: {ACCESS_TOKEN}' \
    -H 'X-API-KEY: {API_KEY}' \
    -H 'content-type: multipart/form-data' \
    -H 'x-gw-ims-org-id: {IMS_ORG}' \
    -H `x-sandbox-name: {SANDBOX_NAME}` \
    -F 'engine={
        "name": "Retail Sales Engine Python",
        "description": "A description for Retail Sales Engine, this Engines execution type is Python",
        "type": "Python"
        "artifacts": {
            "default": {
                "image": {
                    "location": "{DOCKER_URL}",
                    "name": "retail_sales_python",
                    "executionType": "Python"
                }
            }
        }
    }' 

プロパティ
説明
engine.name
エンジンの名前。The Recipe corresponding to this Engine will inherit this value to be displayed in Data Science Workspace user interface as the Recipe's name.
engine.description
エンジンのオプションの説明。The Recipe corresponding to this Engine will inherit this value to be displayed in Data Science Workspace user interface as the Recipe's description. このプロパティを削除しないでください。説明を指定しない場合は、この値を空白の文字列にします。
engine.type
エンジンの実行タイプ。この値は、Docker 画像の開発言語に対応します。When a Docker URL is provided to create an Engine, type is either Python , R , PySpark , Spark (Scala), or Tensorflow .
artifacts.default.image.location
Your {DOCKER_URL} goes here. A complete Docker URL has the following structure: your_docker_host.azurecr.io/docker_image_file:version
artifacts.default.image.name
Dockerイメージファイルの追加名。 このプロパティを削除しないでください。Docker 画像ファイル名を指定しない場合は、この値を空白の文字列にします。
artifacts.default.image.executionType
このエンジンの実行タイプ。 この値は、Docker 画像の開発言語に対応します。When a Docker URL is provided to create an Engine, executionType is either Python , R , PySpark , Spark (Scala), or Tensorflow .
PySparkの要求
curl -X POST \
  https://platform.adobe.io/data/sensei/engines \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}' \
    -H 'content-type: multipart/form-data' \
    -F 'engine={
    "name": "PySpark retail sales recipe",
    "description": "A description for this Engine",
    "type": "PySpark",
    "mlLibrary":"databricks-spark",
    "artifacts": {
        "default": {
            "image": {
                "name": "modelspark",
                "executionType": "PySpark",
                "packagingType": "docker",
                "location": "v1d2cs4mimnlttw.azurecr.io/sarunbatchtest:0.0.1"
            }
        }
    }
}'

プロパティ
説明
name
エンジンの名前。このエンジンに対応するレシピは、UI に表示されるこの値をレシピ名として継承します。
description
エンジンのオプションの説明。このエンジンに対応するレシピは、UI に表示されるこの値をレシピの説明として継承します。このプロパティが必要です。説明を指定しない場合は、値を空の文字列に設定します。
type
エンジンの実行タイプ。この値は、Dockerイメージが"PySpark"上に構築される言語に対応します。
mlLibrary
PySparkおよびScalaレシピ用のエンジンを作成する場合に必要なフィールドです。
artifacts.default.image.location
Docker URL によってリンクされた Docker イメージの場所。
artifacts.default.image.executionType
エンジンの実行タイプ。この値は、Dockerイメージが「Spark」に構築される言語に対応します。
要求スケーラ
curl -X POST \
  https://platform.adobe.io/data/sensei/engines \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}' \
    -H 'content-type: multipart/form-data' \
    -F 'engine={
    "name": "Spark retail sales recipe",
    "description": "A description for this Engine",
    "type": "Spark",
    "mlLibrary":"databricks-spark",
    "artifacts": {
        "default": {
            "image": {
                "name": "modelspark",
                "executionType": "Spark",
                "packagingType": "docker",
                "location": "v1d2cs4mimnlttw.azurecr.io/sarunbatchtest:0.0.1"
            }
        }
    }
}'

プロパティ
説明
name
エンジンの名前。このエンジンに対応するレシピは、UI に表示されるこの値をレシピ名として継承します。
description
エンジンのオプションの説明。このエンジンに対応するレシピは、UI に表示されるこの値をレシピの説明として継承します。このプロパティが必要です。説明を指定しない場合は、値を空の文字列に設定します。
type
エンジンの実行タイプ。この値は、Dockerイメージが「Spark」に構築される言語に対応します。
mlLibrary
PySparkおよびScalaレシピ用のエンジンを作成する場合に必要なフィールドです。
artifacts.default.image.location
Docker URL によってリンクされた Docker イメージの場所。
artifacts.default.image.executionType
エンジンの実行タイプ。この値は、Dockerイメージが「Spark」に構築される言語に対応します。
応答  
正常な応答は、新たに作成されたエンジンの一意の識別子( id )を含む詳細を含むペイロードを返します。次に、 Python エンジンに対する応答の例を示します。 キー executionType type キーは、指定されたPOSTに基づいて変更されます。
{
    "id": "{ENGINE_ID}",
    "name": "A name for this Engine",
    "description": "A description for this Engine",
    "type": "Python",
    "algorithm": "Classification",
    "created": "2019-01-01T00:00:00.000Z",
    "createdBy": {
        "userId": "Jane_Doe@AdobeID"
    },
    "updated": "2019-01-01T00:00:00.000Z",
    "artifacts": {
        "default": {
            "image": {
                "location": "{DOCKER_URL}",
                "name": "An additional name for the Docker image",
                "executionType": "Python",
                "packagingType": "docker"
            }
        }
    }
}

成功応答は、新しく作成されたエンジンに関する情報を含む JSON ペイロードが表示されます。 id キーは、一意のエンジン識別子を表し、次のチュートリアルで MLInstance を作成するために必要となります。次の手順に進む前に、エンジン識別子が保存されていることを確認します。

次の手順

API を使用してエンジンを作成し、応答本文の一部として一意のエンジン識別子を取得しました。次のチュートリアルでは、 API を使用してモデルの作成、トレーニング、評価をおこなう 方法について学習しながら、このエンジン識別子を使用できます。