Créer un pipeline de fonctionnalités à l’aide du SDK de création de modèles

Adobe Experience Platform vous permet de créer des pipelines de fonctionnalités personnalisés pour concevoir des fonctionnalités à grande échelle via l’exécution du framework de machine learning de Sensei (ci-après appelée « exécution »).

Ce document décrit les différentes classes d’un pipeline de fonctionnalités et fournit un tutoriel détaillé sur la création d’un pipeline de fonctionnalités personnalisé à l’aide de la SDK de création de modèles dans PySpark.

Le workflow suivant se produit lorsqu’un pipeline de fonctionnalité est exécuté :

Commencer

Pour exécuter une recette dans n’importe quelle organisation, les éléments suivants sont requis :

Tous les jeux de données ci-dessus doivent être chargés vers l’interface utilisateur de Experience Platform. Pour configurer ce paramètre, utilisez le script de bootstrap fourni par Adobe.

Classes de pipeline de fonctionnalités

Le tableau suivant décrit les principales classes abstraites que vous devez étendre pour créer un pipeline de fonctionnalités :

Lorsqu’une tâche de Pipeline de fonctionnalités est lancée, Runtime exécute d’abord le DataLoader pour charger les données d’entrée sous la forme d’un DataFrame, puis modifie le DataFrame en exécutant le DatasetTransformer, le FeaturePipelineFactory ou les deux. Enfin, le jeu de données de fonctionnalités obtenu est conservé dans le DataSaver.

L’organigramme suivant montre l’ordre d’exécution du Runtime :

Mise en œuvre de vos classes de pipeline de fonctionnalités implement-your-feature-pipeline-classes

Les sections suivantes fournissent des détails et des exemples sur la mise en œuvre des classes obligatoires pour un pipeline de fonctionnalités.

Définition de variables dans le fichier de configuration JSON define-variables-in-the-configuration-json-file

Le fichier JSON de configuration se compose de paires clé-valeur et est conçu pour que vous puissiez préciser des variables à définir plus tard pendant l’exécution. Ces paires clé-valeur peuvent définir des propriétés telles que l’emplacement des jeux de données d’entrée, l’identifiant du jeu de données de sortie, l’identifiant du client, des en-têtes de colonne, etc.

L’exemple suivant illustre les paires clé-valeur trouvées dans un fichier de configuration :

Exemple de configuration JSON

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

Vous pouvez accéder à la configuration JSON à l’aide de n’importe quelle méthode de classe qui définit config_properties comme paramètre. Par exemple :

PySpark

dataset_id = str(config_properties.get(dataset_id))

Consultez le fichier pipeline.json fourni par le Workspace de science des données pour un exemple de configuration plus détaillé.

Préparation des données d’entrée avec DataLoader prepare-the-input-data-with-dataloader

DataLoader est responsable de la récupération et du filtrage des données d’entrée. Votre mise en œuvre de DataLoader doit étendre la classe abstraite DataLoader et remplacer la méthode abstraite load.

L’exemple suivant récupère un jeu de données Experience Platform par ID et le renvoie en tant que DataFrame, où l’ID du jeu de données (dataset_id) est une propriété définie dans le fichier de configuration.

Exemple 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

Transformation d’un jeu de données à l’aide de DatasetTransformer transform-a-dataset-with-datasettransformer

Un DatasetTransformer fournit la logique de transformation d’un DataFrame d’entrée et renvoie un nouveau DataFrame dérivé. Cette classe peut être mise en œuvre de manière à travailler soit en coopération avec une FeaturePipelineFactory, soit comme composant d d’ingénierie de fonctionnalité unique. Vous pouvez également choisir de ne pas mettre en œuvre cette classe.

L’exemple suivant étend la classe DatasetTransformer :

Exemple 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

Conception de fonctionnalités de données avec FeaturePipelineFactory engineer-data-features-with-featurepipelinefactory

Une FeaturePipelineFactory vous permet de mettre en œuvre votre logique d’ingénierie de fonctionnalités en définissant et en associant une série de Spark Transformers à travers un pipeline Spark. Cette classe peut être mise en œuvre de manière à travailler soit en coopération avec un DatasetTransformer, soit comme composant d’ingénierie de fonctionnalité unique. Vous pouvez également choisir de ne pas mettre en œuvre cette classe.

L’exemple suivant étend la classe FeaturePipelineFactory :

Exemple 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

Stockage du jeu de données de votre fonctionnalité avec DataSaver store-your-feature-dataset-with-datasaver

DataSaver est chargé de stocker vos jeux de données de fonctionnalités résultants dans un emplacement de stockage. Votre mise en œuvre de DataSaver doit étendre la classe abstraite DataSaver et remplacer la méthode abstraite save.

