用途:帮助研究者把代码与实验产物整理成可随论文公开的发布版本,强调可复现性与安全性。
主要能力:
- 仓库评估:扫描 API 密钥、令牌、凭据、本机硬编码路径、内部 URL、注释或数据中的个人信息;审计依赖(固定版本、专有或受限许可、废弃依赖、是否可 pip/conda 安装);识别死代码、调试残留、重复代码与可简化代码。
- 仓库结构:建议包含 README.md、LICENSE、requirements.txt 或 pyproject.toml、setup.py/setup.cfg、src/、scripts/、configs/、data/、checkpoints/(仅下载说明)、results/。
- 复现清单:逐实验核对配置文件与论文超参一致、随机种子设置并记录、训练与评估命令完整、数据预处理脚本化、记录硬件需求(GPU 类型、内存、时间)、依赖版本固定。
- README 结构:标题与一句话描述、论文链接、可视化图、安装步骤、快速开始(少于 5 条命令)、训练、评估、模型库/检查点下载与指标、BibTeX 引用、许可证。
- 代码清理:删除调试打印、注释代码与临时实验;把硬编码路径改为可配置;为公开函数补 docstring;明确入口;不因风格重构可运行代码。
- 许可证选择:给出 MIT、Apache 2.0、GPL 3.0、CC BY 4.0、CC BY-NC 4.0 在商用、署名、copyleft 上的差异;默认建议代码用 MIT,数据集/模型用 CC BY 4.0。
- 发布前测试:克隆到全新目录,严格按 README 安装,运行快速开始与评估,核对数字与论文一致,检查 git 历史无敏感信息。
输出:审计报告、待修改/删除/新增文件清单、README 草稿、逐实验复现核对状态。
限制:资料未提供具体安装命令、依赖清单、平台支持、收费方式或实际效果数据;上述流程为方法论指引,需结合具体项目执行。