pyruns

English | 简体中文

Pyruns 是一个磁盘优先、面向复现实验和终端任务的运行管理器。它把命令、配置、日志、环境、运行历史和指标保存在项目的 _pyruns_ 目录中，并提供 Git 式一次性 CLI 与可选 Web UI。

30 秒开始

pip install pyruns

# 下面使用短入口 pyr；pyruns 与它完全等价
pyr --help

# 运行并记录一个命令；shell workspace 会自动创建
pyr exec -n smoke -- python -V

# 查询结果
pyr ls
pyr show smoke
pyr log smoke

# 重跑同一个已保存任务，并保留新的编号运行历史
pyr run smoke

这里的 task 是可重复运行的保存对象；每次 run 都会新增一个编号 run，不会覆盖旧日志。

不需要马上按名称引用任务时，可以完全省略命名参数；Pyruns 会自动生成 task_YYYY-MM-DD_HH-MM-SS。想保留语义前缀并自动附加时间戳时使用 -nt：

pyr exec -- python -V
pyr exec -nt smoke -- python -V       # smoke_YYYY-MM-DD_HH-MM-SS

-n smoke 仍表示精确名称 smoke，因此 -n 与 -nt 互斥。

长任务使用 --detach，随后用独立命令控制：

pyr exec -n train -d -- python train.py --epochs 100
pyr status
pyr wait train
pyr log train

前台 exec / run 被 Ctrl+C 中断时，会请求取消由这次命令提交的任务；wait、log -f 的 Ctrl+C 或 wait --timeout 只停止观察，任务仍继续运行。需要真正停止已有任务时使用 pyr stop TASK。

需要 Web UI 时显式启动：

pyr ui
pyr ui train.py
pyr ui shell

pyr 与 pyruns 是完全等价的正式入口；前者适合高频输入，后者更容易识别项目名。使用 pyr --help 查看常用命令，pyr help -a 查看完整索引，pyr help COMMAND 查看命令细节；两者都没有需要持续操控的交互式 REPL。

为什么它有用

• 每个任务都有稳定目录，不再靠终端滚屏和记忆找结果。
• 命令、参数、环境变量、日志、指标和 artifacts 一起落盘。
• Shell 命令与 Python 配置实验使用同一套任务生命周期。
• CLI 一次调用完成一件事，适合人、脚本、CI 和 AI agent。
• 前台执行返回真实结果；批量任务任一失败，整体退出非零。
• detached runner 独立于调用终端；Windows 上的任务进程和后台探测也不会弹出额外控制台窗口。
• Web UI 与 CLI 共享磁盘状态，不存在两套数据源。

Git 式 CLI

pyr [GLOBAL OPTIONS] COMMAND [COMMAND OPTIONS]

全局参数必须写在命令前：

-C, --directory PATH
-w, --workspace NAME|PATH|SCRIPT.py
--debug
--version

子命令自己的参数写在命令后。把每种位置分开看更直观：

pyr -C path/to/project ls             # -C 在命令前：从另一个目录发现项目
pyr -w train ls --json                # -w 在命令前；--json 属于 ls
pyr ui shell -p 8099                  # -p/--port 只属于 ui/dev
pyr exec -n check -- python -V        # -- 后面是原样传给目标程序的 argv

-w 只在 ls、run、show、log 等任务命令需要消除多 workspace 歧义时使用；项目只有一个 workspace 时可以省略。exec 固定使用 shell workspace，Web UI 则直接写成 pyr ui shell、pyr ui train 或 pyr ui train.py，不要写成 pyr -w shell ui。ui / dev 还提供 -p, --port、--browser 和 --no-browser，它们同样必须写在命令后。--json 不是全局模式，只在支持它的具体命令后使用，例如 pyr status --json。

先记住一条层级即可：project -> workspace -> task -> run。项目拥有 _pyruns_ 数据目录；workspace 收纳一组相关任务；task 是有精确名称的命令或配置；每次执行 task 都产生一个带编号的 run 历史。

正式命令集：

