使用 KFP 命令行工具

本节提供了KFP CLI中可用命令的摘要。有关KFP CLI中所有可用命令的更全面文档，请参见命令行接口在KFP SDK参考文档中。

安装

KFP CLI在您安装KFP SDK时安装： pip install kfp。

检查 KFP CLI 的可用性

要检查您的环境中是否安装了 KFP CLI，请运行以下命令：

kfp --version

通用语法

KFP CLI中的所有命令都使用以下一般语法：

kfp [OPTIONS] COMMAND [ARGS]...

例如，要列出特定端点的所有运行，可以运行以下命令：

kfp --endpoint http://my_kfp_endpoint.com run list

获取命令帮助

要获取特定命令的帮助，请在命令行中直接使用参数 --help。例如，要查看关于 kfp run 命令的指导，请输入以下命令：

kfp run --help

KFP CLI的主要功能

您可以使用 KFP CLI 完成以下操作：

• 安装
  • 检查 KFP CLI 的可用性
  • 通用语法
  • 获取命令帮助
• KFP CLI的主要功能
  • 与KFP资源交互
  • 编译管道
  • 构建容器化的 Python 组件
    • 开始之前
    • 构建组件

与KFP资源互动

大多数 KFP CLI 命令允许您从 KFP 后端创建、读取、更新或删除 KFP 资源。所有这些命令都使用以下通用语法：

kfp <resource_name> <action>

参数可以是以下之一：

• run
• recurring-run
• pipeline
• experiment

对于参数的所有值，参数可以是以下之一：

• create
• list
• get
• delete

某些资源名称具有附加的特定资源操作。以下表格列出了一些特定资源操作的例子：

编译管道

您可以使用 kfp dsl compile 命令将定义在 Python 文件中的管道或组件编译为 IR YAML。

• 要编译在 Python 文件中定义的管道定义，请运行以下命令。

  kfp dsl compile --py [PATH_TO_INPUT_PYTHON] --output [PATH_TO_OUTPUT_YAML] --function [PIPELINE_NAME]
  

  例如：

  kfp dsl compile --py path/to/pipeline.py --output path/to/output.yaml
  

  要从包含多个管道或组件定义的 Python 文件中编译单个管道或组件，请使用 --function 参数。

  例如：

  kfp dsl compile --py path/to/pipeline.py --output path/to/output.yaml --function my_pipeline
  

  kfp dsl compile --py path/to/pipeline.py --output path/to/output.yaml --function my_component
  

• 要指定管道参数，请使用 --pipeline-parameters 参数并以 JSON 格式提供参数。

  kfp dsl compile [PATH_TO_INPUT_PYTHON] --output [PATH_TO_OUTPUT_YAML] --pipeline-parameters [PIPELINE_PARAMETERS_JSON]
  

  例如：

  kfp dsl compile --py path/to/pipeline.py --output path/to/output.yaml --pipeline-parameters '{"param1": 2.0, "param2": "my_val"}'
  

构建容器化的 Python 组件

您可以在 KFP SDK 中创建 容器化的 Python 组件。这使您可以处理更多源代码，并比更简单的 轻量级 Python 组件 创建体验有更好的代码组织。

开始之前

运行以下命令以安装带有额外 Docker 依赖项的 KFP SDK：

pip install kfp[all]

构建组件

要构建一个容器化的 Python 组件，请在 KFP CLI 中使用以下便捷命令。使用此命令，您可以构建一个包含在 COMPONENTS_DIRECTORY 中找到的所有源代码的镜像。该命令将目录中找到的组件作为组件运行时入口点。

kfp component build [OPTIONS] [COMPONENTS_DIRECTORY] [ARGS]...

例如：

kfp component build src/ --component-filepattern my_component --push-image

有关kfp component build命令所支持的参数和标志的更多信息，请参见build中的KFP SDK API参考。有关创建容器化Python组件的更多信息，请参见编写Python容器化组件。