設定 Amazon SageMaker 合作夥伴 AI 應用程式 SDK - Amazon SageMaker AI
CometFiddlerDeepchecksLakera

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

設定 Amazon SageMaker 合作夥伴 AI 應用程式 SDK

下列主題概述搭配 Amazon SageMaker 合作夥伴 AI 應用程式安裝和使用應用程式特定 SDK 所需的程序。若要為應用程式安裝和使用 SDKs，您必須指定合作夥伴 AI 應用程式特有的環境變數，以便應用程式的 SDK 可以挑選環境變數並觸發授權。以下各節提供為每個支援的應用程式類型完成此操作所需步驟的相關資訊。

Comet

Comet 提供兩種產品：

  • Opik 是來源 LLM 評估架構。

  • Comet 的 ML 平台可以用來追蹤、比較、解釋和最佳化整個 ML 生命週期的模型。

Comet 支援根據您與其互動的產品使用兩種不同的 SDK。請完成下列程序來安裝和使用 Comet 或 Opik SDK。如需 Comet SDK 的詳細資訊，請參閱快速入門。如需 Opik SDK 的詳細資訊，請參閱開放原始碼 LLM 評估架構。

  1. 啟動您在其中使用 Comet 或 Opik SDK 搭配合作夥伴 AI 應用程式的環境。如需啟動 JupyterLab 應用程式的相關資訊，請參閱 建立空間。如需啟動程式碼編輯器 (以 Code-OSS、Visual Studio Code - Open Source 應用程式為基礎) 的相關資訊，請參閱 在 Studio 中啟動程式碼編輯器應用程式。

  2. 啟動 Jupyter 筆記本或程式碼編輯器空間。

  3. 從開發環境中，安裝相容的 Comet、Opik 和 SageMaker Python SDK 版本。若要相容：

    • SageMaker Python SDK 版本必須至少為 2.237.0。

    • Comet SDK 版本必須是最新版本。

    • Opik SDK 版本必須符合 Opik 應用程式所使用的版本。驗證 Opik Web 應用程式 UI 中使用的 Opik 版本。例外狀況是在 Opik 應用程式版本為 1.1.5 時，Opik SDK 版本必須至少為 1.2.0。

    注意

    SageMaker JupyterLab 隨附已安裝的 SageMaker Python SDK。不過，如果版本低於 2.237.0，您可能需要升級 SageMaker Python SDK。

    %pip install sagemaker>=2.237.0 comet_ml

##or

%pip install sagemaker>=2.237.0 opik=<compatible-version>

  4. 為應用程式資源 ARN 設定下列環境變數。這些環境變數用來與 Comet 和 Opik SDK 通訊。若要擷取這些值，請導覽至 Amazon SageMaker Studio 中應用程式的詳細資訊頁面。

    os.environ['AWS_PARTNER_APP_AUTH'] = 'true'
os.environ['AWS_PARTNER_APP_ARN'] = '<partner-app-ARN>'

  5. 對於 Comet 應用程式，SDK URL 會自動包含為以下步驟中設定的 API 金鑰一部分。您可以改為設定 COMET_URL_OVERRIDE 環境變數來手動覆寫 SDK URL。

    os.environ['COMET_URL_OVERRIDE'] = '<comet-url>'

  6. 對於 Opik 應用程式，SDK URL 會自動包含為以下步驟中設定的 API 金鑰一部分。您可以改為設定 OPIK_URL_OVERRIDE 環境變數來手動覆寫 SDK URL。若要取得 Opik 工作區名稱，請參閱 Opik 應用程式並導覽至使用者的工作區。

    os.environ['OPIK_URL_OVERRIDE'] = '<opik-url>'
os.environ['OPIK_WORKSPACE'] = '<workspace-name>'

  7. 設定可識別 Comet 或 Opik API 金鑰的環境變數。這用來在使用 Comet 和 Opik SDK 時，驗證從 SageMaker 到應用程式的連線。此 API 金鑰為應用程式特有的，且不是由 SageMaker 管理。若要取得此金鑰，您必須登入應用程式並擷取 API 金鑰。Opik API 金鑰與 Comet API 金鑰相同。

    os.environ['COMET_API_KEY'] = '<API-key>'
os.environ["OPIK_API_KEY"] = os.environ["COMET_API_KEY"]

Fiddler

完成下列程序來安裝和使用 Fiddler Python 用戶端。如需 Fiddler Python 用戶端的資訊，請參閱關於用戶端 3.x。

  1. 啟動您使用 Fiddler Python 用戶端搭配合作夥伴 AI 應用程式所在的筆記本環境。如需啟動 JupyterLab 應用程式的相關資訊，請參閱建立空間。如需啟動程式碼編輯器 (以 Code-OSS、Visual Studio Code - Open Source 應用程式為基礎) 的相關資訊，請參閱 在 Studio 中啟動程式碼編輯器應用程式。

  2. 啟動 Jupyter 筆記本或程式碼編輯器空間。

  3. 從開發環境中，安裝 Fiddler Python 用戶端和 SageMaker Python SDK 版本。若要相容：

    • SageMaker Python SDK 版本必須至少為 2.237.0。

    • Fiddler Python 用戶端版本必須與應用程式中使用的 Fiddler 版本相容。從 UI 驗證 Fiddler 版本後，請參閱 Fiddler 相容性對照表以取得相容 Fiddler Python 用戶端版本。

    注意

    SageMaker JupyterLab 隨附已安裝的 SageMaker Python SDK。不過，如果版本低於 2.237.0，您可能需要升級 SageMaker Python SDK。

    %pip install sagemaker>=2.237.0 fiddler-client=<compatible-version>

  4. 針對應用程式資源 ARN 和 SDK URL 設定下列環境變數。這些環境變數用來與 Fiddler Python 用戶端通訊。若要擷取這些值，請導覽至 Amazon SageMaker Studio 中 Fiddler 應用程式的詳細資訊頁面。   

    os.environ['AWS_PARTNER_APP_AUTH'] = 'true'