每个命令都提供独立的场景化帮助；例如 pyr help exec 会直接说明精确 argv、Shell 表达式、脚本执行和环境变量持久化之间的区别。完整说明见 CLI 详细指南。

两种工作区

Shell Workspace

用于任意终端命令、仓库复现、安装、预处理、训练、评估和流水线。省略名称时自动生成 task_YYYY-MM-DD_HH-MM-SS；-nt PREFIX 自动追加时间戳；-n NAME 使用精确名称：

pyr init
pyr exec -- python -V
pyr exec -nt env-check -- python -V
pyr exec -n env-check -- python -V
pyr exec -n install -- python -m pip install -r requirements.txt
pyr exec -n baseline -d -- python train.py --config baseline.yaml

Shell 脚本文件也直接交给 exec，不需要手写解释器：

pyr exec -n setup -- ./scripts/setup.sh
pyr exec -n setup-ps -- .\scripts\setup.ps1
pyr exec -n setup-cmd -- .\scripts\setup.cmd
pyr exec -n setup-bat -- .\scripts\setup.bat

这就是对 bash xxx.sh / pwsh -File xxx.ps1 最常用的受跟踪替代：Pyruns 根据 .sh、.ps1、.cmd、.bat 扩展名选择 Bash/sh、PowerShell 或 cmd.exe。文件路径之后的内容是该脚本自己的参数，不是 Pyruns 参数。Pyruns 会保留参数边界，并记录日志、开始/结束时间、高精度运行时长、原始退出码、脚本内容哈希和 Git 状态。任务重跑仍使用原脚本路径，因此依赖脚本原目录的相对路径语义不会改变。

-- 是标准的 CLI 参数边界，不是 Pyruns 的一种“模式”：

• -- 是参数分隔符，表示 Pyruns 自己的选项到此结束；后面的每一项都是目标程序的独立 argv，Pyruns 不做管道、重定向、变量展开或通配符解析。
• -c / --command 接收后续 shell command text，命名和 sh -c、python -c 的习惯一致。

普通程序和脚本路径优先使用 --：

pyr exec -n preprocess -- ./scripts/preprocess.sh "dataset A" --fast
pyr exec -n train -- python train.py --lr 0.001

当命令确实依赖管道、重定向、变量展开、通配符或 && 时，使用 -c：

pyr exec -n report -c "python eval.py > metrics.txt"
pyr exec -n pipeline -c "python preprocess.py && python train.py | tee train.log"

-c echo hello 会把剩余文本合并成 echo hello。命令含 ;、|、重定向或变量时，必须按调用端 shell 的规则引用整段表达式，避免调用端在 Pyruns 启动前将它拆开。Pyruns 不安装 shell 专用的行编辑钩子；所有平台都遵循同一契约：普通程序使用 -- 后的精确 argv，需要 shell 语法时使用带引号的 -c。

pyr exec -c '$colors=@("Red","Green"); 1..2 | ForEach-Object { Write-Host $_ -ForegroundColor $colors[$_-1] }'

Shell task 使用跨平台伪终端捕获颜色：Linux/macOS 使用系统 PTY，Windows 强制使用原生 ConPTY，且不会创建可见控制台窗口。SGR 颜色序列会写入日志并在前台还原；清屏、光标定位和窗口标题等界面控制序列会被过滤。伪终端不可用时才回退到普通 stdout/stderr 管道。

少量任务环境变量只需写一次 -e，后面连续列出多个 KEY=VALUE，并用 -- 与目标命令分隔：

pyr exec -n train -e CUDA_VISIBLE_DEVICES=0 TOKENIZERS_PARALLELISM=false SEED=42 -- python train.py

-e / --env 是可重复选项，也可以按变量组分开书写。

Pyruns 已自动为子进程设置 PYTHONUNBUFFERED=1、PYTHONIOENCODING=utf-8 和 PYTHONUTF8=1，通常不需要重复传入。

