Criar um pipeline de recursos usando o SDK de criação de modelo

A Adobe Experience Platform permite que você crie e crie pipelines de recursos personalizados para executar engenharia de recursos em escala por meio do Tempo de Execução da Sensei Machine Learning Framework (a seguir denominado "Tempo de execução").

Este documento descreve as várias classes encontradas em um pipeline de recursos e fornece um tutorial passo a passo para criar um pipeline de recursos personalizado usando o SDK de criação de modelo no PySpark.

O fluxo de trabalho a seguir ocorre quando um pipeline de recursos é executado:

1. A fórmula carrega o conjunto de dados em um pipeline.
2. A transformação de recursos é feita no conjunto de dados e gravada de volta na Adobe Experience Platform.
3. Os dados transformados são carregados para treinamento.
4. O pipeline do recurso define os estágios com o Gradient Boosting Regressor como o modelo escolhido.
5. O pipeline é usado para ajustar os dados de treinamento e o modelo treinado é criado.
6. O modelo é transformado com o conjunto de dados de pontuação.
7. Colunas interessantes da saída são então selecionadas e salvas em Experience Platform com os dados associados.

Introdução

Para executar uma fórmula em qualquer organização, é necessário o seguinte:

• Um conjunto de dados de entrada.
• O Schema do conjunto de dados.
• Um schema transformado e um conjunto de dados vazio com base nesse schema.
• Um schema de saída e um conjunto de dados vazio com base nesse schema.

Todos os conjuntos de dados acima precisam ser carregados na interface do usuário Platform. Para configurar isso, use o script bootstrap fornecido pelo Adobe.

Classes de pipeline de recurso

A tabela a seguir descreve as principais classes abstratas que devem ser estendidas para criar um pipeline de recursos:

Classe abstrata	Descrição
DataLoader	Uma classe DataLoader fornece implementação para a recuperação de dados de entrada.
DatasetTransformer	Uma classe DatasetTransformer fornece implementações para transformar o conjunto de dados de entrada. Você pode optar por não fornecer uma classe DatasetTransformer e implementar sua lógica de engenharia de recursos na classe FeaturePipelineFactory.
FeaturePipelineFactory	Uma classe FeaturePipelineFactory cria um Spark Pipeline que consiste em uma série de Spark Transformers para executar engenharia de recursos. Você pode optar por não fornecer uma classe FeaturePipelineFactory e implementar sua lógica de engenharia de recursos na classe DatasetTransformer.
DataSaver	Uma classe DataSaver fornece a lógica para o armazenamento de um conjunto de dados de recurso.

Quando um trabalho de Pipeline de recurso é iniciado, o Tempo de execução primeiro executa o DataLoader para carregar dados de entrada como um DataFrame e, em seguida, modifica o DataFrame executando DatasetTransformer, FeaturePipelineFactory ou ambos. Por fim, o conjunto de dados de recursos resultante é armazenado por meio do DataSaver.

O diagrama a seguir mostra a ordem de execução do Tempo de execução:

Implemente as classes do Feature Pipeline

As seções a seguir fornecem detalhes e exemplos sobre a implementação das classes necessárias para um Recurso Pipeline.

Definir variáveis no arquivo JSON de configuração

O arquivo JSON de configuração consiste em pares de valores chave e destina-se a especificar quaisquer variáveis a serem posteriormente definidas durante o tempo de execução. Esses pares de valores chave podem definir propriedades como local do conjunto de dados de entrada, ID do conjunto de dados de saída, ID do locatário, cabeçalhos de coluna e assim por diante.

O exemplo a seguir demonstra os pares de valores chave encontrados em um arquivo de configuração:

Exemplo de JSON de configuração

[
    {
        "name": "fp",
        "parameters": [
            {
                "key": "dataset_id",
                "value": "000"
            },
            {
                "key": "featureDatasetId",
                "value": "111"
            },
            {
                "key": "tenantId",
                "value": "_tenantid"
            }
        ]
    }
]

