SuperAPI AI 工具集

refactor-research-code

编程与开发

查看项目

更新于 10-16 01:48

技能介绍

用途:把研究代码库从“只在我机器上能跑”整理为可公开发布的整洁版本,同时保持论文所报告数值的精确行为不变。它只做发布就绪所需的结构性清理,不做通用重构、性能改写或 API 现代化。

主要能力:以静态审计脚本区分三类改动。SAFE(可安全应用):添加 README/LICENSE/.gitignore;把扁平脚本移入 src//package 布局并修正导入;删除 pycache、*.pyc、.DS_Store 等纯垃圾;记录现有入口;仅重排空白与注释。ASK-FIRST(未经明确确认不得改动):删除代码路径、把硬编码超参数或路径抽到配置、改动 seeding/RNG/线程数/dtype/求值顺序等影响数值的地方。IDENTITY:扫描邮箱、家目录路径、作者名与 .git 历史,交由匿名化技能深扫。

使用方式:先读 .paper-memory/lessons.md 与 profile.yml,确认审查盲审级别(none/single/double)与待扫描的身份词,再运行只读审计:python3 scripts/release_audit.py <code-dir> --blind <none|single|double> --names "Jane Doe,Example University",可加 --json 输出机器可读结果。审计按 dead-code、config、entrypoint、layout、determinism、identity、hygiene 分类,并标注 SAFE、ASK-FIRST、IDENTITY 风险;退出码 0 表示无 ask-first/identity 发现,1 表示存在,2 为用法错误。随后提交 SAFE→ASK-FIRST→IDENTITY 排序的重构计划,逐项获得作者批准后再编辑;每个 ask-first 改动需最小化修改并重跑流水线对比输出验证,而非阅读 diff。最后重跑审计直至 SAFE 干净,最多约 3 轮。计划与变更日志写入 paper-workspace/submission/refactor-research-code-plan.md 并追加到 INDEX.md。

适用场景:为公开发布、盲审补充材料或 artifact track 整理研究代码库。

限制:不做加测试/固定种子/环境捕捉(交给 test-research-code)、不打包或申请 DOI 徽章(prepare-artifacts)、不做深度盲审匿名化(anonymize-paper)、不宣称结果可复现(verify-results)。审计为静态只读、不执行不联网,不能证明代码可复现;非 Python 栈需扩展脚本中的模式表;不确定是否安全时一律按 ask-first 处理。