Este tutorial cubre el proceso de publicación de un modelo como servicio mediante Sensei Machine Learning API.
Este tutorial requiere una comprensión práctica de Adobe Experience Platform Data Science Workspace. Antes de comenzar este tutorial, consulte la Resumen de Data Science Workspace para una introducción de alto nivel al servicio.
Para seguir este tutorial, debe tener un motor ML, una instancia ML y un experimento existentes. Para ver los pasos sobre cómo crearlos en la API, consulte el tutorial sobre importación de una fórmula empaquetada.
Por último, antes de iniciar este tutorial, consulte la introducción de la guía para desarrolladores para obtener información importante que necesita conocer a fin de realizar llamadas correctamente a Sensei Machine Learning API, incluidos los encabezados requeridos utilizados en este tutorial:
{ACCESS_TOKEN}
{ORG_ID}
{API_KEY}
Todas las solicitudes de POST, PUT y PATCH requieren un encabezado adicional:
En la tabla siguiente se describen algunos términos comunes utilizados en este tutorial:
Término | Definición |
---|---|
Instancia de aprendizaje automático (instancia ML) | Una instancia de un Sensei Motor para un inquilino en particular, que contiene datos, parámetros y Sensei código. |
Experimento | Una entidad paraguas para albergar ejecuciones de experimentos de formación, ejecuciones de experimentos de puntuación o ambas. |
Experimento programado | Término para describir la automatización de la formación o la puntuación de las ejecuciones de experimentos, regidas por una programación definida por el usuario. |
Ejecución del experimento | Una instancia concreta de experimentos de formación o puntuación. Varias ejecuciones de experimentos de un experimento concreto pueden diferir en los valores del conjunto de datos utilizados para el aprendizaje o la puntuación. |
Modelo entrenado | Un modelo de aprendizaje automático creado mediante el proceso de experimentación e ingeniería de funciones antes de llegar a un modelo validado, evaluado y finalizado. |
Modelo publicado | Se llegó a un modelo finalizado y con versiones después del entrenamiento, la validación y la evaluación. |
Servicio de aprendizaje automático (servicio ML) | Instancia de ML implementada como servicio para admitir solicitudes bajo demanda de formación y puntuación mediante un extremo de API. También se puede crear un servicio XML utilizando ejecuciones de experimento formadas existentes. |
Al publicar un experimento de formación Ejecutar como servicio ML, puede programar la puntuación proporcionando detalles para la puntuación del experimento Ejecutar la carga útil de una solicitud de POST. Esto resulta en la creación de una entidad de Experimento programada para la puntuación.
Formato de API
POST /mlServices
Solicitud
curl -X POST
https://platform.adobe.io/data/sensei/mlServices
-H 'Authorization: {ACCESS_TOKEN}'
-H 'x-api-key: {API_KEY}'
-H 'x-gw-ims-org-id: {ORG_ID}'
-H 'Content-Type: application/json'
-d '{
"name": "Service name",
"description": "Service description",
"trainingExperimentId": "c4155146-b38f-4a8b-86d8-1de3838c8d87",
"trainingExperimentRunId": "5c5af39c73fcec153117eed1",
"scoringDataSetId": "5c5af39c73fcec153117eed1",
"scoringTimeframe": "20000",
"scoringSchedule": {
"startTime": "2019-04-09T00:00",
"endTime": "2019-04-10T00:00",
"cron": "10 * * * *"
}
}'
Propiedad | Descripción |
---|---|
mlInstanceId |
Identificación de instancia ML existente, la ejecución de experimento de formación utilizada para crear el servicio ML debe corresponder a esta instancia ML concreta. |
trainingExperimentId |
Identificación del experimento correspondiente a la identificación de la instancia de ML. |
trainingExperimentRunId |
Se utilizará una ejecución de experimento de formación concreta para publicar el servicio XML. |
scoringDataSetId |
Identificación que hace referencia al conjunto de datos específico que se utilizará para la puntuación programada en Ejecuciones de experimento. |
scoringTimeframe |
Un valor entero que representa los minutos para filtrar los datos que se utilizarán para puntuar las ejecuciones de experimento. Por ejemplo, un valor de 10080 significa que se utilizarán los datos de los últimos 10080 minutos o 168 horas para cada ejecución de experimento de puntuación programada. Observe que un valor de 0 no filtrará los datos, todos los datos del conjunto de datos se utilizarán para la puntuación. |
scoringSchedule |
Contiene detalles sobre las ejecuciones de experimentos de puntuación programadas. |
scoringSchedule.startTime |
Fecha y hora que indica cuándo iniciar la puntuación. |
scoringSchedule.endTime |
Fecha y hora que indica cuándo iniciar la puntuación. |
scoringSchedule.cron |
Valor Cron que indica el intervalo con el que se va a puntuar la ejecución del experimento. |
Respuesta
Una respuesta correcta devuelve los detalles del servicio XML recién creado, incluido su exclusivo id
y el scoringExperimentId
para su correspondiente Experimento de puntuación.
{
"id": "string",
"name": "string",
"description": "string",
"mlInstanceId": "string",
"trainingExperimentId": "string",
"trainingExperimentRunId": "string",
"scoringExperimentId": "string",
"scoringDataSetId": "string",
"scoringTimeframe": "integer",
"scoringSchedule": {
"startTime": "2019-03-13T00:00",
"endTime": "2019-03-14T00:00",
"cron": "30 * * * *"
},
"created": "2019-04-08T14:45:25.981Z",
"updated": "2019-04-08T14:45:25.981Z"
}
Según el caso de uso y los requisitos específicos, la creación de un servicio XML con una instancia XML es flexible en términos de programación de la formación y la puntuación de las ejecuciones de experimentos. Este tutorial analizará los casos específicos en los que:
Tenga en cuenta que se puede crear un servicio XML con una instancia XML sin programar ningún experimento de formación o puntuación. Estos servicios XML crearán entidades de experimento normales y una única ejecución de experimento para formación y puntuación.
Puede crear un servicio XML publicando una instancia XML con ejecuciones de experimento programadas para puntuación, lo que creará una entidad de experimento normal para formación. Se genera una ejecución de experimento de formación que se utilizará en todas las ejecuciones de experimento de puntuación programadas. Asegúrese de que dispone de mlInstanceId
, trainingDataSetId
, y scoringDataSetId
necesario para la creación del servicio XML, y que existen y son valores válidos.
Formato de API
POST /mlServices
Solicitud
curl -X POST
https://platform.adobe.io/data/sensei/mlServices
-H 'Authorization: {ACCESS_TOKEN}'
-H 'x-api-key: {API_KEY}'
-H 'x-gw-ims-org-id: {ORG_ID}'
-H 'x-sandbox-name: {SANDBOX_NAME}'
-d '{
"name": "Service name",
"description": "Service description",
"mlInstanceId": "c4155146-b38f-4a8b-86d8-1de3838c8d87",
"trainingDataSetId": "5c5af39c73fcec153117eed1",
"trainingTimeframe": "10000",
"scoringDataSetId": "5c5af39c73fcec153117eed1",
"scoringTimeframe": "20000",
"scoringSchedule": {
"startTime": "2019-04-09T00:00",
"endTime": "2019-04-10T00:00",
"cron": "10 * * * *"
}
}'
Clave JSON | Descripción |
---|---|
mlInstanceId |
Identificación de instancia de ML existente, que representa la instancia de ML utilizada para crear el servicio ML. |
trainingDataSetId |
Identificación que hace referencia al conjunto de datos específico que se utilizará para el experimento de formación. |
trainingTimeframe |
Un valor entero que representa los minutos para filtrar los datos que se utilizarán para el experimento de formación. Por ejemplo, un valor de "10080" significa que se utilizarán los datos de los últimos 10080 minutos o 168 horas para la ejecución del experimento de formación. Observe que un valor de "0" no filtrará datos, todos los datos del conjunto de datos se utilizarán para formación. |
scoringDataSetId |
Identificación que hace referencia al conjunto de datos específico que se utilizará para la puntuación programada en Ejecuciones de experimento. |
scoringTimeframe |
Un valor entero que representa los minutos para filtrar los datos que se utilizarán para puntuar las ejecuciones de experimento. Por ejemplo, un valor de "10080" significa que se utilizarán los datos de los últimos 10080 minutos o 168 horas para cada ejecución de experimento de puntuación programada. Observe que un valor de "0" no filtrará los datos, todos los datos del conjunto de datos se utilizarán para la puntuación. |
scoringSchedule |
Contiene detalles sobre las ejecuciones de experimentos de puntuación programadas. |
scoringSchedule.startTime |
Fecha y hora que indica cuándo iniciar la puntuación. |
scoringSchedule.endTime |
Fecha y hora que indica cuándo iniciar la puntuación. |
scoringSchedule.cron |
Valor Cron que indica el intervalo con el que se va a puntuar la ejecución del experimento. |
Respuesta
Una respuesta correcta devuelve los detalles del servicio XML recién creado. Esto incluye la función única del servicio id
, así como el trainingExperimentId
y scoringExperimentId
para sus correspondientes experimentos de formación y puntuación, respectivamente.
{
"id": "string",
"name": "string",
"description": "string",
"mlInstanceId": "string",
"trainingExperimentId": "string",
"trainingDataSetId": "string",
"trainingTimeframe": "integer",
"scoringExperimentId": "string",
"scoringDataSetId": "string",
"scoringTimeframe": "integer",
"scoringSchedule": {
"startTime": "2019-04-09T00:00",
"endTime": "2019-04-10T00:00",
"cron": "10 * * * *"
},
"created": "2019-04-09T08:58:10.956Z",
"updated": "2019-04-09T08:58:10.956Z"
}
Para publicar una instancia de ML existente como servicio ML con formación programada y ejecuciones de experimento de puntuación, debe proporcionar programaciones de formación y puntuación. Cuando se crea un servicio XML de esta configuración, también se crean entidades de experimento programadas tanto para formación como para puntuación. Tenga en cuenta que los horarios de formación y puntuación no tienen que ser los mismos. Durante la ejecución de un trabajo de puntuación, se recuperará el modelo formado más reciente producido por las ejecuciones de experimento de formación programadas y se utilizará en la ejecución de puntuación programada.
Formato de API
POST /mlServices
Solicitud
curl -X POST 'https://platform.adobe.io/data/sensei/mlServices'
-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}'
-d '{
"name": "string",
"description": "string",
"mlInstanceId": "string",
"trainingDataSetId": "string",
"trainingTimeframe": "string",
"scoringDataSetId": "string",
"scoringTimeframe": "string",
"trainingSchedule": {
"startTime": "2019-04-09T00:00",
"endTime": "2019-04-10T00:00",
"cron": "10 * * * *"
},
"scoringSchedule": {
"startTime": "2019-04-09T00:00",
"endTime": "2019-04-10T00:00",
"cron": "10 * * * *"
}
}'
Clave JSON | Descripción |
---|---|
mlInstanceId |
Identificación de instancia de ML existente, que representa la instancia de ML utilizada para crear el servicio ML. |
trainingDataSetId |
Identificación que hace referencia al conjunto de datos específico que se utilizará para el experimento de formación. |
trainingTimeframe |
Un valor entero que representa los minutos para filtrar los datos que se utilizarán para el experimento de formación. Por ejemplo, un valor de "10080" significa que se utilizarán los datos de los últimos 10080 minutos o 168 horas para la ejecución del experimento de formación. Observe que un valor de "0" no filtrará datos, todos los datos del conjunto de datos se utilizarán para formación. |
scoringDataSetId |
Identificación que hace referencia al conjunto de datos específico que se utilizará para la puntuación programada en Ejecuciones de experimento. |
scoringTimeframe |
Un valor entero que representa los minutos para filtrar los datos que se utilizarán para puntuar las ejecuciones de experimento. Por ejemplo, un valor de "10080" significa que se utilizarán los datos de los últimos 10080 minutos o 168 horas para cada ejecución de experimento de puntuación programada. Observe que un valor de "0" no filtrará los datos, todos los datos del conjunto de datos se utilizarán para la puntuación. |
trainingSchedule |
Contiene detalles sobre las ejecuciones de experimentos de formación programadas. |
scoringSchedule |
Contiene detalles sobre las ejecuciones de experimentos de puntuación programadas. |
scoringSchedule.startTime |
Fecha y hora que indica cuándo iniciar la puntuación. |
scoringSchedule.endTime |
Fecha y hora que indica cuándo iniciar la puntuación. |
scoringSchedule.cron |
Valor Cron que indica el intervalo con el que se va a puntuar la ejecución del experimento. |
Respuesta
Una respuesta correcta devuelve los detalles del servicio XML recién creado. Esto incluye la función única del servicio id
, así como el trainingExperimentId
y scoringExperimentId
de sus correspondientes experimentos de entrenamiento y puntuación, respectivamente. En la respuesta de ejemplo siguiente, la presencia de trainingSchedule
y scoringSchedule
sugiere que las entidades Experimento para formación y puntuación sean Experimentos programados.
{
"id": "string",
"name": "string",
"description": "string",
"mlInstanceId": "string",
"trainingExperimentId": "string",
"trainingDataSetId": "string",
"trainingTimeframe": "integer",
"scoringExperimentId": "string",
"scoringDataSetId": "string",,
"scoringTimeframe": "integer",
"trainingSchedule": {
"startTime": "2019-04-09T00:00",
"endTime": "2019-04-10T00:00",
"cron": "10 * * * *"
},
"scoringSchedule": {
"startTime": "2019-04-09T00:00",
"endTime": "2019-04-10T00:00",
"cron": "10 * * * *"
},
"created": "2019-04-09T08:58:10.956Z",
"updated": "2019-04-09T08:58:10.956Z"
}
Puede buscar un servicio ML existente realizando una GET
solicitud a /mlServices
y proporcionando el id
del servicio XML en la ruta.
Formato de API
GET /mlServices/{SERVICE_ID}
Parámetro | Descripción |
---|---|
{SERVICE_ID} |
La exclusiva id del servicio ML que está buscando. |
Solicitud
curl -X GET 'https://platform.adobe.io/data/sensei/mlServices/{SERVICE_ID}'
-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}'
Respuesta
Una respuesta correcta devuelve los detalles del servicio XML.
{
"id": "string",
"name": "string",
"description": "string",
"mlInstanceId": "string",
"trainingExperimentId": "string",
"trainingDataSetId": "string",
"trainingTimeframe": "integer",
"scoringExperimentId": "string",
"scoringDataSetId": "string",
"scoringTimeframe": "integer",
"trainingSchedule": {
"startTime": "2019-04-09T00:00",
"endTime": "2019-04-10T00:00",
"cron": "10 * * * *"
},
"scoringSchedule": {
"startTime": "2019-04-09T00:00",
"endTime": "2019-04-10T00:00",
"cron": "10 * * * *"
},
"created": "2019-05-13T23:46:03.478Z",
"updated": "2019-05-13T23:46:03.478Z"
}
La recuperación de diferentes servicios XML puede devolver una respuesta con más o menos pares clave-valor. La respuesta anterior es una representación de un Servicio ML con formación programada y ejecuciones de experimento de puntuación.
Si desea programar la puntuación y la formación en un servicio XML que ya se ha publicado, puede hacerlo actualizando el servicio XML existente con un PUT
solicitud de /mlServices
.
Formato de API
PUT /mlServices/{SERVICE_ID}
Parámetro | Descripción |
---|---|
{SERVICE_ID} |
La exclusiva id del servicio XML que está actualizando. |
Solicitud
La siguiente solicitud programa la formación y la puntuación de un servicio XML existente al añadir el trainingSchedule
y scoringSchedule
claves con sus respectivas startTime
, endTime
, y cron
llaves.
curl -X PUT 'https://platform.adobe.io/data/sensei/mlServices/{SERVICE_ID}'
-H 'Authorization: {ACCESS_TOKEN}'
-H 'x-api-key: {API_KEY}'
-H 'x-gw-ims-org-id: {ORG_ID}'
-H 'x-sandbox-name: {SANDBOX_NAME}'
-d '{
"name": "string",
"description": "string",
"mlInstanceId": "string",
"trainingExperimentId": "string",
"trainingDataSetId": "string",
"trainingTimeframe": "integer",
"scoringExperimentId": "string",
"scoringDataSetId": "string",
"scoringTimeframe": "integer",
"trainingSchedule": {
"startTime": "2019-04-09T00:00",
"endTime": "2019-04-11T00:00",
"cron": "20 * * * *"
},
"scoringSchedule": {
"startTime": "2019-04-09T00:00",
"endTime": "2019-04-11T00:00",
"cron": "20 * * * *"
}
}'
No intente modificar la variable startTime
en trabajos de formación y puntuación programados existentes. Si la variable startTime
debe modificarse, considere la posibilidad de publicar el mismo modelo y reprogramar los trabajos de formación y puntuación.
Respuesta
Una respuesta correcta devuelve los detalles del servicio XML actualizado.
{
"id": "string",
"name": "string",
"description": "string",
"mlInstanceId": "string",
"trainingExperimentId": "string",
"trainingDataSetId": "string",
"trainingTimeframe": "integer",
"scoringExperimentId": "string",
"scoringDataSetId": "string",
"scoringTimeframe": "integer",
"trainingSchedule": {
"startTime": "2019-04-09T00:00",
"endTime": "2019-04-11T00:00",
"cron": "20 * * * *"
},
"scoringSchedule": {
"startTime": "2019-04-09T00:00",
"endTime": "2019-04-11T00:00",
"cron": "20 * * * *"
},
"created": "2019-04-09T08:58:10.956Z",
"updated": "2019-04-09T09:43:55.563Z"
}