Você pode acessar o JSON de configuração por meio de qualquer método de classe que defina config_properties como um parâmetro. Por exemplo:

PySpark

dataset_id = str(config_properties.get(dataset_id))

Consulte o arquivo pipeline.json fornecido pela Data Science Workspace para obter um exemplo mais detalhado de configuração.

Preparar os dados de entrada com DataLoader

O DataLoader é responsável pela recuperação e filtragem de dados de entrada. Sua implementação do DataLoader deve estender a classe abstrata DataLoader e substituir o método abstrato load.

O exemplo a seguir recupera um conjunto de dados Platform por ID e o retorna como um DataFrame, onde a ID do conjunto de dados (dataset_id) é uma propriedade definida no arquivo de configuração.

Exemplo de PySpark

# PySpark

from pyspark.sql.types import StringType, TimestampType
from pyspark.sql.functions import col, lit, struct
import logging

class MyDataLoader(DataLoader):
    def load_dataset(config_properties, spark, tenant_id, dataset_id):
    PLATFORM_SDK_PQS_PACKAGE = "com.adobe.platform.query"
    PLATFORM_SDK_PQS_INTERACTIVE = "interactive"

    service_token = str(spark.sparkContext.getConf().get("ML_FRAMEWORK_IMS_ML_TOKEN"))
    user_token = str(spark.sparkContext.getConf().get("ML_FRAMEWORK_IMS_TOKEN"))
    org_id = str(spark.sparkContext.getConf().get("ML_FRAMEWORK_IMS_ORG_ID"))
    api_key = str(spark.sparkContext.getConf().get("ML_FRAMEWORK_IMS_CLIENT_ID"))

    dataset_id = str(config_properties.get(dataset_id))

    for arg in ['service_token', 'user_token', 'org_id', 'dataset_id', 'api_key']:
        if eval(arg) == 'None':
            raise ValueError("%s is empty" % arg)

    query_options = get_query_options(spark.sparkContext)

    pd = spark.read.format(PLATFORM_SDK_PQS_PACKAGE) \
        .option(query_options.userToken(), user_token) \
        .option(query_options.serviceToken(), service_token) \
        .option(query_options.imsOrg(), org_id) \
        .option(query_options.apiKey(), api_key) \
        .option(query_options.mode(), PLATFORM_SDK_PQS_INTERACTIVE) \
        .option(query_options.datasetId(), dataset_id) \
        .load()
    pd.show()

    # Get the distinct values of the dataframe
    pd = pd.distinct()

    # Flatten the data
    if tenant_id in pd.columns:
        pd = pd.select(col(tenant_id + ".*"))

    return pd

Transformar um conjunto de dados com DatasetTransformer

Um DatasetTransformer fornece a lógica para transformar um DataFrame de entrada e retorna um DataFrame derivado novo. Essa classe pode ser implementada para trabalhar em conjunto com um FeaturePipelineFactory, funcionar como o único componente de engenharia de recursos ou você pode optar por não implementar essa classe.

O exemplo a seguir estende a classe DatasetTransformer:

Exemplo de PySpark

# PySpark

from sdk.dataset_transformer import DatasetTransformer
from pyspark.ml.feature import StringIndexer
from pyspark.sql.types import IntegerType
from pyspark.sql.functions import unix_timestamp, from_unixtime, to_date, lit, lag, udf, date_format, lower, col, split, explode
from pyspark.sql import Window
from .helper import setupLogger

