如何通过Vertex AI SDK将VS Code连接至Vertex AI Workbench并运行代码？

前提准备 #

• 本地VS Code已安装Python插件和Google Cloud Code插件（后者简化GCP相关操作）
• 本地已安装Google Cloud SDK（gcloud命令行工具）并完成初始化认证
• 已安装Vertex AI SDK for Python：pip install google-cloud-aiplatform

步骤1：同步Workbench笔记本到本地 #

• 打开Vertex AI Workbench的目标笔记本，点击右上角下载按钮，将.ipynb文件保存到VS Code工作目录
• 若Workbench实例关联了云存储或Git仓库，也可通过gcloud命令克隆实例文件：

  gcloud compute scp --recurse [INSTANCE_NAME]:[REMOTE_NOTEBOOK_PATH] [LOCAL_SAVE_PATH] --zone [INSTANCE_ZONE]
  

  替换括号内的实例名、远程路径、本地路径和区域为实际信息

步骤2：配置本地认证与Python环境 #

• 在VS Code中打开下载的笔记本，切换到已安装Vertex AI SDK的Python解释器（右下角可选择）
• 在VS Code终端运行以下命令完成GCP授权，让本地代码可访问GCP资源：

  gcloud auth application-default login
  

  按照提示在浏览器完成登录授权即可

步骤3：适配代码用于本地运行 #

• 原Workbench笔记本可能依赖默认项目配置，需在代码开头添加SDK初始化代码：

  import google.cloud.aiplatform as aiplatform
  
  # 初始化SDK，指定你的GCP项目ID和区域
  aiplatform.init(
      project="[YOUR_PROJECT_ID]",
      location="[YOUR_REGION]"  # 示例：us-central1
  )
  

• 若代码引用了Workbench实例的本地文件，需替换为本地文件路径，或把文件上传到GCS（云存储），通过SDK的GCS方法访问

步骤4：在VS Code中运行代码 #

• 直接在VS Code的Jupyter交互窗口逐单元格运行，或点击顶部运行全部按钮
• 调用Vertex AI服务（如训练模型、部署端点）时，SDK会通过已认证的账号访问GCP资源，运行效果与Workbench一致

注意事项 #

• 确保本地Python版本与Workbench实例的Python版本匹配，避免依赖版本冲突
• 敏感信息（如项目ID）建议通过环境变量或gcloud命令动态获取，不要硬编码：

  import os
  project_id = os.environ.get("GOOGLE_CLOUD_PROJECT") or !gcloud config get-value project
  

• 如需持续同步代码，可使用Git管理：在Workbench中提交代码到仓库，本地拉取更新即可

内容的提问来源于stack exchange，提问作者Nitya Rakhe