Demonstrações da API do Snowflake Python

A biblioteca Snowflake Python Demos (snowflake.demos) ajuda você a montar rapidamente demonstrações para o Snowflake Notebooks automatizando as tarefas de configuração do ambiente, como a configuração do banco de dados, do esquema, da função, das permissões e do acesso ao conjunto de dados, para agilizar os primeiros passos com o Snowflake Notebooks.

Com essa biblioteca, você pode realizar estas tarefas:

  • Carregue e configure as demonstrações do Snowflake Notebooks em seu ambiente Snowflake.

  • Explore os notebooks interativos passo a passo para obter experiência prática.

  • Os recursos podem ser removidos facilmente quando você terminar.

Pré-requisitos

Antes de começar a usar a Snowflake Demos API, conclua as etapas a seguir:

  1. Verifique se você instalou uma das versões do Python compatíveis:

    • 3.9

    • 3,10

    • 3,11

    • 3,12

  2. Instalação da biblioteca Snowflake Demos.

  3. Configuração de uma conexão padrão do Snowflake.

  4. Importação de snowflake.demos.

Instalação da biblioteca Snowflake Demos

Você pode instalar a biblioteca Snowflake Demos para uso com o conda ou com um ambiente virtual. Para configurar a biblioteca, siga estas etapas:

  1. Ative um ambiente Python.

  2. Para instalar a biblioteca, execute o seguinte comando pip install:

    pip install snowflake.demos
    
    Copy

Configuração de uma conexão padrão do Snowflake

A Snowflake Demos API usa a conexão padrão para o Snowflake Python Connector. Para configurar essa conexão, siga as instruções em Configuração de uma conexão padrão.

Por exemplo, para especificar uma conexão nomeada como a conexão padrão no arquivo config.toml do Snowflake, adicione o nome da conexão padrão ao arquivo config.toml da seguinte forma:

default_connection_name = '<connection_name>'
Copy

Para obter informações sobre como especificar definições de conexão em um arquivo de configuração TOML, consulte Conexão usando o arquivo connections.toml.

Importação de snowflake.demos

Para usar a biblioteca em seu terminal, você pode abrir um shell interativo, como o REPL Python padrão.

  1. Execute o seguinte comando (que pode variar dependendo do seu ambiente Python):

    python3
    
    Copy
  2. Na sessão REPL, para importar a biblioteca e as funções relevantes, execute o seguinte código:

    from snowflake.demos import help, load_demo, teardown
    
    Copy

Listagem de demonstrações disponíveis

Depois de importar a biblioteca, você pode usar a função help() para ver a lista de demonstrações disponíveis que pode carregar e começar a explorar. Essa função retorna uma tabela com as seguintes colunas:

  • demo_name: uma cadeia de caracteres delimitada por traços que representa o nome da demonstração.

  • title: o título do nome da demonstração legível por humanos.

  • num_steps: o número de etapas na demonstração.

Lista atual de demonstrações disponíveis

Nota

O conteúdo a seguir não é compatível com o Snowflake. Todo o código é fornecido «AS IS» e sem garantia.

A Snowflake Demos API funciona atualmente com a seguinte lista de demonstrações:

demo_name

title

num_steps

analysis-churn-notebooks

Análise de dados e previsão de churn usando o Snowflake Notebooks

2

analytics-cortex

Análise de avaliações de clientes usando o Snowflake Cortex

1

anthropic-cortex

Introdução ao Anthropic no Snowflake Cortex

1

external-access-nb

Acessar pontos de extremidade externos

1

get-started-partitioned-models

Introdução aos modelos particionados e ao Snowflake Model Registry

1

get-started-snowapi-nb

Criação de objetos Snowflake usando Python API

1

get-started-snowpark-ws-nb

Introdução ao Snowpark no Snowflake Notebooks e planilhas Python

1

get-started-snowflake-ml

Introdução ao Snowflake ML

4

ingest-json-data

Ingerir JSON público

1

intro-snowpark-pandas

Introdução ao Snowpark pandas

1

intro-to-feature-store-nb

Introdução ao Feature Store usando Snowflake Notebooks

1

intro-to-snowflake-nb

Meu primeiro projeto do Notebook

1

load-csv-to-stage

Carregar CSV do S3

1

ref-cells-and-vars

Células e variáveis de referência

1