class MyDatasetTransformer(DatasetTransformer):
    logger = setupLogger(__name__)

    def transform(self, config_properties, dataset):
        tenant_id = str(config_properties.get("tenantId"))

        # Flatten the data
        if tenant_id in dataset.columns:
            self.logger.info("Flatten the data before transformation")
            dataset = dataset.select(col(tenant_id + ".*"))
            dataset.show()

        # Convert isHoliday boolean value to Int
        # Rename the column to holiday and drop isHoliday
        pd = dataset.withColumn("holiday", col("isHoliday").cast(IntegerType())).drop("isHoliday")
        pd.show()

        # Get the week and year from date
        pd = pd.withColumn("week", date_format(to_date("date", "MM/dd/yy"), "w").cast(IntegerType()))
        pd = pd.withColumn("year", date_format(to_date("date", "MM/dd/yy"), "Y").cast(IntegerType()))

        # Convert the date to TimestampType
        pd = pd.withColumn("date", to_date(unix_timestamp(pd["date"], "MM/dd/yy").cast("timestamp")))

        # Convert categorical data
        indexer = StringIndexer(inputCol="storeType", outputCol="storeTypeIndex")
        pd = indexer.fit(pd).transform(pd)

        # Get the WeeklySalesAhead and WeeklySalesLag column values
        window = Window.orderBy("date").partitionBy("store")
        pd = pd.withColumn("weeklySalesLag", lag("weeklySales", 1).over(window)).na.drop(subset=["weeklySalesLag"])
        pd = pd.withColumn("weeklySalesAhead", lag("weeklySales", -1).over(window)).na.drop(subset=["weeklySalesAhead"])
        pd = pd.withColumn("weeklySalesScaled", lag("weeklySalesAhead", -1).over(window)).na.drop(subset=["weeklySalesScaled"])
        pd = pd.withColumn("weeklySalesDiff", (pd['weeklySales'] - pd['weeklySalesLag'])/pd['weeklySalesLag'])

        pd = pd.na.drop()
        self.logger.debug("Transformed dataset count is %s " % pd.count())

        # return transformed dataframe
        return pd

Recursos de dados do engenheiro com FeaturePipelineFactory

Um FeaturePipelineFactory permite implementar sua lógica de engenharia de recursos definindo e encadeando uma série de Transformadores Spark através de um Spark Pipeline. Essa classe pode ser implementada para trabalhar em cooperação com um DatasetTransformer, funcionar como o único componente de engenharia de recursos ou você pode optar por não implementar essa classe.

O exemplo a seguir estende a classe FeaturePipelineFactory:

Exemplo de PySpark

# PySpark

from pyspark.ml import Pipeline
from pyspark.ml.regression import GBTRegressor
from pyspark.ml.feature import VectorAssembler

import numpy as np

from sdk.pipeline_factory import PipelineFactory

class MyFeaturePipelineFactory(FeaturePipelineFactory):

    def apply(self, config_properties):
        if config_properties is None:
            raise ValueError("config_properties parameter is null")

        tenant_id = str(config_properties.get("tenantId"))
        input_features = str(config_properties.get("ACP_DSW_INPUT_FEATURES"))

        if input_features is None:
            raise ValueError("input_features parameter is null")
        if input_features.startswith(tenant_id):
            input_features = input_features.replace(tenant_id + ".", "")

        learning_rate = float(config_properties.get("learning_rate"))
        n_estimators = int(config_properties.get("n_estimators"))
        max_depth = int(config_properties.get("max_depth"))

        feature_list = list(input_features.split(","))
        feature_list.remove("date")
        feature_list.remove("storeType")

        cols = np.array(feature_list)

        # Gradient-boosted tree estimator
        gbt = GBTRegressor(featuresCol='features', labelCol='weeklySalesAhead', predictionCol='prediction',
                       maxDepth=max_depth, maxBins=n_estimators, stepSize=learning_rate)

        # Assemble the fields to a vector
        assembler = VectorAssembler(inputCols=cols, outputCol="features")

        # Construct the pipeline
        pipeline = Pipeline(stages=[assembler, gbt])

        return pipeline

    def train(self, config_properties, dataframe):
        pass

    def score(self, config_properties, dataframe, model):
        pass

    def getParamMap(self, config_properties, sparkSession):
        return None

