Como adicionar metadados pesquisáveis aos seus atributos

Adicionar metadados pesquisáveis aos seus atributos

Na Amazon SageMaker Feature Store, você pode pesquisar todos os seus recursos. Para tornar seus atributos mais detectáveis, você pode adicionar metadados a eles. É possível adicionar os seguintes tipos de metadados:

Descrição: Uma descrição pesquisável do atributo.
Parâmetros: Pares de valores-chave pesquisáveis.

A descrição pode ter até 255 caracteres. Para obter parâmetros, especifique um par de valores-chave na pesquisa. É possível adicionar até 25 parâmetros.

Para atualizar os metadados de um atributo, você pode usar o console ou a operação UpdateFeatureMetadata.

Como adicionar metadados pesquisáveis aos seus atributos

Você pode usar o console ou a API da Amazon SageMaker Feature Store para adicionar metadados pesquisáveis aos seus recursos. As instruções para usar o Feature Store por meio do console dependem de você ter ativado SageMaker Estúdio Amazon ou Amazon SageMaker Studio Clássico como sua experiência padrão.

Abra o console do Studio seguindo as instruções em Inicie o Amazon SageMaker Studio.
Escolha Dados no painel de navegação à esquerda para expandir a lista suspensa.
Na lista suspensa, escolha Feature Store.
(Opcional) Para ver seus atributos, escolha Minha conta. Para ver os atributos compartilhados, escolha Conta cruzada.
Para visualizar seus grupos de atributos, na aba Catálogo de atributos, escolha Minha conta.
Na aba Catálogo de atributos, escolha Conta cruzada para visualizar os grupos de atributos que se tornaram detectáveis para você. Em Criado por, você pode ver o ID da conta do proprietário do atributo do grupo de atributos.
Você pode pesquisar seus atributos na lista suspensa Pesquisar.
- (Opcional) Para filtrar sua pesquisa, escolha o ícone de filtro ao lado da lista suspensa Pesquisar. Você pode usar filtros para especificar parâmetros ou intervalos de datas nos resultados da pesquisa. Se você estiver procurando um parâmetro, especifique a chave e o valor dele. Para encontrar seus atributos com mais facilidade, você pode especificar intervalos de tempo ou desmarcar colunas que não deseja consultar.
- Para atributos compartilhados, você só pode editar metadados de grupos de atributos ou definições de atributos se tiver a permissão de acesso adequada concedida pela conta do proprietário do atributo. Ter a permissão de detecção por si só não permitirá que você edite metadados ou definições de atributos. Para obter informações sobre como conceder essas permissões de acesso, consulte Habilitar o acesso entre contas.
Escolha seu atributo.
Escolha Editar metadados.
No campo Descrição, insira uma ou atualize a descrição.
No campo Parâmetros, em Parâmetros, especifique um par de valores-chave para o parâmetro.
(Opcional) Escolha Adicionar novo parâmetro para adicionar outro parâmetro.
Escolha Salvar alterações.
Selecione a opção Confirmar.

O código nesta seção usa a operação UpdateFeatureMetadata no AWS SDK for Python (Boto3) para adicionar metadados pesquisáveis aos seus atributos para diferentes cenários. Para obter informações sobre os outros idiomas para enviar uma consulta, consulte Consulte também na Amazon SageMaker API Reference.

Para obter mais exemplos e recursos do Feature Store, consulte Recursos da Amazon SageMaker Feature Store.

Add a list of parameters to a feature

Para adicionar uma lista de parâmetros a um atributo, especifique valores para os seguintes campos:

FeatureGroupName
Feature
Parameters

O código de exemplo a seguir usa o AWS SDK for Python (Boto3) para adicionar dois 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 adicionar uma descrição a um atributo, especifique valores para os seguintes campos:

FeatureGroupName
Feature
Description



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

Remove parameters for a feature

Para remover todos os parâmetros de um atributo, faça o seguinte:

Especifique valores para os seguintes campos:

FeatureGroupName
Feature

Especifique as chaves para os parâmetros que você está removendo em 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 remover a descrição de um atributo, faça o seguinte:

Especifique valores para os seguintes campos:

FeatureGroupName
Feature

Especifique uma string vazia para Description.



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

Código de exemplo

Depois de atualizar os metadados de um atributo, você pode usar a operação DescribeFeatureMetadata para ver as atualizações que você fez.

O código a seguir passa por um exemplo de fluxo de trabalho usando o AWS SDK for Python (Boto3). O código de exemplo faz o seguinte:

Configura seu ambiente de SageMaker IA.
Cria um grupo de atributos.
Adiciona atributos ao grupo.
Adiciona metadados aos atributos.

Para obter mais exemplos e recursos do Feature Store, consulte Recursos da Amazon SageMaker Feature Store.

Etapa 1: configuração

Para começar a usar a Feature Store, crie sessões de SageMaker AI, boto3 e Feature Store. Além disso, configure o bucket do S3 que deseja usar para seus atributos. Esse é seu armazenamento offline. O código a seguir usa o bucket padrão do SageMaker AI e adiciona um prefixo personalizado a ele.

nota

O perfil que você usa deve ter as seguintes políticas gerenciadas anexadas a ele: AmazonS3FullAccess e 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)

Etapa 2: criar um grupo de atributos e adicionar atributos

O código a seguir é um exemplo de criação de um grupo de atributos com definições de atributos.



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

Etapa 3: adicionar metadados

Antes de adicionar metadados, use a operação DescribeFeatureGroup para garantir que o status do grupo de atributos seja Created.



sagemaker_client.describe_feature_group(
        FeatureGroupName=feature_group_name
    )

Adicione uma descrição ao atributo.



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

Você pode usar a operação DescribeFeatureMetadata para ver se você atualizou com êxito a descrição do grupo de atributos.



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

Você também pode usá-la para adicionar parâmetros ao grupo de atributos.



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

Você pode usar a operação DescribeFeatureMetadata novamente para ver se você adicionou os parâmetros com sucesso.



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

Atenção O Javascript está desativado ou não está disponível no seu navegador.

Para usar a documentação da AWS, o Javascript deve estar ativado. Consulte as páginas de Ajuda do navegador para obter instruções.

Convenções do documento

Encontrar grupos de atributos em suo Feature Store

Criar um conjunto de dados a partir de seus grupos de atributos