Comment ajouter des métadonnées consultables à vos fonctionnalités

Ajout de métadonnées consultables à vos fonctionnalités

Dans Amazon SageMaker Feature Store, vous pouvez effectuer une recherche parmi toutes vos fonctionnalités. Pour rendre vos fonctionnalités plus visibles, vous pouvez y ajouter des métadonnées. Vous pouvez surveiller les types de métadonnées suivantes :

Description - description consultable de la fonctionnalité.
Paramètres — Paires clé-valeur consultables.

La description peut comporter jusqu'à 255 caractères. Pour les paramètres, vous devez spécifier une paire clé-valeur dans votre recherche. Vous pouvez ajouter jusqu'à 25 paramètres.

Pour mettre à jour les métadonnées d'une fonctionnalité, vous pouvez utiliser la console ou l'UpdateFeatureMetadataopération.

Comment ajouter des métadonnées consultables à vos fonctionnalités

Vous pouvez utiliser la console ou l'Amazon SageMaker Feature Store API pour ajouter des métadonnées consultables à vos fonctionnalités. Les instructions d'utilisation du Feature Store via la console varient selon que vous l'avez activé Amazon SageMaker Studio ou Amazon SageMaker Studio classique que vous l'avez configuré comme expérience par défaut.

Ouvrez la console Studio en suivant les instructions figurant dansLancez Amazon SageMaker Studio.
Choisissez Data dans le volet de navigation de gauche pour développer la liste déroulante.
Dans la liste déroulante, choisissez Feature Store.
(Facultatif) Pour consulter vos fonctionnalités, sélectionnez Mon compte. Pour afficher les fonctionnalités partagées, choisissez Cross account.
Pour afficher vos groupes de fonctionnalités, sous l'onglet Catalogue de fonctionnalités, sélectionnez Mon compte.
Dans l'onglet Catalogue de fonctionnalités, choisissez Compte croisé pour afficher les groupes de fonctionnalités que d'autres personnes mettent à votre disposition. Sous Créé par, vous pouvez afficher l'ID de compte du propriétaire de la ressource du groupe de fonctionnalités.
Vous pouvez rechercher votre fonctionnalité dans la liste déroulante Rechercher.
- (Facultatif) Pour filtrer votre recherche, cliquez sur l'icône de filtre à côté de la liste déroulante Rechercher. Vous pouvez utiliser des filtres pour spécifier des paramètres ou des plages de dates dans vos résultats de recherche. Si vous recherchez un paramètre, spécifiez sa clé et sa valeur. Pour trouver plus facilement vos fonctionnalités, vous pouvez définir des plages temporelles ou désélectionner les colonnes que vous ne souhaitez pas interroger.
- Pour les ressources partagées, vous ne pouvez modifier les métadonnées des groupes d'entités ou les définitions d'entités que si vous disposez de l'autorisation d'accès appropriée accordée par le compte du propriétaire de la ressource. Le fait de disposer de l'autorisation de découvrabilité à elle seule ne vous permet pas de modifier les métadonnées ou les définitions de fonctionnalités. Pour plus d'informations sur l'octroi d'autorisations d'accès, consultezActivation de l'accès intercompte.
Choisissez votre fonctionnalité.
Choisissez Modifier les métadonnées.
Dans le champ Description, ajoutez ou mettez à jour la description.
Dans le champ Parameters (Paramètres) sous Parameters (Paramètres), indiquez une paire clé-valeur pour le paramètre.
(Facultatif) Choisissez Add new parameter (Ajouter un paramètre) pour ajouter un autre paramètre.
Choisissez Save changes (Enregistrer les modifications).
Choisissez Confirm (Confirmer).

Le code de cette section utilise l'UpdateFeatureMetadataopération décrite dans le AWS SDK for Python (Boto3) pour ajouter des métadonnées consultables à vos fonctionnalités pour différents scénarios. Pour plus d'informations sur les autres langues dans lesquelles envoyer une requête, voir également dans le manuel Amazon SageMaker API Reference.

Pour d'autres exemples et ressources du Feature Store, consultezRessources Amazon SageMaker Feature Store.

Add a list of parameters to a feature

Pour ajouter une liste de paramètres à une fonctionnalité, indiquez des valeurs pour les champs suivants :

FeatureGroupName
Feature
Parameters

L'exemple de code suivant utilise le AWS SDK for Python (Boto3) pour ajouter deux paramètres.



sagemaker_client.update_feature_metadata(
    FeatureGroupName="feature_group_name",
    FeatureName="feature-name",
    ParameterAdditions=[
        {"Key": "example-key-0", "Value": "example-value-0"},
        {"Key": "example-key-1", "Value": "example-value-1"},
    ]
)

Add a description to a feature

Pour ajouter une description à une fonctionnalité, indiquez des valeurs pour les champs suivants :

FeatureGroupName
Feature
Description



sagemaker_client.update_feature_metadata(
    FeatureGroupName="feature-group-name",
    FeatureName="feature-name",
    Description="description"
)

Remove parameters for a feature

Pour supprimer tous les paramètres d'une fonctionnalité, procédez comme suit.

Spécifiez des valeurs pour les champs suivants :

