Erstellen einer Funktions-Pipeline mit dem Model Authoring SDK

Mit Adobe Experience Platform können Sie benutzerdefinierte Funktions-Pipelines erstellen und erstellen, um mithilfe der Sensei Machine Learning Framework Runtime (nachfolgend "Laufzeit"genannt) Funktionen bedarfsgerecht zu entwickeln.

In diesem Dokument werden die verschiedenen Klassen in einer Feature Pipeline beschrieben und ein schrittweises Tutorial zum Erstellen einer benutzerdefinierten Feature Pipeline mit dem Model Authoring SDK in PySpark bereitgestellt.

Der folgende Workflow erfolgt bei Ausführung einer Feature Pipeline:

Erste Schritte

Um ein Rezept in einer Organisation auszuführen, ist Folgendes erforderlich:

Alle oben genannten Datensätze müssen in die Platform -Benutzeroberfläche hochgeladen werden. Verwenden Sie zum Einrichten das vom Adobe bereitgestellte Bootstrap-Skript .

Feature Pipeline-Klassen

In der folgenden Tabelle werden die wichtigsten abstrakten Klassen beschrieben, die Sie erweitern müssen, um eine Funktions-Pipeline zu erstellen:

Wenn ein Feature Pipeline-Auftrag initiiert wird, führt Runtime zunächst den DataLoader aus, um Eingabedaten als DataFrame zu laden, und ändert dann den DataFrame, indem entweder DatasetTransformer, FeaturePipelineFactory oder beide ausgeführt werden. Schließlich wird der sich ergebende Funktionsdatensatz über den DataSaver gespeichert.

Das folgende Flussdiagramm zeigt die Ausführungsreihenfolge der Laufzeitumgebung:

Implementieren Ihrer Feature Pipeline-Klassen implement-your-feature-pipeline-classes

Die folgenden Abschnitte enthalten Details und Beispiele zur Implementierung der erforderlichen Klassen für eine Feature Pipeline.

Definieren der Variablen in der JSON-Konfigurationsdatei define-variables-in-the-configuration-json-file

Die JSON-Konfigurationsdatei besteht aus Schlüsselwert-Paaren und dient zum Angeben von Variablen, die später während der Laufzeit definiert werden sollen. Diese Schlüsselwert-Paare können Eigenschaften wie den Speicherort des Eingabedatasets, die ID des Ausgabedatasets, die Mandanten-ID, Spaltenüberschriften usw. definieren.

Das folgende Beispiel zeigt Schlüssel-Wert-Paare, die in einer Konfigurationsdatei gefunden werden:

JSON-Beispiel für Konfiguration

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

Sie können auf die Konfigurations-JSON über jede Klassenmethode zugreifen, die config_properties als Parameter definiert. Beispiel:

PySpark

dataset_id = str(config_properties.get(dataset_id))

Ein detaillierteres Konfigurationsbeispiel finden Sie in der Datei pipeline.json von Data Science Workspace.

Vorbereiten der Eingabedaten mit DataLoader prepare-the-input-data-with-dataloader

DataLoader ist für das Abrufen und Filtern von Eingabedaten zuständig. Ihre Implementierung von DataLoader muss die abstrakte Klasse DataLoader erweitern und die abstrakte Methode load überschreiben.

Im folgenden Beispiel wird ein Platform -Datensatz nach ID abgerufen und als DataFrame zurückgegeben, wobei die Datensatz-ID (dataset_id) eine definierte Eigenschaft in der Konfigurationsdatei ist.

PySpark-Beispiel

# 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

Transformieren eines Datensatzes mit DatasetTransformer transform-a-dataset-with-datasettransformer

Ein DatasetTransformer stellt die Logik zum Transformieren eines Eingangs-DataFrames bereit und gibt einen neuen abgeleiteten DataFrame zurück. Diese Klasse kann implementiert werden, um entweder gemeinsam mit einer FeaturePipelineFactory zu arbeiten, als einzige Funktions-Engineering-Komponente zu arbeiten, oder Sie können festlegen, dass diese Klasse nicht implementiert wird.

Im folgenden Beispiel wird die DatasetTransformer-Klasse erweitert:

PySpark-Beispiel

# 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

Engineering von Datenfunktionen mit FeaturePipelineFactory engineer-data-features-with-featurepipelinefactory

Mit einer FeaturePipelineFactory können Sie Ihre Funktions-Engineering-Logik implementieren, indem Sie eine Reihe von Spark-Transformatoren über eine Spark-Pipeline definieren und verketten. Diese Klasse kann implementiert werden, um entweder mit einem DatasetTransformer zusammenzuarbeiten, als einzige Komponente der Funktions-Engineering-Komponente zu arbeiten, oder Sie können festlegen, dass diese Klasse nicht implementiert wird.

Im folgenden Beispiel wird die FeaturePipelineFactory -Klasse erweitert:

PySpark-Beispiel

# 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

Speichern Sie Ihren Funktionsdatensatz mit DataSaver store-your-feature-dataset-with-datasaver

Der DataSaver ist für die Speicherung Ihrer resultierenden Funktionsdatensätze an einem Speicherort verantwortlich. Ihre Implementierung von DataSaver muss die abstrakte Klasse DataSaver erweitern und die abstrakte Methode save überschreiben.

