RxnOptBench / docs /source_testsetv6_readme.md
songjhPKU's picture
Upload benchmark review release
bd355f0 verified
# 反应条件推荐评测集 V6
`testsetV6` 是一套自包含的反应条件推荐评测工具包,包含:
- 选择题构建与评测
- 填空题构建与评测
- 共用的条件解析、产率解析、reference 抽样与评分 helper
如果你是第一次接手这个目录,把它当成“构建脚本 + 评测脚本 + 文档模板”的入口即可。
## 1. 先看什么
如果你刚进入 `testsetV6`,推荐按下面顺序理解:
1. 先读当前 `README.md`,了解根目录有哪些脚本、每类题目怎么接。
2. 运行一次构建脚本,得到一个时间戳输出目录。
3. 进入输出目录后先读 `report.md`,它是该批数据的接入说明。
4. 再打开一个目标数据集 JSON,看真实 schema。
5. 根据 `question_type` 读取对应 prompt 模板。
6. 参考 `example_prediction_*.json` 确认预测文件格式。
7. 最后用对应的 `evaluate_*.py` 跑评测。
## 2. 根目录文件导航
| 文件 | 作用 | 什么时候读 |
|------|------|-------------|
| `README.md` | 根目录总览与上手指南 | 第一次接手 `testsetV6` 时先读 |
| `common_v6.py` | 选择题与填空题共用的解析、评分、reference helper | 想改评分、条件归一化、reference 规则时读 |
| `build_multiple_choice.py` | 构建选择题、生成 prompt、生成 `report.md` | 想改选择题 schema、文案、构题逻辑时读 |
| `evaluate_multiple_choice.py` | 评测选择题 | 想核对指标口径或接评测链路时读 |
| `build_fill_in_blank.py` | 构建填空题、生成 prompt、生成 `report.md` | 想改填空题 schema、文案、构题逻辑时读 |
| `evaluate_fill_in_blank.py` | 评测填空题 | 想核对命中逻辑、非法预测规则时读 |
| `YYYYMMDD_HHMMSS_multiple_choice/` | 一次选择题构建的完整输出包 | 想接模型、看真实样本、跑评测时读 |
| `YYYYMMDD_HHMMSS_fill_in_blank/` | 一次填空题构建的完整输出包 | 想接模型、看真实样本、跑评测时读 |
## 3. 默认数据源
当前脚本默认读取:
- `NeurIPS26/pipeline_output_0423_fmt`
并在可用时使用:
- `/mnt/shared-storage-user/mineru4s/gaojunyuan/sioc/metadata_new.csv`
用于从文件名恢复更稳定的 DOI 信息。
## 4. 最短工作流
```bash
cd testsetV6
# 生成选择题
python build_multiple_choice.py
# 生成填空题
python build_fill_in_blank.py
```
每次运行都会生成一个带时间戳的输出目录:
- `YYYYMMDD_HHMMSS_multiple_choice`
- `YYYYMMDD_HHMMSS_fill_in_blank`
进入某个输出目录后,推荐用下面的顺序接模型:
1.`report.md`
2. 选一个数据集 JSON
3. 读取对应 prompt 模板
4. 按数据集 schema 生成预测文件
5. 用同目录里的评测脚本跑分
如果只是先验证链路是否通,直接使用该目录自带的 `example_prediction_*.json` 即可。
## 5. 输出目录里有什么
每个输出目录都尽量保持自包含,通常会包含:
| 文件 | 作用 |
|------|------|
| `report.md` | 当前这批数据的总览、文件导航、字段说明、评测命令 |
| `README.md` | 根目录的总入口说明快照 |
| `multiple_choice_*.json` / `fill_in_blank_*.json` | 真正交给模型跑的评测集 |
| `prompt_*.txt` | 对应题型的 prompt 模板 |
| `example_prediction_*.json` | 最小可用预测示例,用于通链路 |
| `build_*.py` | 本次构建使用的脚本快照 |
| `evaluate_*.py` | 本次评测使用的脚本快照 |
| `common_v6.py` | 本次构建与评测共用 helper 快照 |
## 6. 选择题
### 6.1 子数据集
| 文件 | question_type | 说明 |
|------|---------------|------|
| `multiple_choice_single_varying.json` | `single_varying` | 只让 1 个条件键变化,其余变化条件固定为一个真实固定条件组 |
| `multiple_choice_all_varying.json` | `all_varying` | 所有变化条件共同组成候选选项 |
| `multiple_choice_single_varying_reference.json` | `single_varying_reference` | 单条件题,并附带 reference 条件组 |
| `multiple_choice_all_varying_reference.json` | `all_varying_reference` | 全条件题,并附带 reference 条件组 |
| `multiple_choice_single_varying_reference_control.json` | `single_varying_reference_control` | 与 `single_varying_reference` 配对的无 reference 对照题 |
| `multiple_choice_all_varying_reference_control.json` | `all_varying_reference_control` | 与 `all_varying_reference` 配对的无 reference 对照题 |
### 6.2 预测格式
```json
{
"sample_id_1": 2,
"sample_id_2": 0
}
```
预测值必须是单个 0-based 选项索引。
### 6.3 选择题里最重要的字段
- `options`: 模型可选的候选条件
- `answer`: 当前题目选项空间内的最优索引列表;并列最优时长度可能大于 1
- `meta.option_relative_scores`: 与 `options` 对齐的相对分数列表,是主评测依据
- `meta.best_yield`: 当前题目选项空间内的最佳产率
- `meta.best_effective_score`: 当前题目选项空间内的最佳有效得分
- `meta.selection_info`: 单条件题的组选统计与选项来源说明
- `meta.reference_info`: reference 候选池与抽样信息
### 6.4 单条件题规则
`single_varying` 不是“把其它条件固定到一个理想值再假设目标条件变化”,而是:
1. 在原表中枚举其它变化条件的真实固定组合;
2. 选择对目标条件覆盖值最多的一组作为 `fixed_conditions`
3. 只有这组里真实出现过的目标条件取值才会成为选项;
4. `answer``meta.option_relative_scores` 只在这组局部真实选项集内计算。
这意味着 `single_varying` 题面中的每个选项都对应原表真实实验组合,不会凭空拼接未做过的组合。
### 6.5 选择题评测
```bash
python evaluate_multiple_choice.py \
--dataset 20260424_xxxxxx_multiple_choice/multiple_choice_single_varying.json \
--prediction pred.json
```
主要指标:
- `avg_relative_score`: 主指标,所有样本的平均相对得分
- `exact_match_accuracy`: 是否直接命中当前题目选项空间内的最优组
- `avg_yield_ratio`: 预测项产率 / 当前题目选项空间最佳产率 的平均值
## 7. 填空题
### 7.1 子数据集
| 文件 | question_type | 说明 |
|------|---------------|------|
| `fill_in_blank_all_blank.json` | `all_blank` | 为所有变化条件键选择候选编号 |
| `fill_in_blank_all_blank_reference.json` | `all_blank_reference` | 全条件填空题,并附带 reference 条件组 |
### 7.2 预测格式
```json
{
"sample_id_1": {
"solvents": 2,
"catalysts": 0
},
"sample_id_2": {
"solvents": 1,
"ligand": 3
}
}
```
每个条件键都必须返回一个整数候选编号,而不是条件文本。
### 7.3 填空题里最重要的字段
- `query_keys`: 需要模型返回编号的条件键列表
- `input.candidate_values`: 每个条件键的候选编号表
- `input.constant_conditions`: 没有变化、直接给定的条件
- `input.reference_conditions`: 仅 `all_blank_reference` 题出现
- `meta.legal_combinations`: 所有真实存在的编号组合及其相对分数,是评测依据
### 7.4 填空题评测
```bash
python evaluate_fill_in_blank.py \
--dataset 20260424_xxxxxx_fill_in_blank/fill_in_blank_all_blank_reference.json \
--prediction pred.json
```
评测逻辑:
1. 校验预测是否为 `id -> {condition_key: candidate_index}`
2. 检查该编号组合是否命中 `meta.legal_combinations`
3. 命中后按记录中的 `relative_score` 计分
4. 未命中真实组合则记为 `unhit`,不进入主均分分母
主要指标:
- `hit_rate`
- `num_scored`
- `num_unhit`
- `num_invalid`
- `avg_relative_score`
- `best_hit_rate_among_scored`
## 8. 共用评分口径
选择题和填空题共用同一套有效得分定义:
- 主分数基于 `predicted_effective / best_effective`
- `effective = yield * ee_major_fraction * dr_major_fraction`
- `ee_major_fraction = (100 + ee) / 200`
- `dr_major_fraction = dr / (dr + 1)`,其中 `dr` 先按主/次比例解析,例如 `20:1 -> 20`
- 缺失 `ee``dr` 时按 `1.0` 处理,不额外惩罚
这套规则统一实现在 `common_v6.py`
## 9. Reference 规则
- reference 条件数至少 `2` 条、至多 `5`
- 参考条件只从低到中等表现区间抽取,不暴露最高分条件
- 对于 `single_varying_reference`,reference 来自题内选项之外的真实组合,且不能高于该题局部最佳值
- 对于 `all_blank_reference`,reference 条件组不会再被视为可命中的合法答案
- 仅选择题会额外生成 `*_reference_control` 对照题
## 10. 常见任务速查
| 你想做什么 | 先读哪里 |
|------------|----------|
| 想接一个新模型跑 V6 | 输出目录里的 `report.md`、数据集 JSON、prompt 模板、`example_prediction_*.json` |
| 想确认预测文件 schema | 对应数据集 JSON + `example_prediction_*.json` |
| 想核对评测指标怎么算 | `evaluate_multiple_choice.py``evaluate_fill_in_blank.py` |
| 想改选择题单条件构题 | `build_multiple_choice.py` + `common_v6.py` 里的 `build_single_option_bundles()` |
| 想改填空题合法组合定义 | `build_fill_in_blank.py` + `meta.legal_combinations` 生成逻辑 |
| 想改 reference 抽样 | `common_v6.py` 里的 `select_reference_bundles()` / `select_single_reference_bundles()` |
| 想改条件归一化或产率解析 | `common_v6.py` |