docs/DATASET_USAGE_ZH.md

# CopulaDock HiQBind 5K compact 数据集使用说明

## 1. 数据集的单位与规模

本发布包含 HiQBind 5K cohort 的两个 docking baseline 输出，经统一构图后保存为 `gnncp_compact_v1`。

| 方法 | system（protein–ligand pair） | graph（docking pose） | 完成状态 |
| --- | ---: | ---: | --- |
| DiffDock | 4,979 | 97,988 | complete / strict validation passed |
| AutoDock Vina | 4,887 | 85,824 | complete / strict validation passed |

定义如下：

- **system**：一个 protein–ligand pair，也是数据划分的最小单位。
- **graph**：该 system 的一个预测 docking pose 构成的一张原子图。
- 每个 system 最多请求 20 个 pose；实际 graph 数量可能少于 20，因为个别 pose 被方法或几何检查拒绝。

因此，例如构图阶段的“158 个 system 产生 2,849 个 graph”是正常的：它说明这些 pair 的有效 pose 总数为 2,849，并不表示出现了 2,849 个不同的 protein–ligand pair。

两个方法的共同 system 为 4,868 个。若做 DiffDock 与 Vina 的逐 system 对照，请先取 `system_index.json` 中 `systems` 字段的交集。

## 2. 下载

完整下载约需 93 GiB 可用空间。通常只需下载一个方法以及 reader 代码：

```python
from huggingface_hub import snapshot_download

snapshot_download(
    repo_id="liofoil/copuladock",
    repo_type="dataset",
    local_dir="copuladock",
    allow_patterns=[
        "code/compact_v1/compact_graph_dataset.py",
        "data/hiqbind_5k_v1/diffdock_full_v1/**",
    ],
)
```

若使用命令行客户端，也可执行：

```bash
hf download liofoil/copuladock \
  --repo-type dataset \
  --local-dir copuladock \
  --include 'code/compact_v1/compact_graph_dataset.py' \
  --include 'data/hiqbind_5k_v1/diffdock_full_v1/**'
```

将 `diffdock_full_v1` 替换为 `autodock_vina_full_v1` 即可下载 Vina 数据。

## 3. 环境

读取 compact 数据至少需要支持 `torch.load(..., mmap=True, weights_only=True)` 的 PyTorch 和 PyTorch Geometric：

```bash
pip install 'torch>=2.3' torch-geometric
```

若需要从 PDB pose 重新构图，再安装发布目录 `code/compact_v1/requirements.txt` 中的完整依赖：

```bash
pip install -r code/compact_v1/requirements.txt
```

## 4. 正确加载数据

不要直接把 `shards/shard_*.pt` 当作 `list[torch_geometric.data.Data]` 来读取。它们是压缩后的内部张量存储；请通过 `CompactGraphDataset` 进行按需重建。

```python
import sys
from pathlib import Path

from torch_geometric.loader import DataLoader

repo_root = Path("copuladock")
sys.path.insert(0, str(repo_root / "code" / "compact_v1"))
from compact_graph_dataset import CompactGraphDataset

data_root = (
    repo_root / "data" / "hiqbind_5k_v1" / "diffdock_full_v1"
)
dataset = CompactGraphDataset(
    data_root,
    max_cached_shards=2,
    strict=True,
)

print(len(dataset))             # 97,988 for DiffDock
graph = dataset[0]              # torch_geometric.data.Data
metadata = dataset.metadata(0)  # 包含 system_id、shard 与 source graph 索引

loader = DataLoader(
    dataset,
    batch_size=4,
    shuffle=True,
    num_workers=4,
    persistent_workers=True,
)
batch = next(iter(loader))
```

该 reader 以 mmap 方式打开 shard，并在取样时重建一张 PyG 图；避免先执行 `[dataset[i] for i in range(len(dataset))]`，否则会失去紧凑格式的内存优势。

## 5. 返回图的字段