Im folgenden Beispiel wird die DataSaver-Klasse erweitert, die Daten nach Kennung in einen Platform -Datensatz speichert, wobei die Datensatz-ID (featureDatasetId) und die Mandanten-ID (tenantId) definierte Eigenschaften in der Konfiguration sind.

PySpark-Beispiel

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

Geben Sie Ihre implementierten Klassennamen in der Anwendungsdatei an specify-your-implemented-class-names-in-the-application-file

Nachdem Sie Ihre Feature Pipeline-Klassen definiert und implementiert haben, müssen Sie die Namen Ihrer Klassen in der YAML-Anwendungsdatei angeben.

Die folgenden Beispiele geben implementierte Klassennamen an:

PySpark-Beispiel

#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

Erstellen der Funktions-Pipeline-Engine mit der API create-feature-pipeline-engine-api

Nachdem Sie Ihre Funktions-Pipeline erstellt haben, müssen Sie ein Docker-Bild erstellen, um die Funktions-Pipeline-Endpunkte in der Sensei Machine Learning -API aufzurufen. Sie benötigen eine Docker-Bild-URL, um die Endpunkte der Feature Pipeline aufrufen zu können.

Optional können Sie auch die folgende Postman-Sammlung verwenden, um den Funktions-Pipeline-API-Workflow abzuschließen:

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

Erstellen einer Funktions-Pipeline-Engine create-engine-api

Sobald Sie Ihren Docker-Image-Speicherort haben, können Sie eine Feature Pipeline-Enginemit der Sensei Machine Learning -API erstellen, indem Sie eine POST zu /engines durchführen. Wenn Sie eine Funktions-Pipeline-Engine erfolgreich erstellen, erhalten Sie eine eindeutige Engine-Kennung (id). Achten Sie darauf, diesen Wert zu speichern, bevor Sie fortfahren.

Erstellen einer MLInstance create-mlinstance

Mit dem neu erstellten engineID müssen Sie eine MLIstance erstellen, indem Sie eine POST-Anfrage an den Endpunkt /mlInstance senden. Eine erfolgreiche Antwort gibt eine Payload zurück, die die Details der neu erstellten MLInstance einschließlich ihrer eindeutigen Kennung (id) enthält, die im nächsten API-Aufruf verwendet wird.

Erstellen eines Experiments create-experiment

Als Nächstes müssen Sie ein Experiment erstellen. Um ein Experiment zu erstellen, müssen Sie die eindeutige MLIstance-Kennung (id) haben und eine POST-Anfrage an den /experiment-Endpunkt senden. Eine erfolgreiche Antwort gibt eine Payload zurück, die die Details des neu erstellten Experiments einschließlich der eindeutigen Kennung (id) enthält, die im nächsten API-Aufruf verwendet wird.

Geben Sie die Pipeline-Aufgabe für die Experimentablauf-Funktion an specify-feature-pipeline-task

Nachdem Sie ein Experiment erstellt haben, müssen Sie den Modus des Experiments in featurePipeline ändern. Um den Modus zu ändern, führen Sie mit Ihrem EXPERIMENT_ID eine zusätzliche POST zu experiments/{EXPERIMENT_ID}/runs aus und senden Sie im Hauptteil { "mode":"featurePipeline"} , um einen Experimentablauf für die Funktions-Pipeline anzugeben.

Stellen Sie nach Abschluss eine GET-Anfrage an /experiments/{EXPERIMENT_ID}, um den Experimentstatus abzurufen, und warten Sie, bis der Experimentstatus aktualisiert wird.

Festlegen der Trainings-Aufgabe für die Experimentausführung training

Als Nächstes müssen Sie die Aufgabe für den Trainings-Lauf festlegen. Nehmen Sie eine POST auf "experiments/{EXPERIMENT_ID}/runs"vor, legen Sie den Modus im Hauptteil auf "train"fest und senden Sie eine Reihe von Aufgaben, die Ihre Trainings-Parameter enthalten. Eine erfolgreiche Antwort gibt eine Payload zurück, die die Details des angeforderten Experiments enthält.

Stellen Sie nach Abschluss eine GET-Anfrage an /experiments/{EXPERIMENT_ID}, um den Experimentstatus abzurufen, und warten Sie, bis der Experimentstatus aktualisiert wird.

Festlegen der Scoring-Aufgabe für Experimentabläufe scoring

Nach einem erfolgreichen Trainings-Lauf müssen Sie die Scoring-Lauf-Aufgabe 🔗 festlegen. Nehmen Sie eine POST auf "experiments/{EXPERIMENT_ID}/runs"vor und setzen Sie im Hauptteil das Attribut mode auf "Transformation". Dadurch wird Ihr Auswertungs-Experimentablauf gestartet.

Stellen Sie nach Abschluss eine GET-Anfrage an /experiments/{EXPERIMENT_ID}, um den Experimentstatus abzurufen, und warten Sie, bis der Experimentstatus aktualisiert wird.

Sobald die Auswertung abgeschlossen ist, sollte Ihre Feature Pipeline betriebsbereit sein.

Nächste Schritte next-steps

Durch Lesen dieses Dokuments haben Sie eine Feature Pipeline mit dem Model Authoring SDK erstellt, ein Docker-Bild erstellt und die Docker-Bild-URL verwendet, um mithilfe der Sensei Machine Learning -API ein Feature Pipeline-Modell zu erstellen. Sie können jetzt mit der Transformation von Datensätzen und dem Extrahieren von Datenfunktionen skaliert mit dem Sensei Machine Learning API fortfahren.