Snowflake Python Demos API¶
Snowflake Python Demos 库 (snowflake.demos) 通过自动执行环境设置任务（例如配置数据库、架构、角色、权限和数据集访问权限），帮助您快速构建 Snowflake Notebooks 的演示，从而简化 Snowflake Notebooks 入门流程。
使用此库，您可以执行以下操作：
在 Snowflake 环境中加载和设置 Snowflake Notebooks 演示。
逐步探索交互式笔记本以获得实践经验。
完成后可以轻松删除资源。
先决条件¶
在开始使用 Snowflake Demos API 之前，请完成以下步骤：
确认您已经安装 支持的 Python 版本 之一。
支持的 Python 版本¶
受支持的 Python 版本包括：
3.9
3.10
3.11
3.12
安装 Snowflake Demos 库¶
您可以安装 Snowflake Demos 库，以便与 Conda 或虚拟环境一起使用。要安装库，请执行以下操作：
通过运行以下
pip install命令来安装库：pip install snowflake.demos
设置默认 Snowflake 连接¶
Snowflake Demos API 使用 Snowflake Python Connector 的默认连接。要配置此连接，请按照 设置默认连接 中的说明进行操作。
例如，要将命名连接指定为 Snowflake config.toml 文件中的默认连接，请按如下方式将默认连接名称添加到 config.toml 文件中：
default_connection_name = '<connection_name>'
有关在 TOML 配置文件中指定连接定义的信息，请参阅 使用 connections.toml 文件进行连接。
导入 snowflake.demos¶
要在终端中使用该库，您可以运行以下命令（可能因您的 Python 环境而异），以打开交互式 Shell，例如标准 Python REPL：
python3
在 REPL 会话中，通过运行以下代码来导入库和相关函数：
from snowflake.demos import help, load_demo, teardown
列出可用的演示¶
导入库后，您可以使用 help() 函数查看可加载的可用演示列表并开始探索。该函数返回一个包含以下列的表：
demo_name– 代表演示名称且以短划线分隔的字符串。title– 人类可读的演示名称标题。num_steps– 演示中的步骤数。
当前可用演示列表¶
Snowflake Demos API 目前支持以下演示列表：
demo_name |
title |
num_steps |
|---|---|---|
|
开始在 Snowflake Notebooks 和 Python Worksheets 中使用 Snowpark |
1 |
|
开始使用 Snowflake ML |
4 |
|
使用 Snowflake Notebooks 进行数据分析和流失预测 |
2 |
|
开始使用 Snowflake Container Runtime |
1 |
|
使用 Snowflake Notebooks 的功能商店的简介 |
1 |
|
开始使用分区模型和 Snowflake Model Registry |
1 |
处理演示¶
完成 前提条件 后，您可以开始使用 Snowflake Demos API 来处理演示，如下所示。
加载并浏览演示¶
要加载特定的演示并在 Snowflake 中设置其关联资源，请使用一个实参调用 load_demo()，指定任何支持的演示的 demo_name，如 help() 输出中所示。例如：
load_demo('get-started-snowflake-ml')
小技巧
要将对演示的参考存储为对象，您可以将 load_demo() 的结果分配给变量：
demo = load_demo('get-started-snowflake-ml')
如果您正在处理多步骤演示（num_steps > 1），则需要将结果分配给变量。您需要此参考来调用 show_next() 或 show(step=<number>)，才能转到演示中的下一个笔记本。
您还可以稍后使用此参考快速删除演示。
此函数执行以下操作：
如果这是您第一次加载演示，则创建与 Snowflake 的连接。
创建必要的笔记本。
如果您没有将 URL 分配给变量，则在演示的第一步（步骤 1）显示笔记本
load_demo()。如果您将
load_demo()分配给变量，则需要调用demo.show()以获取第一个笔记本 URL。
输出应类似于以下内容：
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...✅
备注
打印的笔记本 URLs 存在已知问题。如果 URL 无法直接打开，您可以将其复制并粘贴到新的浏览器选项卡中，或者在 Snowsight 中 Notebooks 选项卡下手动访问笔记本。
查看演示 URL¶
您可以使用 show() 函数来了解演示中的当前步骤或特定步骤的 URL。
要在演示的当前步骤中获取笔记本的 URL，请先将 load_demo() 的结果分配给变量（例如 demo），然后在不使用实参的情况下调用 show()：
demo.show()
输出应类似于以下内容：
Showing step 1.
Please copy and paste this url in your web browser to open the notebook:
https://app.snowflake.cn/myorg/myaccount/#/notebooks/SNOWFLAKE_DEMO_DB.SNOWFLAKE_DEMO_SCHEMA.GET_STARTED_SNOWFLAKE_ML_START_HERE
要在演示的特定步骤中获取笔记本 URL，请将带指定步骤号的 step 实参传递给 show()。
demo.show(step=1)
要在多步骤演示的下个步骤中获取笔记本 URL，请使用 show_next() 函数：
demo.show_next()
删除演示及其资源¶
浏览完所设置的演示后，您可能需要清理所有创建的资源、数据集和已创建的笔记本。
要删除单个演示及其关联资源，请先将 load_demo() 的结果分配给变量（例如 demo），然后对其调用 teardown()。
demo.teardown()
要删除已设置的所有演示和任何关联资源，请调用 teardown() 作为顶级函数。
teardown()