-
Cormac authored
docs(readme,reproduction): 5 分钟上手 + Docker 一键复现 + Makefile 实战化 把 README、reproduction.md、Makefile、Dockerfile 升级为评委可以直接照抄的状态:本地一条 make 命令跑端到端 demo,Docker 两条命令完成构建与复现,Makefile 把所有常用动作(demo / eval / eval-noai / docker-build / docker-demo / test)暴露成 target。 主要内容: - README.md: * "当前进度"段从骨架描述更新为实际状态(端到端打通、3 个 e2e、批量评测真实数字、59 个测试全过)。 * 新增 "5 分钟上手" 段,分本地与 Docker 两条路径,每条都给出可复制的 make 命令清单。 * 新增 "评测真实数字" 段直接把 hit@1=0.667 / hit@3=hit@5=1.0 / MRR=0.833 表格放出来。 * 仓库结构图同步 src layout 与 benchmark/cases 真实目录。 * 联系方式补 Cormac <U202212223@hust.edu.cn>。 - docs/reproduction.md: * 把命令从"占位"改成实际可执行的 make 系列命令。 * 加 Docker 一键复现段(含 eBPF 模式的提示)。 * 加常见问题表(pip install -e、PermissionError、tc netem 安全护栏)。 - Makefile: * demo 从 "bash scripts/run_demo.sh" 改为直接调 CLI 跑 examples/sample_metrics.csv,输出 examples/sample_run_report.md。 * eval 从 "--help" 改为真实跑 benchmark.evaluators.eval_offline 写到 benchmark/cases/_eval_output。 * 新增 eval-noai 跑 --no-causal 消融。 * 新增 docker-build / docker-demo 两个 target,docker-demo 依赖 docker-build。 * 参数化变量(DEMO_*、EVAL_OUTPUT、DOCKER_IMAGE)便于评委自定义。 - docker/Dockerfile: * 修 src layout 后 COPY kairos ./kairos 路径失效的 bug,改为 COPY src ./src。 * CMD 改为 CMD ["python", "-m", "kairos.cli.main", "analyze", "--metrics", "examples/sample_metrics.csv", ...],让 docker run 自动跑端到端 demo,自测兼演示一步完成。 冒烟测试: make demo # 输出 examples/sample_run_report.md,含因果对比段与 bcc 探针证据 make eval # benchmark/cases/_eval_output/report.md:hit@1=0.667 / hit@3=hit@5=1.0 / MRR=0.833 make test # 59 个用例全过 跑了一次全量回归:tests/unit + tests/e2e 共 59 个用例全部通过。 AI 工具辅助说明: 本次提交中由 DeepSeek V4 Pro 辅助生成首版草稿的内容包括:"5 分钟上手"段的命令布局、reproduction.md 中的"常见问题"表、Dockerfile 默认入口跑端到端 demo 的 CMD 数组形式、Makefile 中 demo / eval / eval-noai / docker-build / docker-demo 目标的雏形。队员修复了 Dockerfile 中 src layout 后失效的 COPY kairos ./kairos 路径(改为 COPY src ./src)、把 Makefile demo 从占位脚本改为直接调 CLI 输出 examples/sample_run_report.md、把 eval 从 --help 改为真实跑批量评测、加了 docker-build/demo target 串起来一键复现、端到端验证 demo + eval + 59 个测试全过。所有"5 分钟"上手命令的精简口径与"docker run 即跑 demo"的设计选择由队员根据评委复现优先级独立确定。 Co-authored-by: Cursor <cursoragent@cursor.com>
ee4a87d9