jmschr commited on
Commit
80f8b93
·
verified ·
1 Parent(s): d4deb3f

Update README, metadata, and aggregated tables

Browse files
Files changed (1) hide show
  1. README.md +13 -7
README.md CHANGED
@@ -26,18 +26,24 @@ Models are trained on the human genome (**GRCh38 / hg38**) against the observed
26
 
27
  ## Repository layout
28
 
29
- Files are organized one directory per experiment, `<encid>/`:
30
 
31
  | file | description |
32
  |---|---|
33
- | `cherimoya.fold_<i>.torch` | the model checkpoint (EMA shadow weights) |
34
- | `cherimoya.fold_<i>.performance.tsv` | validation metrics for that fold |
35
- | `cherimoya.fold_<i>.log` | training log |
36
- | `cherimoya.fold_<i>.fit.json` / `.evaluate.json` | training / evaluation settings |
37
 
38
- `performance.tsv` has one row with columns (fixed order): `profile_mnll profile_jsd profile_pearson profile_spearman count_pearson count_spearman count_mse`; the headline metrics are `profile_pearson` (profile shape) and `count_pearson` (total accessibility).
39
 
40
- Experiment-level metadata is in `CATv1-metadata.tsv` (keyed by `experiment_accession`), and `manifest.csv` lists exactly which experiments and folds are included. Each `experiment_accession` is the source ENCODE experiment the models were trained on (`https://www.encodeproject.org/experiments/<experiment_accession>/`), and the paired `annotation_accession` points to the ENCODE ChromBPNet model annotation for that same experiment (`https://www.encodeproject.org/annotations/<annotation_accession>/`).
 
 
 
 
 
 
 
 
 
41
 
42
  ## Which model should I use?
43
 
 
26
 
27
  ## Repository layout
28
 
29
+ Each experiment's five fold checkpoints live under `<encid>/`:
30
 
31
  | file | description |
32
  |---|---|
33
+ | `<encid>/cherimoya.fold_<i>.torch` | checkpoint for fold `i` (EMA shadow weights) |
 
 
 
34
 
35
+ Repository-level files:
36
 
37
+ | file | description |
38
+ |---|---|
39
+ | `performance.tsv` | validation metrics for every experiment and fold |
40
+ | `CATv1-metadata.tsv` | experiment metadata, keyed by `experiment_accession` |
41
+ | `manifest.csv` | the full list of experiments and folds included |
42
+ | `fit.json` / `evaluate.json` | a representative example of the per-fold training / evaluation settings |
43
+
44
+ `performance.tsv` has one row per experiment-fold: the first two columns are `experiment_accession` and `fold`, followed by `profile_mnll profile_jsd profile_pearson profile_spearman count_pearson count_spearman count_mse`. The headline metrics are `profile_pearson` (profile shape) and `count_pearson` (total accessibility).
45
+
46
+ Each `experiment_accession` is the source ENCODE experiment the models were trained on (`https://www.encodeproject.org/experiments/<experiment_accession>/`), and the paired `annotation_accession` points to the ENCODE ChromBPNet model annotation for that same experiment (`https://www.encodeproject.org/annotations/<annotation_accession>/`).
47
 
48
  ## Which model should I use?
49