SuperAPI AI 工具集

code-refactor-for-reproducibility

编程与开发

查看项目

更新于 10-15 16:44

技能介绍

用途:该技能面向科研代码的可复现重构,适用于为论文发表整理分析代码、为既有脚本补充文档、构建可复现计算工作流,以及准备与协作者共享代码的场景。它会将研究代码转化为可发表、可复现的工作流,补充文档、实现错误处理、生成环境规格,并确保科学出版所需的计算可复现性。

主要能力:提供结构化执行路径,保持输出一致且可审查;打包可执行入口 scripts/main.py;按流程覆盖分析、重构、环境规格与验证四个阶段。分析阶段检查缺失 docstring、硬编码绝对路径、缺少随机种子、裸 except、未固定版本依赖及未解释的魔法数字;重构阶段添加文档字符串、参数化硬编码值、设置随机种子、加入日志与错误处理;环境阶段用 pipreqs 生成 requirements.txt,或编写 Conda 的 environment.yml 并固定版本;验证阶段比对输出校验和、运行 pytest、连续两次运行确认输出一致。

使用方式:先确认用户输入、输出路径与所需配置值;必要时编辑脚本内 CONFIG 块或文档化参数;运行前可用 python -m py_compile scripts/main.py 校验入口可解析,用 python scripts/main.py --help 查看参数,然后执行 python scripts/main.py 并审查生成结果;参数需先明确输入路径、输出路径、范围过滤、阈值及领域约束。环境中依赖 Python 3.10+、numpy、pandas、pytest、scipy,均在 requirements.txt 中声明,版本未指定。

适用场景与限制:适合需要明确假设、限定范围、可复现输出格式的数据分析任务,以及缺少输入、执行错误或证据不完整时需要文档化回退路径的情况。输入缺失时应说明缺少哪些字段并仅请求最少补充信息;超出文档范围应停止而非猜测或扩大任务。脚本失败时需报告失败点、总结仍可安全完成的部分并给出人工回退。不得编造文件、引用、数据、搜索结果或执行结果。参考文档、Dockerfile 模板与 API 文档见技能包内 references 目录(具体内容暂未提供)。