stage list

列出项目中的阶段。

概要

usage: dvc stage list [-h] [-q | -v]
                      [-R] [--all] [--fail] [--name-only]
                      [targets ...]

positional arguments:
  targets       Limit command scope to these dvc.yaml files,
                directories (with -R), or stage names.
                './dvc.yaml' by default.

详见 targets。

描述

打印包含阶段名称及其一行描述的列表（可使用 --name-only 忽略描述）。此命令有助于发现或审查项目中存在哪些阶段，而无需手动检查 dvc.yaml 文件。

若未指定任何 targets，dvc stage list 默认列出当前工作目录下的 ./dvc.yaml 中的阶段。

阶段描述从 dvc.yaml 中的 desc 字段读取（若存在，截断至 80 个字符）；否则，DVC 会根据阶段最重要的特征（依赖项、输出或指标）自动生成描述。

选项

• targets（可选命令参数）- 要列出的阶段位置（默认为 ./dvc.yaml）。示例如下：

  • dvc stage list linear/dvc.yaml：一个 dvc.yaml 文件
  • dvc stage list -R pipelines/：递归搜索目录中的阶段
  • dvc stage list train-model：来自 ./dvc.yaml 的特定阶段
  • dvc stage list modeling/dvc.yaml:prepare：来自特定 dvc.yaml 文件的阶段
  • dvc stage list train-model@1：来自 ./dvc.yaml 的 Foreach 阶段

• --name-only - 仅列出阶段名称。适用于脚本编写（DVC 用于 Shell 标签补全）。

• -R, --recursive - 通过递归搜索每个目标目录及其子目录中的 dvc.yaml 文件来确定要列出的文件。若 targets 中不包含目录，此选项无效。

• --all - 列出仓库中所有 dvc.yaml 文件中的所有阶段（忽略任何指定的 targets）。

• --fail - 若任一目标 dvc.yaml 文件无效，则立即失败。默认情况下会跳过这些错误。仅在使用 -R 或 --all 时生效。

• -h, --help - 打印使用说明/帮助信息，然后退出。

• -q, --quiet - 不向标准输出写入任何内容。如果没有问题则以 0 退出，否则以 1 退出。

• -v, --verbose - 显示详细的跟踪信息。

示例：

默认行为是列出 ./dvc.yaml 中的阶段：

$ dvc stage list
prepare    Outputs data/prepared
featurize  Outputs data/features
train      Outputs model.pkl
evaluate   Reports scores.json, prc.json, roc.json

在此情况下，所有描述均由 DVC 自动生成。