FeatureGroupName
Feature

Spécifiez les clés pour les paramètres que vous supprimez sous ParameterRemovals.



sagemaker_client.update_feature_metadata(
    FeatureGroupName="feature_group_name",
    FeatureName="feature-name",
        ParameterRemovals=[
        {"Key": "example-key-0"},
        {"Key": "example-key-1"},
    ]
)

Remove the description for a feature

Pour supprimer la description d'une fonctionnalité, procédez comme suit.

Spécifiez des valeurs pour les champs suivants :

FeatureGroupName
Feature

Spécifiez une chaîne vide pour Description.



sagemaker_client.update_feature_metadata(
    FeatureGroupName="feature-group-name",
    FeatureName="feature-name",
    Description=""
)

Exemple de code

Après avoir mis à jour les métadonnées d'une fonctionnalité, vous pouvez utiliser l'opération DescribeFeatureMetadata pour voir les mises à jour que vous avez apportées.

Le code suivant décrit un exemple de flux de travail à l'aide de AWS SDK for Python (Boto3). L'exemple de code effectue ce qui suit :

Configure votre SageMaker environnement.
Crée un groupe de fonctionnalités
Ajoute des fonctionnalités au groupe.
Ajoute des métadonnées aux fonctionnalités.

Pour d'autres exemples et ressources du Feature Store, consultezRessources Amazon SageMaker Feature Store.

Étape 1 : configuration

Pour commencer à utiliser Feature Store, créez des SageMaker sessions, boto3 et Feature Store. Configurez ensuite le compartiment S3 que vous voulez utiliser pour vos fonctionnalités. Ceci est votre boutique hors ligne. Le code suivant utilise le bucket SageMaker par défaut et y ajoute un préfixe personnalisé.

Note

Le rôle que vous utilisez doit disposer des politiques gérées suivantes associées : AmazonS3FullAccess et AmazonSageMakerFeatureStoreAccess.


# SageMaker Python SDK version 2.x is required
%pip install 'sagemaker>=2.0.0'
import sagemaker
import sys



import boto3
import pandas as pd
import numpy as np
import io
from sagemaker.session import Session
from sagemaker import get_execution_role
from botocore.exceptions import ClientError


prefix = 'sagemaker-featurestore-introduction'
role = get_execution_role()

sagemaker_session = sagemaker.Session()
region = sagemaker_session.boto_region_name
s3_bucket_name = sagemaker_session.default_bucket()
sagemaker_client = boto_session.client(service_name='sagemaker', region_name=region)

Étape 2 : Créer un groupe de fonctionnalités et ajouter des fonctionnalités

Le code suivant est un exemple de la création d'un groupe de fonctionnalités avec des définitions de fonctionnalités.



feature_group_name = "test-for-feature-metadata"
feature_definitions = [
    {"FeatureName": "feature-1", "FeatureType": "String"},
    {"FeatureName": "feature-2", "FeatureType": "String"},
    {"FeatureName": "feature-3", "FeatureType": "String"},
    {"FeatureName": "feature-4", "FeatureType": "String"},
    {"FeatureName": "feature-5", "FeatureType": "String"}
]
try:
    sagemaker_client.create_feature_group(
        FeatureGroupName=feature_group_name,
        RecordIdentifierFeatureName="feature-1",
        EventTimeFeatureName="feature-2",
        FeatureDefinitions=feature_definitions,
        OnlineStoreConfig={"EnableOnlineStore": True}
    )
except ClientError as e:
    if e.response["Error"]["Code"] == "ResourceInUse":
        pass
    else:
        raise e

Étape 3 : Ajouter des métadonnées

Avant d'ajouter des métadonnées, utilisez l'opération DescribeFeatureGroup pour vérifier que l'état du groupe de fonctionnalités est Created.



sagemaker_client.describe_feature_group(
        FeatureGroupName=feature_group_name
    )

Ajoutez une description à la fonctionnalité.



sagemaker_client.update_feature_metadata(
    FeatureGroupName=feature_group_name,
    FeatureName="feature-1",
    Description="new description"
)

Vous pouvez utiliser cette DescribeFeatureMetadataopération pour vérifier si vous avez correctement mis à jour la description du groupe de fonctionnalités.



    sagemaker_client.describe_feature_metadata(
    FeatureGroupName=feature_group_name,
    FeatureName="feature-1"
)

Vous pouvez également l'utiliser pour ajouter des paramètres au groupe de fonctionnalités.



sagemaker_client.update_feature_metadata(
    FeatureGroupName=feature_group_name,
    FeatureName="feature-1",
    ParameterAdditions=[
        {"Key": "team", "Value": "featurestore"},
        {"Key": "org", "Value": "sagemaker"},
    ]
)

Vous pouvez utiliser l'opération DescribeFeatureMetadata pour vérifier si vous avez ajouté les paramètres avec succès.



    sagemaker_client.describe_feature_metadata(
    FeatureGroupName=feature_group_name,
    FeatureName="feature-1"
)

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

Recherche de groupes de fonctionnalités dans Feature Store

Création d'un jeu de données à partir de vos groupes de fonctionnalités