API de démonstrations Snowflake Python

La bibliothèque Snowflake Python Demos (snowflake.demos) vous permet d’élaborer rapidement des démonstrations pour Snowflake Notebooks en automatisant les tâches d’installation de l’environnement — telles que la configuration de la base de données, du schéma, du rôle, des autorisations et de l’accès au jeu de données — afin de simplifier la prise en main de Snowflake Notebooks.

Cette bibliothèque vous permet d’effectuer les tâches suivantes :

  • Chargez et définissez les démos Snowflake Notebooks dans votre environnement Snowflake.

  • Explorez les Notebooks interactifs étape par étape pour acquérir une expérience pratique.

  • Démontez facilement les ressources lorsque vous avez terminé.

Conditions préalables

Avant de commencer à utiliser les démonstrations de l’API des démos Snowflake , suivez les étapes suivantes :

  1. Vérifiez que vous avez installé l’une des versions de Python prises en charge :

    • 3,9

    • 3,10

    • 3,11

    • 3,12

  2. Installer la bibliothèque des démos Snowflake.

  3. Configuration d’une connexion Snowflake par défaut.

  4. Importer snowflake.demos.

Installer la bibliothèque des démos Snowflake

Vous pouvez installer la bibliothèque des démos Snowflake pour l’utiliser avec conda ou un environnement virtuel. Pour configurer la bibliothèque, procédez comme suit :

  1. Activez un environnement Python.

  2. Pour installer la bibliothèque, exécutez la commande pip install suivante :

    pip install snowflake.demos
    
    Copy

Configuration d’une connexion Snowflake par défaut

L’API des démos Snowflake utilise la connexion par défaut pour le connecteur Python de Snowflake. Pour configurer cette connexion, suivez les instructions dans Définition d’une connexion par défaut.

Par exemple, pour spécifier une connexion nommée comme connexion par défaut dans votre fichier config.toml de Snowflake, vous ajoutez le nom de votre connexion par défaut au fichier config.toml comme suit :

default_connection_name = '<connection_name>'
Copy

Pour plus d’informations sur la spécification des définitions de connexions dans un fichier de configuration TOML, voir Connexion à l’aide du fichier connections.toml.

Importer snowflake.demos

Pour utiliser la bibliothèque dans votre terminal, vous pouvez ouvrir un shell interactif tel que le REPL Python standard.

  1. Exécutez la commande suivante (qui peut varier en fonction de votre environnement Python) :

    python3
    
    Copy
  2. Dans la session REPL, pour importer la bibliothèque et les fonctions correspondantes, exécutez le code suivant :

    from snowflake.demos import help, load_demo, teardown
    
    Copy

Annonce des démonstrations disponibles

Après avoir importé la bibliothèque, vous pouvez utiliser la fonction help() pour voir la liste des démos disponibles que vous pouvez charger et commencer à explorer. Cette fonction renvoie une table contenant les colonnes suivantes :

  • demo_name : Une chaîne délimitée par des tirets qui représente le nom de la démo.

  • title : Le titre du nom de la démo lisible par l’homme.

  • num_steps : Le nombre d’étapes de la démo.

Liste actuelle des démos disponibles

Note

Le contenu suivant n’est pas pris en charge par Snowflake. L’ensemble du code est fourni « AS IS » et sans garantie.

L’API des démos Snowflake prend en charge actuellement la liste suivante de démos :

demo_name

titre

num_steps

analysis-churn-notebooks

Analyse des données et prédiction du taux de désabonnement à l’aide des Notebooks Snowflake

2

analytics-cortex

Analyses des avis de clients avec Snowflake Cortex

1

anthropic-cortex

Premiers pas avec Anthropic sur Snowflake Cortex

1

external-access-nb

Accès aux points de terminaison externes

1

get-started-partitioned-models

Premiers pas avec les modèles partitionnés et le Snowflake Model Registry

1

get-started-snowapi-nb

