文档 Experience Platform Data Science Workspace 指南

使用Sensei机器学习API导入打包的方法

Last update: Tue Aug 06 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

主题：
Data Science Workspace

创建对象：

用户
开发人员

NOTE

数据科学Workspace不再可供购买。

本文档面向之前有权访问数据科学Workspace的现有客户。

本教程使用Sensei Machine Learning API创建一个引擎，在用户界面中又称为“方法”。

在开始使用之前，请务必注意Adobe Experience Platform Data Science Workspace使用不同的术语来引用API和UI中的类似元素。在本教程中使用API术语，下表概述了相关术语：

UI术语

API术语

方法

模型

培训和评价

服务

引擎包含用于解决特定问题的机器学习算法和逻辑。下图提供了一个可视化图表，显示Data Science Workspace中的API工作流。本教程侧重于创建引擎，即机器学习模型的大脑。

快速入门

本教程需要一个格式为Docker URL的打包的方法文件。按照将源文件打包到方法教程中创建打包的方法文件或提供您自己的方法文件。

{DOCKER_URL}：智能服务的Docker映像的URL地址。

本教程要求您完成对Adobe Experience Platform的身份验证教程，才能成功调用Platform API。完成身份验证教程会提供所有 Experience Platform API 调用中每个所需标头的值，如下所示：

{ACCESS_TOKEN}：在身份验证后提供的特定持有者令牌值。
{ORG_ID}：在独特的Adobe Experience Platform集成中找到您的组织凭据。
{API_KEY}：在独特的Adobe Experience Platform集成中找到特定的API密钥值。

创建引擎

可以通过向/engines端点发出POST请求来创建引擎。创建的引擎会根据打包的Recipe文件的形式进行配置，该文件必须包含在API请求中。

使用Docker URL创建引擎 create-an-engine-with-a-docker-url

要使用存储在Docker容器中的打包的配方文件创建引擎，您必须提供指向打包的配方文件的Docker URL。

CAUTION

如果您使用的是Python或R，请使用下面的请求。如果您使用的是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: {ORG_ID}' \
    -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

引擎所需的名称。与此引擎对应的处方将继承此值，以作为处方名称显示在Data Science Workspace用户界面中。

engine.description

引擎的可选说明。与此引擎对应的处方将继承此值，以作为处方说明显示在Data Science Workspace用户界面中。请勿删除此属性，如果您选择不提供描述，请将此值设置为空字符串。

engine.type

引擎的执行类型。此值对应于在其中开发Docker图像的语言。当提供Docker URL以创建引擎时，type是Python、R、PySpark、Spark (Scala)或Tensorflow。

artifacts.default.image.location

您的{DOCKER_URL}转到此处。完整的Docker URL具有以下结构： your_docker_host.azurecr.io/docker_image_file:version

artifacts.default.image.name

Docker图像文件的附加名称。不要删除此属性，如果您选择不提供额外的Docker图像文件名，请将此值设置为空字符串。

artifacts.default.image.executionType

此引擎的执行类型。此值对应于开发Docker图像时使用的语言。当提供Docker URL以创建引擎时，executionType为Python、R、PySpark、Spark (Scala)或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: {ORG_ID}' \
    -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

引擎的执行类型。此值对应于在“PySpark”上构建Docker图像的语言。

mlLibrary

创建PySpark和Scala配方的引擎时所需的字段。

artifacts.default.image.location

Docker URL链接到的Docker图像的位置。

artifacts.default.image.executionType

引擎的执行类型。此值对应于在“Spark”上构建Docker图像的语言。

请求Scala

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: {ORG_ID}' \
    -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

引擎的执行类型。此值对应于在“Spark”上构建Docker图像所使用的语言。

mlLibrary

为PySpark和Scala配方创建引擎时所需的字段。

artifacts.default.image.location

通过Docker URL链接到的Docker图像的位置。

artifacts.default.image.executionType

引擎的执行类型。此值对应于在“Spark”上构建Docker图像所使用的语言。

响应

成功的响应将返回一个有效负载，其中包含新创建的引擎的详细信息，包括其唯一标识符(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。确保已保存引擎标识符，然后再继续执行后续步骤。

后续步骤 next-steps

您已使用API创建引擎，并且已获得唯一的引擎标识符作为响应正文的一部分。在学习如何使用API创建、训练和评估模型时，可以在下一个教程中使用此引擎标识符。

recommendation-more-help

cc79fe26-64da-411e-a6b9-5b650f53e4e9