Armazenar seu conjunto de dados de recursos com o DataSaver

O DataSaver é responsável por armazenar seus conjuntos de dados de recursos resultantes em um local de armazenamento. Sua implementação do DataSaver deve estender a classe abstrata DataSaver e substituir o método abstrato save.

O exemplo a seguir estende a classe DataSaver que armazena dados para um conjunto de dados Platform por ID, onde a ID do conjunto de dados (featureDatasetId) e a ID do locatário (tenantId) são propriedades definidas na configuração.

Exemplo de PySpark

# PySpark

from sdk.data_saver import DataSaver
from pyspark.sql.types import StringType, TimestampType
from pyspark.sql.functions import col, lit, struct


class MyDataSaver(DataSaver):
    def save(self, configProperties, data_feature):

        # Spark context
        sparkContext = data_features._sc

        # preliminary checks
        if configProperties is None:
            raise ValueError("configProperties parameter is null")
        if data_features is None:
            raise ValueError("data_features parameter is null")
        if sparkContext is None:
            raise ValueError("sparkContext parameter is null")

        # prepare variables
        timestamp = "2019-01-01 00:00:00"
        output_dataset_id = str(
            configProperties.get("featureDatasetId"))
        tenant_id = str(
            configProperties.get("tenantId"))
        service_token = str(
            sparkContext.getConf().get("ML_FRAMEWORK_IMS_ML_TOKEN"))
        user_token = str(
            sparkContext.getConf().get("ML_FRAMEWORK_IMS_TOKEN"))
        org_id = str(
            sparkContext.getConf().get("ML_FRAMEWORK_IMS_ORG_ID"))
        api_key = str(
            sparkContext.getConf().get("ML_FRAMEWORK_IMS_CLIENT_ID"))

        # validate variables
        for arg in ['output_dataset_id', 'tenant_id', 'service_token', 'user_token', 'org_id', 'api_key']:
            if eval(arg) == 'None':
                raise ValueError("%s is empty" % arg)

        # create and prepare DataFrame with valid columns
        output_df = data_features.withColumn("date", col("date").cast(StringType()))
        output_df = output_df.withColumn(tenant_id, struct(col("date"), col("store"), col("features")))
        output_df = output_df.withColumn("timestamp", lit(timestamp).cast(TimestampType()))
        output_df = output_df.withColumn("_id", lit("empty"))
        output_df = output_df.withColumn("eventType", lit("empty"))

        # store data into dataset
        output_df.select(tenant_id, "_id", "eventType", "timestamp") \
            .write.format("com.adobe.platform.dataset") \
            .option('orgId', org_id) \
            .option('serviceToken', service_token) \
            .option('userToken', user_token) \
            .option('serviceApiKey', api_key) \
            .save(output_dataset_id)

Especifique os nomes de classe implementados no arquivo de aplicativo

Agora que suas classes de pipeline de recursos estão definidas e implementadas, você deve especificar os nomes de suas classes no arquivo YAML do aplicativo.

Os exemplos a seguir especificam nomes de classe implementados:

Exemplo de PySpark

#Name of the class which contains implementation to get the input data.
feature.dataLoader: InputDataLoaderForFeaturePipeline

#Name of the class which contains implementation to get the transformed data.
feature.dataset.transformer: MyDatasetTransformer

#Name of the class which contains implementation to save the transformed data.
feature.dataSaver: DatasetSaverForTransformedData

#Name of the class which contains implementation to get the training data
training.dataLoader: TrainingDataLoader

#Name of the class which contains pipeline. It should implement PipelineFactory.scala
pipeline.class: TrainPipeline

#Name of the class which contains implementation for evaluation metrics.
evaluator: Evaluator
evaluateModel: True

#Name of the class which contains implementation to get the scoring data.
scoring.dataLoader: ScoringDataLoader