visual-data-stories

Histórias visuais de dados com Snowflake Notebooks

1

working-with-files

Como trabalhar com arquivos

1

Como trabalhar com demonstrações

Após concluir os pré-requisitos, você pode começar a usar a Snowflake Demos API para trabalhar com demonstrações conforme descrito nas seções a seguir.

Como carregar e explorar uma demonstração

  • Para carregar uma demonstração específica e configurar os recursos associados no Snowflake, chame load_demo() com um argumento que especifique demo_name de qualquer demonstração compatível, conforme encontrado na saída help().

    Por exemplo:

    load_demo('get-started-snowflake-ml')
    
    Copy

Dica

  • Para armazenar uma referência à demonstração como um objeto, atribua o resultado de load_demo() a uma variável:

    demo = load_demo('get-started-snowflake-ml')
    
    Copy

Atribuir o resultado a uma variável é necessário se você estiver trabalhando com uma demonstração de várias etapas (num_steps > 1). Você precisará dessa referência para chamar show_next() ou show(step=<número>) para passar para o próximo notebook na demonstração.

Você também pode usar essa referência para desmantelar rapidamente a demonstração mais tarde.

Esta função faz o seguinte:

  • Cria uma conexão com o Snowflake se for a primeira vez que você estiver carregando uma demonstração.

  • Cria os notebooks necessários.

  • Exibe o URL do notebook para a primeira etapa da demonstração (etapa 1), se você não estiver atribuindo load_demo() a uma variável.

    • Se você atribuir load_demo() a uma variável, precisará chamar demo.show() para obter o primeiro URL do notebook.

A saída deve ser semelhante ao seguinte:

Connecting to Snowflake...✅
Using ACCOUNTADMIN role...✅
Creating Database SNOWFLAKE_DEMO_DB...✅
Creating Schema SNOWFLAKE_DEMO_SCHEMA...✅
Creating Warehouse SNOWFLAKE_DEMO_WH...✅
Creating Stage SNOWFLAKE_DEMO_STAGE...✅
Uploading files to stage SNOWFLAKE_DEMO_STAGE/get-started-snowflake-ml and creating notebooks...
Creating notebook get_started_snowflake_ml_start_here...✅
Creating notebook get_started_snowflake_ml_sf_nb_snowflake_ml_feature_transformations...✅
Creating notebook get_started_snowflake_ml_sf_nb_snowflake_ml_model_training_inference...✅
Creating notebook get_started_snowflake_ml_sf_nb_snowpark_ml_adv_mlops...✅
Running setup for this demo...✅

Nota

Existe um problema conhecido com URLs do notebook impressos. Se o URL não abrir diretamente, você pode copiar e colar em uma nova guia do navegador ou acessar o notebook manualmente na Snowsight na guia Notebooks.

Visualização do URL da demonstração

Você pode usar a função show() para visualizar o URL em uma etapa específica da demonstração.

  • Para visualizar o URL da etapa atual, primeiro atribua o resultado de load_demo() a uma variável, como demo, e depois chame show() sem argumentos:

    demo.show()
    
    Copy

    A saída deve ser semelhante a esta:

    Showing step 1.
    Please copy and paste this url in your web browser to open the notebook:
    https://app.snowflake.com/myorg/myaccount/#/notebooks/SNOWFLAKE_DEMO_DB.SNOWFLAKE_DEMO_SCHEMA.GET_STARTED_SNOWFLAKE_ML_START_HERE
    
  • Para obter o URL do notebook para uma etapa específica da demonstração, passe o argumento step com um número de etapa especificado para show():

    demo.show(step=1)
    
    Copy
  • Para obter o URL do notebook para a próxima etapa em uma demonstração de várias etapas, use a função show_next():

    demo.show_next()
    
    Copy

Exclusão de uma demonstração e seus recursos

Quando terminar de explorar as demonstrações que configurou, talvez queira limpar todos os recursos, conjuntos de dados e notebooks criados.

  • Para excluir uma única demonstração e seus recursos associados, primeiro atribua o resultado de load_demo() a uma variável como demo, e, em seguida, chame teardown() nela:

    demo.teardown()
    
    Copy
  • Para excluir todas as demonstrações e quaisquer recursos associados que tenham sido configurados, chame teardown() como uma função de nível superior.

    teardown()
    
    Copy