os.environ['AWS_PARTNER_APP_ARN'] = '<partner-app-ARN>'
os.environ['AWS_PARTNER_APP_URL'] = '<partner-app-URL>'

  5. 設定可識別 Fiddler 應用程式 API 金鑰的環境變數。這用來在使用 Fiddler Python Client 時，驗證從 SageMaker 到 Fiddler 應用程式的連線。此 API 金鑰為應用程式特有的，且不是由 SageMaker 管理。若要取得此金鑰，您必須登入 Fiddler 應用程式並擷取 API 金鑰。

    os.environ['FIDDLER_KEY'] = '<API-key>'

Deepchecks

完成下列程序以安裝和使用 Deepchecks Python SDK。

  1. 啟動您使用 Deepchecks Python SDK 搭配合作夥伴 AI 應用程式所在的筆記本環境。如需啟動 JupyterLab 應用程式的相關資訊，請參閱 建立空間。如需啟動程式碼編輯器 (以 Code-OSS、Visual Studio Code - Open Source 應用程式為基礎) 的相關資訊，請參閱 在 Studio 中啟動程式碼編輯器應用程式。

  2. 啟動 Jupyter 筆記本或程式碼編輯器空間。

  3. 從開發環境中，安裝相容的 Deepchecks Python SDK 和 SageMaker Python SDK 版本。  合作夥伴 AI 應用程式執行的是版本 0.21.15 的 Deepchecks。若要相容：

    • SageMaker Python SDK 版本必須至少為 2.237.0。

    • Deepchecks Python SDK 必須使用次要版本 0.21。

    注意

    SageMaker JupyterLab 隨附已安裝的 SageMaker Python SDK。不過，如果版本低於 2.237.0，您可能需要升級 SageMaker Python SDK。

    %pip install sagemaker>=2.237.0 deepchecks-llm-client>=0.21,<0.22

  4. 針對應用程式資源 ARN 和 SDK URL 設定下列環境變數。這些環境變數用來與 Deepchecks Python SDK 通訊。若要擷取這些值，請導覽至 Amazon SageMaker Studio 中應用程式的詳細資訊頁面。   

    os.environ['AWS_PARTNER_APP_AUTH'] = 'true'
os.environ['AWS_PARTNER_APP_ARN'] = '<partner-app-ARN>'
os.environ['AWS_PARTNER_APP_URL'] = '<partner-app-URL>'

  5. 設定可識別 Deepchecks 應用程式 API 金鑰的環境變數。這用來在使用 Deepchecks Python SDK 時，驗證從 SageMaker 到 Deepchecks 應用程式的連線。此 API 金鑰是應用程式特有的，並非由 SageMaker 管理。若要取得此金鑰，請參閱設定：Python SDK 安裝和 API 金鑰擷取。

    os.environ['DEEPCHECKS_API_KEY'] = '<API-key>'

Lakera

Lakera 不提供 SDK。反之，您可以透過任何程式設計語言對可用端點提出 HTTP 請求來與 Lakera Guard API 互動。如需詳細資訊，請參閱 Lakera Guard API。

若要使用 SageMaker Python SDK搭配 Lakera，請完成下列步驟：

  1. 啟動您要在其中使用合作夥伴 AI 應用程式的環境。如需啟動 JupyterLab 應用程式的相關資訊，請參閱 建立空間。如需啟動程式碼編輯器 (以 Code-OSS、Visual Studio Code - Open Source 應用程式為基礎) 的相關資訊，請參閱 在 Studio 中啟動程式碼編輯器應用程式。

  2. 啟動 Jupyter 筆記本或程式碼編輯器空間。

  3. 從開發環境中，安裝相容的 SageMaker Python SDK 版本。SageMaker Python SDK 版本必須至少為 2.237.0

    注意

    SageMaker JupyterLab 隨附已安裝的 SageMaker Python SDK。不過，如果版本低於 2.237.0，您可能需要升級 SageMaker Python SDK。

    %pip install sagemaker>=2.237.0

  4. 針對應用程式資源 ARN 和 SDK URL 設定下列環境變數。若要擷取這些值，請導覽至 Amazon SageMaker Studio 中應用程式的詳細資訊頁面。

    os.environ['AWS_PARTNER_APP_ARN'] = '<partner-app-ARN>'
os.environ['AWS_PARTNER_APP_URL'] = '<partner-app-URL>'