JiecongLin commited on
Commit
b150586
·
verified ·
1 Parent(s): 4f7c19b

Model card: pipeline naming (drop reproduction/reproducible)

Browse files
Files changed (1) hide show
  1. README.md +9 -9
README.md CHANGED
@@ -10,11 +10,11 @@ tags:
10
  library_name: pytorch
11
  ---
12
 
13
- # EPInformer — reproducible pipeline (pretrained checkpoints)
14
 
15
- Pretrained checkpoints for the **[EPInformer reproducible pipeline](https://github.com/pinellolab/EPInformer/tree/reproducible_pipeline)** — a from-raw-ENCODE reproduction of [EPInformer](https://github.com/pinellolab/EPInformer) across 6 cell lines (K562, GM12878, H1, HepG2, HUVEC, NHEK).
16
 
17
- Two models (defined in `EPInformer/models.py` on the `reproducible_pipeline` branch):
18
 
19
  - **`enhancer_predictor_256bp`** — 256 bp enhancer-activity encoder; predicts `log2(0.1 + sqrt(H3K27ac·DNase))` activity from sequence.
20
  - **`EPInformer_v2`** — gene-expression model (RNA / CAGE) that reuses the frozen encoder as its sequence backbone.
@@ -42,26 +42,26 @@ CAGE labels exist only for K562/GM12878 (the other four are RNA-only).
42
  enhancer_encoders/{CELL}/fold_{i}.pt # CELL ∈ {K562, GM12878, H1, HepG2, HUVEC, NHEK}, i ∈ 1..12
43
  ```
44
 
45
- These are the reproduction's **256 bp enhancer-activity encoders** — the best checkpoint for each of
46
  the 12 leave-chromosome-out folds, for all 6 cell lines (72 checkpoints). Any fold works for
47
  inference; the R values in the table above are pooled across all 12 held-out folds.
48
 
49
  > The KLF1 demo in the notebooks uses the original published EPInformer encoder shipped in the repo's
50
- > `trained_models/pretrained_enhancer_encoder/` — a separate checkpoint from these reproduction folds.
51
 
52
  ## Usage
53
 
54
  ```python
55
  import torch
56
  from huggingface_hub import hf_hub_download
57
- # the model class lives on the reproducible_pipeline branch:
58
- # git clone -b reproducible_pipeline https://github.com/pinellolab/EPInformer
59
  from EPInformer.models import enhancer_predictor_256bp
60
 
61
- ckpt = hf_hub_download("JiecongLin/EPInformer-reproducible", "enhancer_encoders/K562/fold_8.pt")
62
  net = enhancer_predictor_256bp()
63
  net.load_state_dict(torch.load(ckpt, map_location="cpu", weights_only=False)["model_state_dict"])
64
  net.eval()
65
  ```
66
 
67
- See the **[project wiki](https://github.com/pinellolab/EPInformer/wiki)** for the full training and evaluation guide, and the **[`reproducible_pipeline`](https://github.com/pinellolab/EPInformer/tree/reproducible_pipeline)** branch for code.
 
10
  library_name: pytorch
11
  ---
12
 
13
+ # EPInformer — pipeline (pretrained checkpoints)
14
 
15
+ Pretrained checkpoints for the **[EPInformer pipeline](https://github.com/pinellolab/EPInformer/tree/pipeline)** — a from-raw-ENCODE pipeline for [EPInformer](https://github.com/pinellolab/EPInformer) across 6 cell lines (K562, GM12878, H1, HepG2, HUVEC, NHEK).
16
 
17
+ Two models (defined in `EPInformer/models.py` on the `pipeline` branch):
18
 
19
  - **`enhancer_predictor_256bp`** — 256 bp enhancer-activity encoder; predicts `log2(0.1 + sqrt(H3K27ac·DNase))` activity from sequence.
20
  - **`EPInformer_v2`** — gene-expression model (RNA / CAGE) that reuses the frozen encoder as its sequence backbone.
 
42
  enhancer_encoders/{CELL}/fold_{i}.pt # CELL ∈ {K562, GM12878, H1, HepG2, HUVEC, NHEK}, i ∈ 1..12
43
  ```
44
 
45
+ These are the pipeline's **256 bp enhancer-activity encoders** — the best checkpoint for each of
46
  the 12 leave-chromosome-out folds, for all 6 cell lines (72 checkpoints). Any fold works for
47
  inference; the R values in the table above are pooled across all 12 held-out folds.
48
 
49
  > The KLF1 demo in the notebooks uses the original published EPInformer encoder shipped in the repo's
50
+ > `trained_models/pretrained_enhancer_encoder/` — a separate checkpoint from these folds.
51
 
52
  ## Usage
53
 
54
  ```python
55
  import torch
56
  from huggingface_hub import hf_hub_download
57
+ # the model class lives on the pipeline branch:
58
+ # git clone -b pipeline https://github.com/pinellolab/EPInformer
59
  from EPInformer.models import enhancer_predictor_256bp
60
 
61
+ ckpt = hf_hub_download("JiecongLin/EPInformer-pipeline", "enhancer_encoders/K562/fold_8.pt")
62
  net = enhancer_predictor_256bp()
63
  net.load_state_dict(torch.load(ckpt, map_location="cpu", weights_only=False)["model_state_dict"])
64
  net.eval()
65
  ```
66
 
67
+ See the **[project wiki](https://github.com/pinellolab/EPInformer/wiki)** for the full training and evaluation guide, and the **[`pipeline`](https://github.com/pinellolab/EPInformer/tree/pipeline)** branch for code.