L’exemple suivant étend la classe DataSaver qui stocke les données dans un jeu de données Experience Platform par ID, où l’ID du jeu de données (featureDatasetId) et l’ID du client (tenantId) sont des propriétés définies dans la configuration .

Exemple 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)

Précision des noms de classe mis en œuvre dans le fichier d’application specify-your-implemented-class-names-in-the-application-file

Maintenant que vos classes de pipeline de fonctionnalités sont définies et implémentées, vous devez spécifier les noms de vos classes dans le fichier YAML de l’application.

Les exemples suivants spécifient les noms de classe implémentés :

Exemple 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

Créer votre moteur de pipeline de fonctionnalité à l’aide de l’API create-feature-pipeline-engine-api

Maintenant que vous avez créé votre pipeline de fonctionnalité, vous devez créer une image Docker pour effectuer un appel aux points d’entrée du pipeline de fonctionnalité dans l’API Sensei Machine Learning. Vous avez besoin d’une URL d’image Docker pour effectuer un appel aux points d’entrée du pipeline de fonctionnalités.

Vous pouvez également utiliser la collection Postman suivante pour vous aider à terminer le workflow de l’API de pipeline de fonctionnalités :

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

Créer un moteur de pipeline de fonctionnalité create-engine-api

Une fois que vous disposez de l’emplacement de votre image Docker, vous pouvez créer un moteur de pipeline de fonctionnalités à l’aide de l’API Sensei Machine Learning en effectuant une opération POST vers /engines. La création réussie d’un moteur de pipeline de fonctionnalité vous fournit un identifiant unique de moteur (id). Veillez à enregistrer cette valeur avant de continuer.

Création d’une instance MLInstance create-mlinstance

À l’aide de l’engineID que vous venez de créer, vous devez créer une instance MLIstance en adressant une requête POST au point d’entrée /mlInstance. Une réponse réussie renvoie un payload contenant les détails de l’instance MLI nouvellement créée, y compris son identifiant unique (id) utilisé dans l’appel API suivant.

Création d’une expérience create-experiment

Ensuite, vous devez créer une expérience. Pour créer une expérience, vous devez disposer de votre identifiant unique MLIstance (id) et effectuer une requête POST vers le point d’entrée /experiment. Une réponse réussie renvoie un payload contenant les détails de l’expérience nouvellement créée, y compris son identifiant unique (id) utilisé dans l’appel API suivant.

Spécifiez la tâche de pipeline de fonctionnalité Exécution d’expérience specify-feature-pipeline-task

Après avoir créé une expérience, vous devez changer le mode de l’expérience en featurePipeline. Pour changer de mode, effectuez une opération POST supplémentaire pour experiments/{EXPERIMENT_ID}/runs avec votre EXPERIMENT_ID et, dans le corps, envoyez des { "mode":"featurePipeline"} pour spécifier l’exécution d’une expérience de pipeline de fonctionnalité.

Une fois l’opération terminée, envoyez une requête GET à /experiments/{EXPERIMENT_ID} pour récupérer le statut de l’expérience et attendez que le statut de l’expérience soit mis à jour pour terminer.

Spécifier la tâche de formation Exécution de l’expérience training

Ensuite, vous devez spécifier la tâche d’exécution de formation. Effectuez une instruction POST sur experiments/{EXPERIMENT_ID}/runs et, dans le corps du texte, définissez le mode sur train et envoyez un tableau de tâches contenant vos paramètres d’apprentissage. Une réponse réussie renvoie un payload contenant les détails de l’expérience interrogée.

Une fois l’opération terminée, envoyez une requête GET à /experiments/{EXPERIMENT_ID} pour récupérer le statut de l’expérience et attendez que le statut de l’expérience soit mis à jour pour terminer.

Spécifier la tâche de notation de l’exécution d’expérience scoring

Après une exécution d’entraînement réussie, vous devez spécifier la tâche d’exécution de notation. Définissez une instruction POST sur experiments/{EXPERIMENT_ID}/runs et, dans le corps du texte, définissez l’attribut mode sur « score ». Cela lance l’exécution de l’expérience de notation.

Une fois l’opération terminée, envoyez une requête GET à /experiments/{EXPERIMENT_ID} pour récupérer le statut de l’expérience et attendez que le statut de l’expérience soit mis à jour pour terminer.

Une fois la notation terminée, votre pipeline de fonctionnalités doit être opérationnel.

Étapes suivantes next-steps

En lisant ce document, vous avez créé un pipeline de fonctionnalités à l’aide du SDK de création de modèles, vous avez créé une image Docker et utilisé l’URL de l’image Docker pour créer un modèle de pipeline de fonctionnalités à l’aide de l’API Sensei Machine Learning. Vous êtes maintenant prêt à continuer à transformer les jeux de données et à extraire les fonctionnalités de données à grande échelle à l’aide de l’Sensei Machine Learning API .