Adicionar metadados pesquisáveis aos seus recursos

Na Amazon SageMaker Feature Store, você pode pesquisar todos os seus recursos. Para tornar seus recursos 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 recurso.

• 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 recurso, você pode usar o console ou a UpdateFeatureMetadataoperação.

Como adicionar metadados pesquisáveis aos seus recursos

Você pode usar o console ou a Amazon SageMaker Feature Store API para adicionar metadados pesquisáveis aos seus recursos. As instruções para usar a 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.

Adicione metadados pesquisáveis aos recursos se o Studio for sua experiência padrão (console)

1. Abra o console do Studio seguindo as instruções emInicie o Amazon SageMaker Studio.

2. Escolha Dados no painel de navegação esquerdo para expandir a lista suspensa.

3. Na lista suspensa, escolha Feature Store.

4. (Opcional) Para ver seus recursos, escolha Minha conta. Para ver os recursos compartilhados, escolha Conta cruzada.

5. Para visualizar seus grupos de recursos, na guia Catálogo de recursos, escolha Minha conta.

6. Na guia Catálogo de recursos, escolha Conta cruzada para visualizar grupos de recursos que outras pessoas tornam visíveis para você. Em Criado por, você pode ver o ID da conta do proprietário do recurso do grupo de recursos.

7. Você pode pesquisar seus recursos 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ê pesquisar um parâmetro, especifique a chave e o valor. Para encontrar seus recursos com mais facilidade, você pode especificar intervalos de tempo ou desmarcar as colunas que não deseja consultar.

   • Para recursos compartilhados, você só pode editar metadados de grupos de recursos ou definições de recursos se tiver a permissão de acesso adequada concedida pela conta do proprietário do recurso. Ter a permissão de descoberta por si só não permite que você edite metadados ou definições de recursos. Para obter mais informações sobre como conceder permissões de acesso, consulteHabilitar o acesso entre contas.

8. Escolha seu recurso.

9. Escolha Editar metadados.

10. No campo Descrição, insira uma ou atualize a descrição.

11. No campo Parâmetros, em Parâmetros, especifique um par de valores-chave para o parâmetro.

12. (Opcional) Escolha Adicionar novo parâmetro para adicionar outro parâmetro.

13. Escolha Salvar alterações.

14. Selecione a opção Confirmar.

Adicione metadados pesquisáveis aos seus recursos usando para SDK Python (Boto3)

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

Para obter mais exemplos e recursos da Feature Store, consulteRecursos da Amazon SageMaker Feature Store.

Add a list of parameters to a feature

Para adicionar uma lista de parâmetros a um recurso, 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 recurso, 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 recurso, 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 recurso, 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 recurso, 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:

1. Configura seu SageMaker ambiente.

2. Cria um grupo de recursos.

3. Adiciona recursos ao grupo.

4. Adiciona metadados aos recursos.

Para obter mais exemplos e recursos da Feature Store, consulteRecursos da Amazon SageMaker Feature Store.

Etapa 1: configuração

Para começar a usar a Feature Store SageMaker, crie sessões de boto3 e Feature Store. Além disso, configure o bucket do S3 que deseja usar para seus recursos. Esse é seu armazenamento offline. O código a seguir usa o bucket SageMaker padrão 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 recursos e adicionar recursos

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

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 recursos seja Created.

sagemaker_client.describe_feature_group(
        FeatureGroupName=feature_group_name
    )               
            

Adicione uma descrição ao recurso.

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

Você pode usar a DescribeFeatureMetadataoperação para verificar se você atualizou com êxito a descrição do grupo de recursos.

    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 recursos.

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