在 POSIX shell 中，CUDA_VISIBLE_DEVICES=0 pyr exec ... 的当前这次运行也会把变量继承给子进程；但该值不会写入任务元数据，之后从另一个终端、Web UI 或 pyr run 重跑时不保证仍然存在。需要可复现、可由 show 检查的任务配置时使用 -e 或 --env-file。

变量较多时使用 UTF-8 env 文件：

# .env.train
CUDA_VISIBLE_DEVICES=0
TOKENIZERS_PARALLELISM=false

pyr exec -n train --env-file .env.train -e SEED=42 -- python train.py

--env-file 可重复，后面的文件覆盖前面的文件，命令行 -e 最后覆盖所有文件。文件只接受空行、整行 # 注释和 KEY=VALUE，不会执行 shell 插值。任务环境会明文保存在元数据并由 show 显示，因此不要在其中保存密钥。

执行前可做真正无副作用的预览；加入 --json 可得到稳定计划对象：

pyr exec --dry-run -n report -- python eval.py
pyr exec --dry-run -n report --json -- python eval.py

预览不会创建 _pyruns_、任务或设置文件，也不会启动用户命令；--dry-run 与 --detach 互斥。

Shell 任务保存在：

<project>/_pyruns_/_shell_/tasks/<task>/
├── task_info.json
├── config.ps1 | config.cmd | config.sh
└── run_logs/runN.log

Script Workspace

用于 argparse、pyruns.load()、YAML 配置、batch 展开和参数化实验：

pyr init train.py
pyr -w train add configs/quick.yaml
pyr -w train run quick

创建并立即运行：

pyr -w train run --config configs/sweep.yaml -n sweep -j 4
pyr -w train run --config configs/sweep.yaml -n sweep -j 4 --dry-run

run --config ... --dry-run 会验证 YAML 并列出展开后的候选任务，但不创建或运行它们。

Script 任务保存在：

<project>/_pyruns_/train/tasks/<task>/
├── task_info.json
├── config.yaml
├── run_logs/runN.log
└── artifacts/runN/

工作区选择

Pyruns 会从当前目录向父目录寻找最近的 _pyruns_。只有一个 workspace 时自动选择；存在多个时必须显式传 -w，不会猜测：

pyr -w shell ls
pyr -w train status
pyr -w ./train.py show baseline
pyr -w ./_pyruns_/train log baseline

任务必须使用精确名称，不支持序号和模糊匹配。show 与 log 支持 TASK --run RUN，也可用短写 TASK@RUN 选择历史运行，因此 @ 不能出现在新任务名中。

Python 脚本接入

零侵入 argparse

import argparse

parser = argparse.ArgumentParser()
parser.add_argument("--lr", type=float, default=1e-3)
parser.add_argument("--epochs", type=int, default=10)
args = parser.parse_args()

pyr init train.py
pyr ui train.py

Pyruns 会解析脚本参数并建立默认配置模板。

pyruns.load() 配置

import os

import pyruns

cfg = pyruns.load()
print(cfg.training.lr)

首次初始化时传入 YAML：

pyr init train.py --config configs/default.yaml
pyr -w train add configs/default.yaml -n baseline
pyr -w train run baseline

脚本内 API

import pyruns

cfg = pyruns.load()

for epoch in range(cfg.training.epochs):
    loss = train_one_epoch()
    pyruns.track(epoch=epoch, loss=loss)

pyruns.record(final_loss=loss, seed=cfg.training.seed)
model.save(os.path.join(pyruns.artifact_dir(), "model.pt"))

查询、日志和生命周期

pyr -w train ls -s running -s queued
pyr -w train status
pyr -w train show baseline
pyr -w train show baseline@2
pyr -w train show baseline --run 2
pyr -w train log baseline -f
pyr -w train log baseline@2
pyr -w train wait baseline --timeout 600
pyr -w train stop baseline
pyr -w train mv baseline baseline-lr1e3
pyr -w train pin baseline-lr1e3
pyr -w train rm baseline-lr1e3
pyr -w train ls --trash
pyr -w train restore baseline-lr1e3

