使用 Python 版 Vertex AI SDK

Python 版 Vertex AI SDK 可帮助您自动执行数据提取和训练模型，以获取 Vertex AI 预测结果。SDK 使用 Python 代码访问 Vertex AI API，以便您可以通过编程方式完成可在 Vertex AI 控制台中执行的操作。

为何使用 Vertex AI SDK

如果您是经验丰富的机器学习 (ML) 和人工智能 (AI) 工程师或数据科学家，希望以编程方式自动执行您的工作流，建议您使用 SDK。Python 版 Vertex AI SDK 类似于 Vertex AI Python 客户端库，但 SDK 级别更高且更精细。如需了解详情，请参阅了解 SDK 和客户端库的区别。

安装 Vertex AI SDK

安装 Python 版 Vertex AI SDK 包括以下步骤：

1. 创建一个隔离的 Python 环境
2. 安装 Vertex AI SDK 软件包
3. 初始化 Vertex AI SDK

创建一个隔离的 Python 环境

Python 最佳做法是在每个项目的独立 Python 环境中安装 Vertex AI SDK。这有助于防止依赖项、版本和权限冲突。您可以创建隔离的环境，以在 shell 中使用命令行或使用笔记本。

如需在使用命令行时创建隔离的环境，请激活 venv 环境。激活 venv 环境后，您就可以安装 Vertex AI SDK 并运行 Python 脚本了。如需了解详情，请参阅使用 venv 隔离依赖项和设置 Python 开发环境。

如需将笔记本用于隔离的环境，请创建笔记本实例。创建笔记本实例后，请使用该实例来安装 Vertex AI SDK 并运行您的 Python 脚本。如需了解详情，请参阅创建用户管理的笔记本实例。

安装 Vertex AI SDK 软件包

如需安装 Vertex AI SDK，请在虚拟环境中运行以下命令：

pip install google-cloud-aiplatform

初始化 Vertex AI SDK

安装 Python 版 Vertex AI SDK 后，您必须使用 Vertex AI 和 Google Cloud 详细信息初始化 SDK。例如，初始化 SDK 时，您可以指定项目名称、区域和暂存 Cloud Storage 存储桶等信息。以下示例展示了初始化 Vertex AI SDK 的方法。

def init_sample(
    project: Optional[str] = None,
    location: Optional[str] = None,
    experiment: Optional[str] = None,
    staging_bucket: Optional[str] = None,
    credentials: Optional[auth_credentials.Credentials] = None,
    encryption_spec_key_name: Optional[str] = None,
):

    from google.cloud import aiplatform

    aiplatform.init(
        project=project,
        location=location,
        experiment=experiment,
        staging_bucket=staging_bucket,
        credentials=credentials,
        encryption_spec_key_name=encryption_spec_key_name,
    )

使用 Vertex AI SDK 编写代码

如需使用 Python 版 Vertex AI SDK，您必须添加一行代码来导入其命名空间。接下来，使用 Vertex AI SDK 参考文档和代码示例了解其类、方法和属性。

导入 Vertex AI SDK 命名空间

Python 版 Vertex AI SDK 使用 google.cloud.aiplatform 命名空间。如需访问 SDK 的功能，请通过将以下行添加到 Python 代码来导入此命名空间：

from google.cloud import aiplatform

了解 Vertex AI SDK

Python 版 Vertex AI SDK 参考文档记录了 Python 版 Vertex AI SDK 功能。此参考文档包括类定义、方法、属性以及使用 Vertex AI SDK 以编程方式自动执行 Vertex AI 所需的所有其他内容。如需了解详情，请参阅 Vertex AI SDK 参考文档。

试用代码示例和教程

Jupyter 笔记本教程介绍了如何在较大的工作流中使用 Python 版 Vertex AI SDK。如需了解详情，请参阅 Vertex AI 笔记本教程。

Python 版 Vertex AI SDK GitHub 代码库中的代码示例展示如何完成各项任务。如需了解详情，请参阅 Python 版 Vertex AI SDK GitHub 代码库。

如需查看在更全面的工作流中使用 Vertex AI SDK 的示例，请在以下任一环境中运行“自定义训练和在线预测”Jupyter 笔记本：

在 Colab 中运行 | 在 Vertex AI Workbench 用户管理的笔记本中打开 | 在 GitHub 上查看

了解 SDK 和客户端库的区别

安装 Python 版 Vertex AI SDK 时，会同时安装 Vertex AI Python 客户端库。Vertex AI SDK 和 Vertex AI Python 客户端库具有粒度级别不同的类似功能。Vertex AI SDK 以比客户端库更高的抽象层运行，适合大多数常见的数据科学工作流。如果您需要较低级别的功能，请使用 Vertex AI Python 客户端库。

Vertex AI SDK 适用于 Python，Vertex AI 客户端库适用于 Python、Java 和 Node.js。如需了解如何安装 Java 或 Node.js 客户端库，请参阅安装 Vertex AI 客户端库。如果您的首选编程语言不支持客户端库，则可以使用 Vertex AI REST API。如需了解详情，请参阅 Vertex AI REST 参考文档。

结合使用 Vertex AI Python 客户端库和 SDK

如果您使用 Python 版 Vertex AI SDK，并且发现需要更大的灵活性或控制力，或者需要 SDK 中未包含的方法，则可以在同一工作流中使用 Vertex AI Python 客户端库。Vertex AI Python 客户端库使用不同的命名空间来访问 Vertex AI API。可以在同一 Python 脚本中使用客户端库和 Python SDK 命名空间，方法是在 Python 脚本中分别为它们库添加 import 行。

如需了解 Vertex AI SDK 命名空间，请参阅本页面前面的导入 Vertex AI SDK 命名空间。

导入 Vertex AI Python 客户端库命名空间

Vertex AI Python 客户端库命名空间为 google.cloud.aiplatform.gapic。此命名空间映射到 google.cloud.aiplatform_v1 命名空间。这两个命名空间可以互换使用。如需导入 Python 客户端库，请在 Python 脚本中添加以下任一项：

from google.cloud import aiplatform_gapic

from google.cloud import aiplatform_v1

后续步骤

• 了解如何选择训练方法。