¿Cómo añadir metadatos con capacidad de búsqueda a tus funciones

Adición de metadatos que permiten búsquedas a las características

En Amazon SageMaker Feature Store, puedes buscar entre todas tus funciones. Para que las características sean más fáciles de detectar, puede agregarles metadatos. Puede agregar los siguientes tipos de metadatos:

Descripción: una descripción que permite búsquedas de la característica.
Parámetros: pares clave-valor que permiten búsquedas.

La descripción puede tener hasta 255 caracteres. En cuanto a los parámetros, debe especificar un par clave-valor en la búsqueda. Puede agregar hasta 25 parámetros.

Para actualizar los metadatos de una función, puedes usar la consola o la UpdateFeatureMetadataoperación.

¿Cómo añadir metadatos con capacidad de búsqueda a tus funciones

Puedes usar la consola o la Amazon SageMaker Feature Store API para añadir a tus funciones metadatos con capacidad de búsqueda. Las instrucciones para usar Feature Store a través de la consola dependen de si la experiencia está habilitada Amazon SageMaker Studio o Amazon SageMaker Studio clásico es la predeterminada.

Abre la consola de Studio siguiendo las instrucciones que se indican enLanza Amazon SageMaker Studio.
Seleccione Datos en el panel de navegación izquierdo para ampliar la lista desplegable.
En la lista desplegable, elija Almacén de características.
(Opcional) Para ver tus funciones, selecciona Mi cuenta. Para ver las funciones compartidas, selecciona Cuenta cruzada.
Para ver tus grupos de funciones, en la pestaña Catálogo de funciones, selecciona Mi cuenta.
En la pestaña Catálogo de funciones, elija Cuenta cruzada para ver los grupos de funciones que otros usuarios han hecho visibles para usted. En Creado por, puede ver el ID de cuenta del propietario del recurso del grupo de características.
Puede buscar su característica en la lista desplegable Buscar.
- (Opcional) Para filtrar la búsqueda, elija el icono de filtro situado junto a la lista desplegable de búsqueda. Puede utilizar filtros para especificar parámetros o intervalos de fechas en los resultados de la búsqueda. Si busca un parámetro, especifique su clave y su valor. Para encontrar los elementos con mayor facilidad, puede especificar intervalos de tiempo o deseleccionar las columnas que no desee consultar.
- En el caso de los recursos compartidos, solo puede editar los metadatos de los grupos de entidades o las definiciones de las entidades si cuenta con el permiso de acceso correspondiente otorgado por la cuenta del propietario del recurso. Tener el permiso de detección por sí solo no le permite editar los metadatos o las definiciones de las funciones. Para obtener más información sobre la concesión de permisos de acceso, consulteHabilitar el acceso entre cuentas.
Elija la característica.
Elija Edit medatada (Editar metadatos).
En el campo Descripción, agregue o actualice la descripción.
En el campo Parámetros, en Parámetros, especifique un par clave-valor para el parámetro.
De forma opcional, elija Agregar nuevo parámetro para agregar otro parámetro.
Elija Guardar cambios.
Elija Confirmar.

El código de esta sección usa la operación de UpdateFeatureMetadata AWS SDK for Python (Boto3) para añadir metadatos con capacidad de búsqueda a sus funciones para diferentes escenarios. Para obtener información sobre los demás idiomas para enviar una consulta, consulta Consulte también en la SageMaker APIreferencia de Amazon.

Para ver más ejemplos y recursos de Feature Store, consulteRecursos de Amazon SageMaker Feature Store.

Add a list of parameters to a feature

Para agregar una lista de parámetros a una característica, especifique los valores de los siguientes campos:

FeatureGroupName
Feature
Parameters

El siguiente código de ejemplo usa el AWS SDK for Python (Boto3) para añadir dos parámetros.



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

Para agregar una descripción a una característica, especifique los valores de los siguientes campos:

FeatureGroupName
Feature
Description



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

Remove parameters for a feature

Para eliminar todos los parámetros de una característica, haga lo siguiente.

Especifique los valores en los siguientes campos:

FeatureGroupName
Feature

Especifique las claves de los parámetros que va a eliminar en 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

Para eliminar la descripción de una característica, haga lo siguiente.

Especifique los valores en los siguientes campos:

FeatureGroupName
Feature

Especifique una cadena vacía para Description.



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

Código de ejemplo

Tras actualizar los metadatos de una característica, puede utilizar la operación DescribeFeatureMetadata para ver las actualizaciones que ha realizado.

El código siguiente muestra un ejemplo de flujo de trabajo mediante el AWS SDK for Python (Boto3). El código de ejemplo hace lo siguiente:

Configura su SageMaker entorno.
Crea un grupo de características.
Agrega características al grupo.
Agrega metadatos a las características.

Para obtener más ejemplos y recursos de Feature Store, consulteRecursos de Amazon SageMaker Feature Store.

Paso 1: Configurar

Para empezar a usar Feature Store SageMaker, cree sesiones de Boto3 y Feature Store. Además, configure el bucket de S3 que desea utilizar para sus características. Este es su almacenamiento sin conexión. El siguiente código usa el bucket SageMaker predeterminado y le agrega un prefijo personalizado.

nota

El rol que utilice debe tener asociadas las siguientes políticas administradas: AmazonS3FullAccess y 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)

Paso 2: Crear un grupo de características y agregar características

El siguiente código es un ejemplo de creación de un grupo de características con definiciones de características.



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

Paso 3: Agregar metadatos

Antes de agregar metadatos, utilice la operación DescribeFeatureGroup para asegurarse de que el estado del grupo de características sea Created.



sagemaker_client.describe_feature_group(
        FeatureGroupName=feature_group_name
    )

Agregue una descripción a la característica.



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

Puede utilizar la DescribeFeatureMetadataoperación para comprobar si ha actualizado correctamente la descripción del grupo de elementos.



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

También puede utilizarla para agregar parámetros al grupo de características.



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

Puede volver a usar la operación DescribeFeatureMetadata para comprobar si ha agregado los parámetros correctamente.



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

Aviso JavaScript está desactivado o no está disponible en su navegador.

Para utilizar la documentación de AWS, debe estar habilitado JavaScript. Para obtener más información, consulte las páginas de ayuda de su navegador.

Convenciones del documento

Búsqueda de grupos de características en el almacén de características

Creación de un conjunto de datos a partir de sus grupos de características