Création d’objets Snowflake à l’aide de l’API Python

1

get-started-snowpark-ws-nb

Premiers pas avec Snowpark dans les Snowflake Notebooks et les feuilles de calcul Python

1

get-started-snowflake-ml

Premiers pas avec Snowflake ML

4

ingest-json-data

Ingestion du JSON public

1

intro-snowpark-pandas

Introduction à Snowpark Pandas

1

intro-to-feature-store-nb

Introduction à la fonction Store à l’aide des Notebooks Snowflake

1

intro-to-snowflake-nb

Mon premier projet Notebook

1

load-csv-to-stage

Chargement de CSV à partir de S3

1

ref-cells-and-vars

Cellules et variables de référence

1

visual-data-stories

Récits de données visuelle avec Snowflake Notebooks

1

working-with-files

Utilisation de fichiers

1

Travailler avec des démos

Après avoir rempli les conditions préalables <label-snowflake_python_demos_prerequisites>, vous pouvez commencer à utiliser l’API des démos Snowflake pour travailler avec les démos, comme décrit dans les sections suivantes.

Charger et explorer une démo

  • Pour charger une démo spécifique et configurer ses ressources associées dans Snowflake, appelez load_demo() avec un argument spécifiant le demo_name de toute démo disponible, comme indiqué dans la sortie help().

    Par exemple :

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

Astuce

  • Pour stocker une référence à la démo en tant qu’objet, affectez le résultat de load_demo() à une variable :

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

L’affectation du résultat à une variable est requise si vous travaillez avec une démonstration en plusieurs étapes (num_steps > 1). Vous aurez besoin de cette référence pour appeler show_next() ou show(step=<le numéro>) pour passer au carnet suivant dans la démo.

Vous pouvez également utiliser cette référence pour démonter rapidement la démo par la suite.

Cette fonction permet d’effectuer les opérations suivantes :

  • Crée une connexion à Snowflake si c’est la première fois que vous chargez une démo.

  • Crée les Notebooks nécessaires.

  • Affiche l’URL du carnet pour la première étape de la démo (étape 1), si vous n’assignez pas load_demo() à une variable.

    • Si vous affectez load_demo() à une variable, vous devez appeler demo.show() pour obtenir la première URL du carnet.

La sortie devrait ressembler à ce qui suit :

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

Note

Il existe un problème connu concernant l’impression des URLs du carnet. Si l’URL ne s’ouvre pas directement, vous pouvez la copier et la coller dans un nouvel onglet du navigateur, ou y accéder manuellement dans Snowsight sous l’onglet Notebooks.

Afficher l’URL de la démo

Vous pouvez utiliser la fonction show() pour afficher l’URL à une étape spécifique de la démo.

  • Pour afficher l’URL de l’étape actuelle, affectez d’abord le résultat de load_demo() à une variable telle que demo, puis appelez show() sans arguments :

    demo.show()
    
    Copy

    La sortie devrait ressembler à ce qui suit :

    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
    
  • Pour obtenir l’URL du notebook pour une étape spécifique de la démo, transférez l’argument step avec un numéro d’étape spécifié à show() :

    demo.show(step=1)
    
    Copy
  • Pour que l’URL du carnet passe à l’étape suivante d’une démo en plusieurs étapes, utilisez la fonction show_next() :

    demo.show_next()
    
    Copy

Supprimer une démo et ses ressources

Lorsque vous aurez fini d’explorer les démos que vous avez configurées, vous voudrez peut-être nettoyer toutes les ressources créées, les ensembles de données et les carnets qui ont été créés.

  • Pour supprimer une seule démo et ses ressources associées, affectez d’abord le résultat de load_demo() à une variable telle que demo, puis appelez teardown() sur cette variable :

    demo.teardown()
    
    Copy
  • Pour supprimer toutes les démos et toutes les ressources associées qui ont été paramétrées, appelez teardown() en tant que fonction de premier niveau :

    teardown()
    
    Copy