lhqing commited on
Commit
debbd32
·
verified ·
1 Parent(s): ae99799

Add early benchmark README (M1 seqforge#56)

Browse files
Files changed (1) hide show
  1. README.md +82 -0
README.md ADDED
@@ -0,0 +1,82 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ pretty_name: seqforge benchmark
3
+ tags:
4
+ - genomics
5
+ - sequencing
6
+ - single-cell
7
+ - benchmark
8
+ - metadata-resolution
9
+ viewer: false
10
+ ---
11
+
12
+ # seqforge-benchmark
13
+
14
+ The standard benchmark for [**seqforge**](https://github.com/liuhlab/seqforge) — a compiler that turns
15
+ arbitrary FASTQ files plus unstructured metadata into a validated, machine-independent `manifest.yaml`
16
+ and a runnable Snakemake pipeline.
17
+
18
+ This repo hosts the benchmark's **fingerprint packages** so that seqforge's evaluation can run
19
+ **automatically in CI** without needing the full (often multi-terabyte) datasets present. It is the
20
+ online home referenced by seqforge milestone **M1**
21
+ ([issue #56](https://github.com/liuhlab/seqforge/issues/56)).
22
+
23
+ > **Status: early / work in progress.** The layout below is the intended shape; packages land as the
24
+ > M1 preflight tooling comes online. Nothing here is final yet.
25
+
26
+ ## What is a fingerprint package?
27
+
28
+ A fingerprint package is a small, self-contained `<dataset>.fingerprint.tar.gz` that stands in for a
29
+ whole dataset. It contains:
30
+
31
+ - **Information files** — the paper PDF plus its extracted text and images; any spreadsheets with each
32
+ sheet extracted to text.
33
+ - **Subsampled FASTQs** — every FASTQ cut to the first N reads, preserving the original directory
34
+ structure and filenames exactly.
35
+
36
+ seqforge decides what a dataset *is* from a bounded sample of reads (it never reads a whole FASTQ), so
37
+ a fingerprint carries enough signal to reproduce the **same manifest** the full dataset would — even
38
+ when the original FASTQs are gone. That is what makes a light, portable, CI-friendly benchmark
39
+ possible.
40
+
41
+ ## What this benchmark is for
42
+
43
+ - **Regression safety.** As seqforge grows to new technologies and pipelines, these representative
44
+ datasets must keep resolving correctly — and must never *silently* mis-compile. Each case ships a
45
+ pre-registered expectation; a verified-but-wrong answer is a hard failure.
46
+ - **A validation set, not a test set.** We develop against this corpus. A truly held-out test set for
47
+ unbiased accuracy will be a separate, later effort.
48
+
49
+ ## Intended layout
50
+
51
+ ```
52
+ cases/
53
+ <dataset-id>/
54
+ <dataset-id>.fingerprint.tar.gz # subsampled FASTQs + extracted info files
55
+ expected.yaml # pre-registered, checkable predictions
56
+ README.md # provenance: source accession, chemistry, why it's here
57
+ ```
58
+
59
+ Pre-registration discipline: `expected.yaml` records what the answer should be **before** a run —
60
+ only a prediction can be wrong. Claims are checkable against the compiled manifest (e.g. per-sample
61
+ attributes, resolved chemistry).
62
+
63
+ ## Seed corpus (M1)
64
+
65
+ The first packages come from seqforge's real-world compile audits:
66
+
67
+ - 13 *C. elegans* single-cell datasets (seqforge issue #42).
68
+ - 1 BD Rhapsody Enhanced ("v2") dataset (seqforge issue #43).
69
+
70
+ Coverage will broaden with seqforge itself — additional modalities (ATAC, multiome, ChIP, long-read,
71
+ WGBS, feature-barcode) as those pipelines land.
72
+
73
+ ## Provenance and licensing
74
+
75
+ Fingerprints are derived from **public** datasets (subsampled reads + published supplementary
76
+ material). Each case's `README.md` records its source accession. Private lab data is **never**
77
+ uploaded here — those cases stay out-of-band and run only where their data roots are configured.
78
+
79
+ ## Links
80
+
81
+ - seqforge: <https://github.com/liuhlab/seqforge>
82
+ - Milestone M1 (this benchmark's tracking issue): <https://github.com/liuhlab/seqforge/issues/56>