#Name of the class which contains implementation to save the scoring data.
scoring.dataSaver: MyDatasetSaver

Crie seu Mecanismo de pipeline de recursos usando a API

Agora que você criou seu pipeline de recursos, é necessário criar uma imagem Docker para fazer uma chamada para os pontos finais do pipeline de recursos na API Sensei Machine Learning. Você precisa de um URL de imagem do Docker para fazer uma chamada para os pontos finais do pipeline de recursos.

Opcionalmente, você também pode usar a seguinte coleção Postman para ajudar a concluir o fluxo de trabalho da API do pipeline de recursos:

https://www.postman.com/collections/c5fc0d1d5805a5ddd41a

Criar um mecanismo de pipeline de recursos

Depois de ter a localização da imagem do Docker, você pode criar um mecanismo de pipeline de recursos usando a API Sensei Machine Learning executando um POST para /engines. A criação bem-sucedida de um mecanismo de pipeline de recursos fornece um identificador exclusivo do Mecanismo (id). Salve esse valor antes de continuar.

Criar uma instância MLI

Usando seu engineID recém-criado, é necessário criar um MLIposition, fazendo uma solicitação de POST para o terminal /mlInstance. Uma resposta bem-sucedida retorna uma carga contendo os detalhes da MLIntent recém-criada, incluindo seu identificador exclusivo (id) usado na próxima chamada da API.

Criar um Experimento

Em seguida, é necessário criar um Experimento. Para criar um Experimento, é necessário ter seu identificador exclusivo MLIposition (id) e fazer uma solicitação POST ao terminal /experiment. Uma resposta bem-sucedida retorna uma carga contendo os detalhes do Experimento recém-criado, incluindo seu identificador exclusivo (id) usado na próxima chamada de API.

Especificar a tarefa do pipeline do recurso de execução de Experimento

Depois de criar um Experimento, é necessário alterar o modo do Experimento para featurePipeline. Para alterar o modo, faça um POST adicional para experiments/{EXPERIMENT_ID}/runs com seu EXPERIMENT_ID e, no corpo, envie { "mode":"featurePipeline"} para especificar uma execução de teste do pipeline de recursos.

Depois de concluído, faça uma solicitação de GET para /experiments/{EXPERIMENT_ID} para recuperar o status do experimento e aguarde a atualização do status do Experimento ser concluída.

Especificar a tarefa de treinamento de execução do Experimento

Em seguida, você precisa especificar a tarefa de execução de treinamento. Faça um POST para experiments/{EXPERIMENT_ID}/runs e, no corpo, defina o modo para train e envie uma matriz de tarefas que contenha seus parâmetros de treinamento. Uma resposta bem-sucedida retorna uma carga contendo os detalhes do Experimento solicitado.

Depois de concluído, faça uma solicitação de GET para /experiments/{EXPERIMENT_ID} para recuperar o status do experimento e aguarde a atualização do status do Experimento ser concluída.

Especificar a tarefa de pontuação de execução do Experimento

Após uma execução de treinamento bem-sucedida, é necessário especificar a tarefa de execução de pontuação. Faça um POST para experiments/{EXPERIMENT_ID}/runs e, no corpo, defina o atributo mode como "score". Isso start a execução do seu Experimento de pontuação.

Depois de concluído, faça uma solicitação de GET para /experiments/{EXPERIMENT_ID} para recuperar o status do experimento e aguarde a atualização do status do Experimento ser concluída.

Quando a pontuação for concluída, o pipeline do recurso deverá estar operacional.

Próximas etapas

Ao ler esse documento, você criou um pipeline de recursos usando o SDK de criação de modelo, criou uma imagem do Docker e usou o URL de imagem do Docker para criar um Modelo de pipeline de recursos usando a API Sensei Machine Learning. Agora você está pronto para continuar a transformar conjuntos de dados e extrair recursos de dados em escala usando Sensei Machine Learning API.