In diesem Tutorial wird die Sensei Machine Learning API , um eine Engine, auch in der Benutzeroberfläche als Rezept bezeichnet.
Bevor Sie beginnen, sollten Sie Folgendes beachten: Adobe Experience Platform Data Science Workspace verwendet unterschiedliche Begriffe, um auf ähnliche Elemente in der API und Benutzeroberfläche zu verweisen. Die API-Begriffe werden in diesem Tutorial verwendet. In der folgenden Tabelle sind die entsprechenden Begriffe aufgeführt:
UI-Begriff | API-Begriff |
---|---|
Rezept | Engine |
Modell | MLInstance |
Ausbildung und Evaluierung | Experiment |
Service | MLService |
Eine Engine enthält Algorithmen und Logik für maschinelles Lernen, um bestimmte Probleme zu lösen. Das folgende Diagramm zeigt eine Visualisierung des API-Workflows in Data Science Workspace. Dieses Tutorial konzentriert sich auf die Erstellung einer Engine, des Gehirns eines Modells für maschinelles Lernen.
Für dieses Tutorial ist eine gepackte Rezeptdatei in Form einer Docker-URL erforderlich. Befolgen Sie die Quelldateien in einem Rezept verpacken Tutorial zum Erstellen einer gepackten Rezeptdatei oder Bereitstellen einer eigenen.
{DOCKER_URL}
: Eine URL-Adresse für ein Docker-Bild eines intelligenten Dienstes.Für dieses Tutorial müssen Sie die Tutorial zur Authentifizierung bei Adobe Experience Platform , um erfolgreich Aufrufe an Platform APIs. Durch Abschluss des Authentifizierungs-Tutorials werden die Werte für die einzelnen erforderlichen Header in allen Experience Platform-API-Aufrufen bereitgestellt, wie unten dargestellt:
{ACCESS_TOKEN}
: Ihr spezifischer Bearer-Tokenwert, der nach der Authentifizierung bereitgestellt wird.{ORG_ID}
: Ihre Organisationsberechtigungen finden Sie in Ihrer eindeutigen Adobe Experience Platform-Integration.{API_KEY}
: Ihr spezifischer API-Schlüsselwert in Ihrer eindeutigen Adobe Experience Platform-Integration.Engines können erstellt werden, indem eine POST-Anfrage an den Endpunkt /engine gesendet wird. Die erstellte Engine wird basierend auf dem Formular der verpackten Rezeptdatei konfiguriert, die als Teil der API-Anfrage enthalten sein muss.
Um eine Engine mit einer gepackten Rezeptdatei zu erstellen, die in einem Docker-Container gespeichert ist, müssen Sie die Docker-URL für die gepackte Rezeptdatei angeben.
Wenn Sie Python oder verwenden Sie die unten stehende Anforderung. Wenn Sie PySpark oder Scala verwenden, verwenden Sie das PySpark-/Scala-Anforderungsbeispiel, das sich unter dem Python/R-Beispiel befindet.
API-Format
POST /engines
Anfrage 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"
}
}
}
}'
Eigenschaft | Beschreibung |
---|---|
engine.name |
Der gewünschte Name für die Engine. Das Rezept, das dieser Engine entspricht, übernimmt diesen Wert, der in angezeigt werden soll. Data Science Workspace -Benutzeroberfläche als Rezeptnamen. |
engine.description |
Eine optionale Beschreibung für die Engine. Das Rezept, das dieser Engine entspricht, übernimmt diesen Wert, der in angezeigt werden soll. Data Science Workspace -Benutzeroberfläche als Beschreibung des Rezepts. Entfernen Sie diese Eigenschaft nicht. Lassen Sie diesen Wert eine leere Zeichenfolge sein, wenn Sie keine Beschreibung angeben möchten. |
engine.type |
Der Ausführungstyp der Engine. Dieser Wert entspricht der Sprache, in der das Docker-Bild entwickelt wird. Wenn eine Docker-URL zum Erstellen einer Engine bereitgestellt wird, type ist Python , R , PySpark , Spark (Scala) oder Tensorflow . |
artifacts.default.image.location |
Ihre {DOCKER_URL} geht hierhin. Eine vollständige Docker-URL weist die folgende Struktur auf: your_docker_host.azurecr.io/docker_image_file:version |
artifacts.default.image.name |
Ein zusätzlicher Name für die Docker-Bilddatei. Entfernen Sie diese Eigenschaft nicht. Lassen Sie diesen Wert eine leere Zeichenfolge sein, wenn Sie keinen zusätzlichen Docker-Bilddateinamen angeben möchten. |
artifacts.default.image.executionType |
Der Ausführungstyp dieser Engine. Dieser Wert entspricht der Sprache, in der das Docker-Bild entwickelt wird. Wenn eine Docker-URL zum Erstellen einer Engine bereitgestellt wird, executionType ist Python , R , PySpark , Spark (Scala) oder Tensorflow . |
PySpark anfordern
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"
}
}
}
}'
Eigenschaft | Beschreibung |
---|---|
name |
Der gewünschte Name für die Engine. Das Rezept, das dieser Engine entspricht, übernimmt den Wert, der in der Benutzeroberfläche angezeigt werden soll, als Rezeptname. |
description |
Eine optionale Beschreibung für die Engine. Das Rezept, das dieser Engine entspricht, übernimmt den Wert, der in der Benutzeroberfläche angezeigt werden soll, als Beschreibung des Rezepts. Diese Eigenschaft ist erforderlich. Wenn Sie keine Beschreibung angeben möchten, legen Sie als Wert eine leere Zeichenfolge fest. |
type |
Der Ausführungstyp der Engine. Dieser Wert entspricht der Sprache, in der das Docker-Bild auf "PySpark"basiert. |
mlLibrary |
Ein Feld, das beim Erstellen von Engines für PySpark- und Scala-Rezepte erforderlich ist. |
artifacts.default.image.location |
Der Speicherort des Docker-Images, mit dem eine Docker-URL verknüpft ist. |
artifacts.default.image.executionType |
Der Ausführungstyp der Engine. Dieser Wert entspricht der Sprache, in der das Docker-Bild auf "Spark"basiert. |
Anforderungsskala
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"
}
}
}
}'
Eigenschaft | Beschreibung |
---|---|
name |
Der gewünschte Name für die Engine. Das Rezept, das dieser Engine entspricht, übernimmt den Wert, der in der Benutzeroberfläche angezeigt werden soll, als Rezeptname. |
description |
Eine optionale Beschreibung für die Engine. Das Rezept, das dieser Engine entspricht, übernimmt den Wert, der in der Benutzeroberfläche angezeigt werden soll, als Beschreibung des Rezepts. Diese Eigenschaft ist erforderlich. Wenn Sie keine Beschreibung angeben möchten, legen Sie als Wert eine leere Zeichenfolge fest. |
type |
Der Ausführungstyp der Engine. Dieser Wert entspricht der Sprache, in der das Docker-Bild auf "Spark"basiert. |
mlLibrary |
Ein Feld, das beim Erstellen von Engines für PySpark- und Scala-Rezepte erforderlich ist. |
artifacts.default.image.location |
Der Speicherort des Docker-Images, mit dem eine Docker-URL verknüpft ist. |
artifacts.default.image.executionType |
Der Ausführungstyp der Engine. Dieser Wert entspricht der Sprache, in der das Docker-Bild auf "Spark"basiert. |
Antwort
Eine erfolgreiche Antwort gibt eine Payload zurück, die die Details der neu erstellten Engine einschließlich ihrer eindeutigen Kennung (id
) enthält. Die folgende Beispielantwort ist für eine Python Engine. Die executionType
und type
-Schlüssel ändern sich basierend auf der bereitgestellten 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"
}
}
}
}
Eine erfolgreiche Antwort zeigt eine JSON-Payload mit Informationen zur neu erstellten Engine an. Die id
-Schlüssel stellt die eindeutige Engine-ID dar und ist im nächsten Tutorial zum Erstellen einer MLInstance erforderlich. Stellen Sie sicher, dass die Engine-ID gespeichert wird, bevor Sie mit den nächsten Schritten fortfahren.
Sie haben eine Engine mit der API erstellt und eine eindeutige Engine-Kennung wurde als Teil des Antworttextes abgerufen. Sie können diese Engine-Kennung im nächsten Tutorial verwenden, während Sie lernen, wie Sie Erstellen, Trainieren und Auswerten eines Modells mithilfe der API.