Snowflake Python Demos API¶

安装 Snowflake Demos 库¶

您可以安装 Snowflake Demos 库，以便与 Conda 或虚拟环境一起使用。要设置该库，请执行以下步骤：

1. 激活 Python 环境。

2. 要安装该库，请运行以下 pip install 命令：

   pip install snowflake.demos
   

   Copy

设置默认 Snowflake 连接¶

Snowflake Demos API 使用 Snowflake Python Connector 的默认连接。要配置此连接，请按照 设置默认连接 中的说明进行操作。

例如，要将命名连接指定为 Snowflake config.toml 文件中的默认连接，请按如下方式将默认连接名称添加到 config.toml 文件中：

default_connection_name = '<connection_name>'

有关在 TOML 配置文件中指定连接定义的信息，请参阅 使用 connections.toml 文件进行连接。

导入 snowflake.demos¶

要在终端中使用该库，可以打开一个交互式 shell，如标准 Python REPL。

1. 运行以下命令（可能因 Python 环境而异）：

   python3
   

   Copy

2. 在 REPL 会话中，通过运行以下代码来导入库和相关函数：

   from snowflake.demos import help, load_demo, teardown
   

   Copy

当前可用演示列表¶

Snowflake Demos API 目前可与以下演示列表配合使用：

加载并浏览演示¶

• 要加载特定的演示并在 Snowflake 中设置其关联资源，请使用一个实参调用 load_demo()，指定任何可用演示的 demo_name，如 help() 输出中所示。

  例如：

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

  Copy

此函数执行以下操作：

• 如果这是您第一次加载演示，则创建与 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...✅

查看演示 URL¶

您可以使用 show() 函数查看演示中特定步骤的 URL。

• 要查看当前步骤的 URL，首先将 load_demo() 的结果分配给变量（例如 demo），然后在不使用实参的情况下调用 show()：

  demo.show()
  

  Copy

  输出应类似于以下内容：

  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)
  

  Copy

• 要在多步骤演示的下个步骤中获取笔记本 URL，请使用 show_next() 函数：

  demo.show_next()
  

  Copy

删除演示及其资源¶

浏览完所设置的演示后，您可能需要清理所有创建的资源、数据集和已创建的笔记本。

• 要删除单个演示及其关联资源，请先将 load_demo() 的结果分配给变量（例如 demo），然后对其调用 teardown()：

  demo.teardown()
  

  Copy

• 要删除已设置的所有演示和任何关联资源，请调用 teardown() 作为顶级函数：

  teardown()
  

  Copy