mcpField
A
artifact-release-packager

artifact-release-packager

github.com/jurgendn开发1153 次安装6 周前更新
代码仓库

关于 artifact-release-packager

面向准备发布研究代码、数据、模型或检查点的研究者,用于规划论文工件包和评审流程。它将论文主张对应到代码、配置、数据与预期输出,并检查复现路径和发布风险。

主要功能

  1. 01将论文结果映射到发布工件
  2. 02检查文档、配置与运行脚本
  3. 03规划评审者的运行路径
  4. 04标记许可与隐私风险
  5. 05定义发布承诺与复现范围

适用场景

  1. 01准备论文代码和数据发布
  2. 02为工件评审编写运行说明
  3. 03检查图表复现所需文件
  4. 04发布前排查敏感或不可再分发资产

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/jurgendn/agent-skills --skill artifact-release-packager

安装后在 Claude Code 中输入/artifact-release-packager确认已加载。

附带文件evals/evals.json

详细介绍

论文工件发布打包器

论文工件不只是一个 GitHub 仓库,而是一组材料,让其他研究者能够按照论文所声称的程度理解、运行并信任这项工作。

适用场景

  • 用户正在准备代码、数据、模型或检查点的发布。
  • 用户需要工件评估说明。
  • 论文中的表格或图需要复现命令。
  • 用户想知道发布前还缺少哪些文件、配置或文档。
  • 发布内容可能包含敏感、受许可限制、体积较大或不可再分发的资源。

不适用场景

  • 用户想要端到端验证现有结果。请使用 reproducibility-audit。
  • 用户想在发布前整理、记录或简化代码库。请使用 research-codebase。

工作流

1. 明确发布承诺

说明工件应支持哪些内容:

  • 精确复现主要结果
  • 大致复现趋势
  • 运行小型冒烟测试
  • 检查训练后的模型或输出
  • 复用数据集/预处理流程
  • 在规定时间内支持工件评估

发布包的承诺不应超出其实际能力。

2. 将论文主张对应到工件

对每项主要结果,确定:

  • 论文位置:表格、图或主张
  • 所需的代码入口
  • 配置文件
  • 数据依赖项
  • 模型/检查点依赖项
  • 预期输出
  • 预期运行时间/硬件
  • 已知的方差或非确定性

如果某项结果无法对应到工件,请将其标记为发布缺口。

3. 整理发布清单

检查以下内容:

  • 包含快速入门和复现指南的 README
  • 环境文件或安装说明
  • 必要时固定的依赖项版本
  • 数据下载或访问说明
  • 预处理脚本
  • 训练/评估脚本
  • 已报告运行所用的配置
  • 检查点或获取说明
  • 预期输出或校验和
  • 许可证文件
  • 适用时提供引用文件
  • 隐私或再分发说明
4. 设计审阅者的操作路径

工件审阅者和未来读者首先需要一条简短的操作路径:

  1. 安装环境
  2. 运行冒烟测试
  3. 复现一项小型结果
  4. 复现或检查主要结果
  5. 了解完整运行的成本

不要让首次成功运行依赖完整且昂贵的实验。

5. 检查发布安全性

标记以下内容:

  • 密钥或凭据
  • 私有路径或用户名
  • 不可再分发的数据集
  • 限制发布的模型许可证
  • 个人身份信息
  • 更适合托管在其他位置的大型文件
  • 不应提交的生成文件

输出格式

# Artifact Release Plan

## Release promise

## Claim-to-artifact map
| Paper claim/result | Required artifact | Command/config | Expected output | Status |
|---|---|---|---|---|

## Required package contents

## Smoke test path

## Full reproduction path

## Safety/licensing concerns

## Missing pieces

## Release README outline

质量标准

优秀的工件包能让持怀疑态度的研究者迅速了解:该发布支持什么、如何运行、预期结果是什么,以及有哪些限制?

评论

支持 Markdown