ls 会用 PIN 标记置顶任务并始终将其排在普通任务之前；--reverse 只反转两组各自内部的顺序。JSON 列表和 show 都包含明确的 pinned 字段。

rm 会立即执行，不询问确认，但它只是可恢复的软删除。

JSON 与自动化

--json 是给脚本、CI 和 agent 使用的机器输出开关，只放在明确支持它的子命令后。 每个结果都是严格 JSON 对象，顶层包含 "schema_version": 1；YAML 日期和时间戳会转换为 ISO 8601 字符串，NaN、Infinity 和不支持的对象会被拒绝，不会生成标准解析器无法读取的伪 JSON：

pyr -w shell ls --json
pyr -w shell status --json
pyr -w shell show smoke --json
pyr -w shell show smoke@2 --json
pyr -w shell show smoke --run 2 --json
pyr -w shell log smoke --path --json
pyr -w shell log smoke@2 --path --json
pyr config list --json
pyr metrics --json

日志默认原样写 stdout；需要结构化引用时使用 log --path。导出默认写 stdout：

pyr -w train export -f csv
pyr -w train export baseline --format json
pyr -w train export -s completed -o results.csv

导出记录的格式只由 --format（或 -f）选择；文件名后缀不会隐式改变格式。

退出码：

0    命令和等待的任务全部成功
1    工作区、目标、运行时或任务失败
2    命令行用法错误
130  命令被 Ctrl+C 中断

Web UI

pyr ui
pyr ui train.py
pyr ui train.py --config configs/default.yaml
pyr ui train
pyr ui shell
pyr ui shell -p 8099
pyr ui shell --no-browser
pyr dev train.py

这些入口分别对应明确场景：

• pyr ui 打开工作区选择器，不会猜测要进入哪个工作区。
• pyr ui shell 打开或创建当前项目的 shell workspace。
• pyr ui train.py 初始化或打开该 Python 脚本的 workspace；首次需要模板时可加 --config。
• pyr ui train 或 pyr ui PATH 打开已有的精确 workspace 名称或路径。
• pyr dev ... 只用于开发 Pyruns 前端时的热更新；日常使用选择 ui。

-p, --port 选择监听端口；--no-browser 只启动服务并打印 URL；--browser 强制自动打开浏览器。

UI 只监听本机回环地址。每次启动都会生成新的随机访问令牌；启动 URL 首次打开后， 令牌会换成 HttpOnly 会话 cookie，并从地址栏移除。使用 --no-browser 时请复制终端 打印的完整 URL，不要把它分享给其他用户。这个机制用于隔离同机其他进程，不是远程 多用户部署的身份系统。

Pyruns 不是代码沙箱。任务命令和 Python 脚本会继承当前用户的系统权限；只运行你信任 的脚本、配置和命令。

• Home / Dashboard：查看当前 workspace 的 GPU 与系统状态、任务统计和最近任务。
• Generator：在脚本 workspace 中用 Grid、Tree 或 YAML 编辑配置，或在 shell workspace 中编辑命令正文并创建任务。
• Manager：搜索、筛选、排序和批量控制任务，也可运行、停止、重命名、置顶或移入回收站。
• Monitor：查看实时或历史日志、搜索日志、运行或停止任务，并打开详情或导出记录。
• 侧栏 Workspace 用于切换工作区；Runtime 用于设置 Python、环境变量、GPU 与运行方式。

磁盘是最终状态源

<project>/_pyruns_/
├── _pyruns_settings.yaml
├── _shell_/
│   ├── script_info.json
│   └── tasks/
└── <script_name>/
    ├── script_info.json
    ├── config_default.yaml
    └── tasks/

CLI 和 Web UI 都只是在这套磁盘状态上工作，因此任务不会因为关闭某个界面而消失，也能被版本控制、备份工具和自动化脚本直接检查。

文档

• 安装与快速开始
• CLI 详细指南
• 配置说明
• Web UI 指南
• 批量配置语法
• 脚本 API
• 架构说明

License

MIT