View a markdown version of this page

设置 Amazon SageMaker 合作伙伴 AI 应用程序软件开发工具包 - 亚马逊 SageMaker AI
CometFiddlerDeepchecksLakera

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

设置 Amazon SageMaker 合作伙伴 AI 应用程序软件开发工具包

以下主题概述了在 Amazon P SageMaker artner AI 应用程序中安装和使用特定于应用程序的软件开发工具包所需的流程。要安装和使用应用程序 SDK，必须指定特定于合作伙伴 AI 应用程序的环境变量，以便应用程序 SDK 能够获取这些环境变量并触发授权流程。以下各部分介绍了为每种受支持的应用程序类型完成此操作所需的步骤。

Comet

Comet 提供了两款产品：

  • Opik 是一个开源 LLM 评估框架。

  • Comet 的机器学习平台可用于在整个机器学习生命周期中跟踪、比较、解释和优化模型。

Comet 支持根据您正在与之交互的产品使用两种不同的 SDK。完成以下过程可安装和使用 Comet 或 Opik SDK。有关 Comet SDK 的更多信息，请参阅快速入门。有关 Opik SDK 的更多信息，请参阅开源 LLM 评估框架。

  1. 启动您正在其中将 Comet SDK 或 Opik SDK 与合作伙伴 AI 应用程序结合使用的环境。有关启动JupyterLab 应用程序的信息，请参阅创建空间。有关启动基于 Visual Studio Code-开源应用程序的代码编辑器的信息，请参见在 Studio 中启动代码编辑器应用程序。 Code-OSS

  2. 启动 Jupyter Notebook 或代码编辑器空间。

  3. 在开发环境中，安装兼容的 Comet、Opik 和 Pyth SageMaker on SDK 版本。要确保兼容，必须满足以下条件：

    • SageMaker Python 软件开发工具包的版本必须至少为2.237.0。

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

    • Opik SDK 版本必须与您的 Opik 应用程序所使用的版本匹配。确认 Opik Web 应用程序用户界面中使用的 Opik 版本。例外情况是，当 Opik 应用程序版本为 1.1.5 时，Opik SDK 版本必须至少为 1.2.0。

    注意

    SageMaker JupyterLab 自带安装的 SageMaker Python 软件开发工具包。但是，如果 SageMaker Python SDK 的版本低于，则可能需要升级2.237.0。

    %pip install sagemaker>=2.237.0 comet_ml

##or

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

  4. 为应用程序资源 ARN 设置以下环境变量。这些环境变量用于与 Comet SDK 和 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. 启动你正在使用带有合作伙伴 AI 应用程序的 Fiddler Python 客户端的笔记本环境。 有关启动JupyterLab 应用程序的信息，请参阅创建空间。有关启动基于 Visual Studio Code-开源应用程序的代码编辑器的信息，请参见在 Studio 中启动代码编辑器应用程序。 Code-OSS

  2. 启动 Jupyter Notebook 或代码编辑器空间。

  3. 在开发环境中，安装 Fiddler Python 客户端和 Python SD SageMaker K 版本。要确保兼容，必须满足以下条件：

    • SageMaker Python 软件开发工具包的版本必须至少为2.237.0。

    • Fiddler Python 客户端版本必须与应用程序中使用的 Fiddler 版本兼容。在用户界面中确认 Fiddler 版本后，请参阅 Fiddler 兼容性矩阵以获取兼容的 Fiddler Python 客户端版本。

    注意

    SageMaker JupyterLab 自带安装的 SageMaker Python 软件开发工具包。但是，如果 SageMaker Python SDK 的版本低于，则可能需要升级2.237.0。

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

  4. 为应用程序资源 ARN 和 SDK URL 设置以下环境变量。这些环境变量用于与 Fiddler Python 客户端进行通信。要检索这些值，请导航至 Ama SageMaker zon 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 SageMaker 客户端时，这用于验证与 Fiddler 应用程序的连接。此 API 密钥是特定于应用程序的，不由管理。 SageMaker 要获取此密钥，您必须登录 Fiddler 应用程序并检索 API 密钥。

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

Deepchecks

完成以下过程可安装和使用 Deepchecks Python SDK。

  1. 启动您在其中将 Deepchecks Python SDK 与合作伙伴 AI 应用程序结合使用的笔记本环境。有关启动JupyterLab 应用程序的信息，请参阅创建空间。有关启动基于 Visual Studio Code-开源应用程序的代码编辑器的信息，请参阅在 Studio 中启动代码编辑器应用程序。 Code-OSS

  2. 启动 Jupyter Notebook 或代码编辑器空间。

  3. 在开发环境中，安装兼容的 Deepchecks Python SDK 和 Py SageMaker thon SDK 版本。  合作伙伴 AI 应用程序正在运行版本 0.21.15 的 Deepchecks。要确保兼容，必须满足以下条件：

    • SageMaker Python 软件开发工具包的版本必须至少为2.237.0。

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

    注意

    SageMaker JupyterLab 自带安装的 SageMaker Python 软件开发工具包。但是，如果 SageMaker Python SDK 的版本低于，则可能需要升级2.237.0。

    %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 时，这用于验证与 Deepchecks 应用程序的连接。 SageMaker 此 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 应用程序的信息，请参阅创建空间。有关启动基于 Visual Studio Code-开源应用程序的代码编辑器的信息，请参阅在 Studio 中启动代码编辑器应用程序。 Code-OSS

  2. 启动 Jupyter Notebook 或代码编辑器空间。

  3. 在开发环境中，安装兼容的 SageMaker Python 开发工具包版本。P SageMaker ython 软件开发工具包版本必须至少为 2.237.0

    注意

    SageMaker JupyterLab 自带安装的 SageMaker Python 软件开发工具包。但是，如果 SageMaker Python SDK 的版本低于，则可能需要升级2.237.0。

    %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>'