| 字段 | 形状 / dtype | 含义 |
| --- | --- | --- |
| `x` | `[N, 82]`, `float32` | 节点特征 |
| `edge_index` | `[2, E]`, `int64` | 双向图边 |
| `edge_attr` | `[E, 4]`, `float32` | 距离 / 距离衰减 / 边两端蛋白标记 |
| `pos` | `[N, 3]`, `float32` | 当前 docking pose 坐标 |
| `y_pred` | `[N, 3]`, `float32` | 预测 pose 坐标；数值上与 `pos` 相同 |
| `y_grt` | `[N, 3]`, `float32` | native/reference 坐标 |
| `is_protein` | `[N, 1]`, `float32` | 蛋白节点为 1，配体节点为 0 |
| `y_true` | `[N, 1]`, `float32` | 配体原子的 `||y_pred - y_grt||_2`；蛋白节点为 0 |

计算配体 pose 误差或训练 CQR-GNN 时，应以 `is_protein == 0` 选择配体节点。蛋白节点的 `y_true=0` 并不代表预测误差为零，而是本构图定义中蛋白坐标固定。

## 6. 必须按 system 划分数据

同一 system 的多个 pose 共享蛋白、配体和 native reference。若把 pose 随机切分到 train/validation/test，会造成严重的信息泄漏。

`system_index.json` 提供 `systems`、`graph_to_system`、`system_counts` 和 `source_graph_indices`。推荐先在 system ID 层级使用 PLINDER 或其他规则完成划分，再展开为 graph index：

```python
import json
from collections import defaultdict
from torch.utils.data import Subset

with (data_root / "system_index.json").open() as handle:
    system_index = json.load(handle)

indices_by_system = defaultdict(list)
for graph_index, system_id in enumerate(system_index["graph_to_system"]):
    indices_by_system[system_id].append(graph_index)

# 这里应由 PLINDER / 时间切分 / 家族切分等外部规则提供 system ID 集合。
train_systems = set(...)
train_indices = [
    graph_index
    for system_id in train_systems
    for graph_index in indices_by_system[system_id]
]
train_dataset = Subset(dataset, train_indices)
```

这批 HiQBind 数据没有自带 PLINDER split，也不应被解释为最终泛化评估集。它的主要用途是验证从 baseline pose 到 CQR-GNN 训练样本的端到端流程。

## 7. compact 格式为何更小

同一个 system 的蛋白静态节点特征、native 配体坐标和 protein–protein 边仅存储一次；每个 pose 只保存必要的动态特征、配体坐标和含配体边。`CompactGraphDataset` 会无损重建模型使用的标准 PyG `Data` 字段。

因此，虽然图数接近每个 system 20 个 pose，磁盘中不会为每个 pose 重复保存整份蛋白图。

## 8. 从 Docking Base 输出重新构建

本仓库发布的内容足以加载和训练，不包含原始 HiQBind PDB/SDF 或原始 docking 输出。若希望重建 compact 数据，过程为：

1. 准备符合 Docking Base common-output contract 的已发布 docking 结果；
2. 使用 `materialize_hiqbind_gnncp.py` 将嵌套输出硬链接为扁平 PDB pose 目录；
3. 使用 `build_compact_v1_direct.py` 构建可断点续跑的 compact shard；
4. 使用 `validate_compact_dataset.py` 或 `smoke_test_compact_dataset.py` 抽样验证。

扁平输入中的每个 system 至少需要：

```text
<system_id>/
├── protein.pdb
├── ligand.pdb
└── <system_id>_pose_001.pdb ...
```

构图入口只接受 PDB pose。典型命令：

```bash
python materialize_hiqbind_gnncp.py \
  --method diffdock \
  --source-root /path/to/docking_run \
  --output-root /path/to/materialized_diffdock

python build_compact_v1_direct.py \
  --data-dir /path/to/materialized_diffdock \
  --output-dir /path/to/diffdock_compact_v1 \
  --method diffdock \
  --target-shard-mib 512 \
  --system-workers 28 \
  --num-workers 1 \
  --memory-budget-gib 150 \
  --on-error skip-system \
  --resume
```

`--system-workers > 1` 时必须令 `--num-workers=1`，避免跨 system 并行和 pose 并行嵌套造成不可控内存峰值。上例是适用于 32 CPU / 192 GiB 节点的保守配置；请根据蛋白规模和节点内存调低 `--system-workers` 或 `--memory-budget-gib`。

## 9. 溯源字段

`manifest.json`、`source_index.json` 中的 source 字段只描述构图来源；它们不是下载后必须存在的本地路径。训练和 system-level split 仅需要 compact 根目录、`manifest.json`、`system_index.json` 和 `shards/`。