使用 Papermill 建立參數化筆記本

重要

Azure Data Studio 將於 2026 年 2 月 28 日停用。 建議您使用 Visual Studio Code 的 MSSQL 延伸模組。 如需移轉至 Visual Studio Code 的詳細資訊，請流覽 Azure Data Studio 發生什麼事？

Azure Data Studio 中的參數化是使用不同的參數集來執行相同的筆記本檔案。

本文說明如何使用 Python 核心在 Azure Data Studio 中建立和執行參數化筆記本。

Note

目前，您可以搭配 Python、PySpark、PowerShell 和 .NET 互動式核心使用參數化。

Prerequisites

• Azure Data Studio
• Python

在 Azure Data Studio 中安裝和設定 Papermill

本節中的所有步驟都會在 Azure Data Studio 筆記本內執行。

1. 建立新的筆記本。 將 核心 變更為 Python 3：

   

2. 如果系統提示您在套件需要更新時升級 Python 套件，請選取 [ 是]：

   

3. 安裝造紙廠：

   import sys
   !{sys.executable} -m pip install papermill --no-cache-dir --upgrade
   

   確認已安裝 Papermill：

   import sys
   !{sys.executable} -m pip list
   

   

4. 若要確認 Papermill 已正確安裝，請檢查 Papermill 的版本：

   import papermill
   papermill
   

   

參數化範例

您可以使用 範例筆記本檔案 來完成本文中的步驟：

1. 移至 GitHub 中的筆記本檔案。 選取 [原始]。
2. 選取 Ctrl+S 或按一下滑鼠右鍵，然後儲存副檔名為 .ipynb 的檔案。
3. 在 Azure Data Studio 中開啟檔案。

設定參數化筆記本

您可以從在 Azure Data Studio 中開啟的範例筆記本開始，或完成下列步驟來建立筆記本。 然後，嘗試使用不同的參數。 所有步驟都會在 Azure Data Studio 筆記本內執行。

1. 確認 核心已 設定為 Python 3：

   

2. 建立新的程式碼儲存格。 選取 參數 將 儲存格標記為參數儲存格。

   x = 2.0
   y = 5.0
   

   

3. 新增其他儲存格以測試不同的參數：

   addition = x + y
   multiply = x * y
   

   print("Addition: " + str(addition))
   print("Multiplication: " + str(multiply))
   

   執行所有儲存格之後，輸出將類似以下範例：

   

4. 將筆記本另存為 Input.ipynb：

   

執行 Papermill 筆記本

您可以透過兩種方式執行 Papermill：

• 命令列介面 （CLI）
• Python API

參數化 CLI 執行

若要使用 CLI 執行筆記本，請在終端機中輸入 papermill 包含輸入筆記本的命令、輸出筆記本的位置及選項。

Note

若要深入瞭解，請參閱 Papermill CLI 文件。

1. 使用新參數執行輸入筆記本：

   papermill Input.ipynb Output.ipynb -p x 10 -p y 20
   

   此指令會使用參數 x 和 y 的新值執行輸入筆記本。

2. 標示的新 # Injected-Parameters 儲存格包含透過 CLI 傳入的新參數值。 新 # Injected-Parameters 值會用於最後一個儲存格中顯示的新輸出：

   

參數化 Python API 執行

Note

若要深入瞭解，請參閱 Papermill Python 文件。

1. 建立新的筆記本。 將 核心 變更為 Python 3：

   

2. 新增程式碼儲存格。 然後，使用 Papermill Python API 執行並產生輸出參數化筆記本：

   import papermill as pm
   
   pm.execute_notebook(
   '/Users/vasubhog/GitProjects/AzureDataStudio-Notebooks/Demo_Parameterization/Input.ipynb',
   '/Users/vasubhog/GitProjects/AzureDataStudio-Notebooks/Demo_Parameterization/Output.ipynb',
   parameters = dict(x = 10, y = 20)
   )
   

   

3. 標示的新 # Injected-Parameters 儲存格包含傳入的新參數值。 新 # Injected-Parameters 值會用於最後一個儲存格中顯示的新輸出：

   

後續步驟

深入瞭解筆記型電腦和參數設置：

• 如何在 Azure Data Studio 中使用筆記本
• 造紙廠參數化文件
• URI 參數化
• 使用參數執行