如何为Vertex AI Pipeline的PipelineJobSchedule添加自定义标签

你直接在PipelineJob中设置labels不会同步到PipelineJobSchedule上，因为两者的标签是独立配置的，需要在创建PipelineJobSchedule或调用其create方法时单独指定标签参数。以下是两种有效实现方式：

方法一：初始化PipelineJobSchedule时传入标签 #

# 初始化PipelineJob（无需在此设置labels，除非需要给单次运行的任务实例加标签）
pipeline_job = aiplatform.PipelineJob(
  template_path="COMPILED_PIPELINE_PATH",
  pipeline_root="PIPELINE_ROOT_PATH",
  display_name="DISPLAY_NAME"
)

# 初始化调度时直接传入自定义标签（注意是字典格式，不是字符串）
pipeline_job_schedule = aiplatform.PipelineJobSchedule(
  pipeline_job=pipeline_job,
  display_name="SCHEDULE_NAME",
  labels={"name": "test_xx", "env": "production"}
)

pipeline_job_schedule.create(
  cron="TZ=CRON",
  max_concurrent_run_count=MAX_CONCURRENT_RUN_COUNT,
  max_run_count=MAX_RUN_COUNT,
)

方法二：在create方法中传入标签 #

如果需要在调度创建的最后一步指定标签，也可以在create方法中添加参数：

pipeline_job = aiplatform.PipelineJob(
  template_path="COMPILED_PIPELINE_PATH",
  pipeline_root="PIPELINE_ROOT_PATH",
  display_name="DISPLAY_NAME"
)

pipeline_job_schedule = aiplatform.PipelineJobSchedule(
  pipeline_job=pipeline_job,
  display_name="SCHEDULE_NAME"
)

# 在创建调度时传入标签
pipeline_job_schedule.create(
  cron="TZ=CRON",
  max_concurrent_run_count=MAX_CONCURRENT_RUN_COUNT,
  max_run_count=MAX_RUN_COUNT,
  labels={"name": "test_xx", "team": "data-science"}
)

关键注意事项 #

• labels必须是Python字典类型，不能是字符串（你之前代码里用字符串格式的标签是无效原因之一）
• PipelineJob的标签仅作用于单次运行的任务实例，PipelineJobSchedule的标签作用于调度本身，两者相互独立
• 标签键只能包含小写字母、数字、连字符、下划线和点，长度不超过63字符；值长度不超过63字符，可包含任意合法字符

内容的提问来源于stack exchange，提问作者Rituraj kumar