Update README.md
Browse files
README.md
CHANGED
|
@@ -19,73 +19,17 @@ used to model base-resolution binding signal and to discover sequence motifs via
|
|
| 19 |
TF-MoDISco.
|
| 20 |
|
| 21 |
## Model details
|
| 22 |
-
|
| 23 |
-
- **Architecture:** BPNet (`bpnet-lite` implementation), ? filters,
|
| 24 |
-
? dilated convolutional layers, with bias tracks for both the
|
| 25 |
-
profile and total-count heads.
|
| 26 |
- **Genome:** mm10
|
| 27 |
-
- **Input window:** 2114 bp sequence -> **output window:**
|
| 28 |
-
1000 bp profile prediction
|
| 29 |
-
- **Training data:** SOX2 ChIP-seq, MACS2 narrow peaks as positive loci,
|
| 30 |
-
with a matched negative set.
|
| 31 |
-
- Peaks (loci): `/scratch/prj/stem_cells_pituitary/Bence/atacseq_chip_results/26/bwa/merged_library/macs2/narrow_peak/SOX2_REP1.mLb.clN_peaks.bed`
|
| 32 |
-
- Signal (BAM): `exp26_SOX2.bw`
|
| 33 |
-
- Negatives: `/scratch/prj/stem_cells_pituitary/Bence/atacseq_chip_results/26/bwa/merged_library/macs2/narrow_peak/SOX2_negatives_bpnet.bed`
|
| 34 |
-
- **Train/validation split (by chromosome):**
|
| 35 |
-
- Validation: ``
|
| 36 |
-
- Training: all other chromosomes (see `exp26_SOX2.bpnet.fit.json` for the
|
| 37 |
-
exact list)
|
| 38 |
-
- **Training hyperparameters:** lr=None, batch_size=None,
|
| 39 |
-
max_epochs=None, early_stopping=None epochs,
|
| 40 |
-
max_jitter=None, reverse_complement_augmentation=None
|
| 41 |
- **Checkpoint selection:** `exp26_SOX2.torch` is the best-validation-loss checkpoint saved
|
| 42 |
during training by `bpnet-lite`'s `fit` routine (as opposed to a `.final.torch` checkpoint,
|
| 43 |
which reflects the last training epoch and is not included here).
|
| 44 |
|
| 45 |
## Performance
|
| 46 |
|
| 47 |
-
Reported metrics
|
| 48 |
-
|
| 49 |
-
```
|
| 50 |
-
profile_mnll profile_jsd profile_pearson profile_spearman count_pearson count_spearman count_mse
|
| 51 |
-
472.9859924316406 0.44859686493873596 0.20588907599449158 0.06264603137969971 0.39160212874412537 0.3859022855758667 0.6483629941940308
|
| 52 |
-
```
|
| 53 |
|
| 54 |
See `exp26_SOX2.evaluate.json` for the full evaluation output.
|
| 55 |
|
| 56 |
-
## How to load
|
| 57 |
-
|
| 58 |
-
This model was trained with `bpnet-lite` and is saved as a raw PyTorch `state_dict`-style
|
| 59 |
-
`.torch` checkpoint (not a `transformers`-compatible format). To load it, install
|
| 60 |
-
`bpnet-lite` and use its `BPNet` class directly:
|
| 61 |
-
|
| 62 |
-
```bash
|
| 63 |
-
pip install bpnet-lite
|
| 64 |
-
```
|
| 65 |
-
|
| 66 |
-
```python
|
| 67 |
-
import torch
|
| 68 |
-
from bpnetlite import BPNet
|
| 69 |
-
|
| 70 |
-
# Re-create the architecture with the same hyperparameters used in training
|
| 71 |
-
# (see exp26_SOX2.bpnet.fit.json for the full config)
|
| 72 |
-
model = BPNet(
|
| 73 |
-
n_filters=64,
|
| 74 |
-
n_layers=8,
|
| 75 |
-
profile_output_bias=True,
|
| 76 |
-
count_output_bias=True,
|
| 77 |
-
)
|
| 78 |
-
|
| 79 |
-
state_dict = torch.load("exp26_SOX2.torch", map_location="cpu")
|
| 80 |
-
model.load_state_dict(state_dict)
|
| 81 |
-
model.eval()
|
| 82 |
-
```
|
| 83 |
-
|
| 84 |
-
> Double check the exact `BPNet(...)` constructor signature against the `bpnet-lite`
|
| 85 |
-
> version you have installed, since argument names/defaults can change between releases.
|
| 86 |
-
> Pin the same `bpnet-lite` version that produced this model if you need exact
|
| 87 |
-
> reproducibility — see `exp26_SOX2.log` for environment details if recorded.
|
| 88 |
-
|
| 89 |
## Files
|
| 90 |
|
| 91 |
| File | Description |
|
|
@@ -96,16 +40,3 @@ model.eval()
|
|
| 96 |
| `exp26_SOX2.performance.tsv` | Reported performance metrics |
|
| 97 |
| `exp26_SOX2.evaluate.json` | Full evaluation output |
|
| 98 |
| `exp26_SOX2.log` | Training log |
|
| 99 |
-
|
| 100 |
-
## Citation
|
| 101 |
-
|
| 102 |
-
If you use this model, please cite the original BPNet paper and the `bpnet-lite`
|
| 103 |
-
software:
|
| 104 |
-
|
| 105 |
-
- Avsec et al., "Base-resolution models of transcription-factor binding reveal soft
|
| 106 |
-
motif syntax", *Nature Genetics*, 2021.
|
| 107 |
-
- `bpnet-lite`: https://github.com/jmschrei/bpnet-lite
|
| 108 |
-
|
| 109 |
-
## Repo
|
| 110 |
-
|
| 111 |
-
`ge8rgia/BPNet_ChIP-seq_SOX2`
|
|
|
|
| 19 |
TF-MoDISco.
|
| 20 |
|
| 21 |
## Model details
|
|
|
|
|
|
|
|
|
|
|
|
|
| 22 |
- **Genome:** mm10
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 23 |
- **Checkpoint selection:** `exp26_SOX2.torch` is the best-validation-loss checkpoint saved
|
| 24 |
during training by `bpnet-lite`'s `fit` routine (as opposed to a `.final.torch` checkpoint,
|
| 25 |
which reflects the last training epoch and is not included here).
|
| 26 |
|
| 27 |
## Performance
|
| 28 |
|
| 29 |
+
Reported metrics found in `exp26_SOX2.performance.tsv`.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 30 |
|
| 31 |
See `exp26_SOX2.evaluate.json` for the full evaluation output.
|
| 32 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 33 |
## Files
|
| 34 |
|
| 35 |
| File | Description |
|
|
|
|
| 40 |
| `exp26_SOX2.performance.tsv` | Reported performance metrics |
|
| 41 |
| `exp26_SOX2.evaluate.json` | Full evaluation output |
|
| 42 |
| `exp26_SOX2.log` | Training log |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|