Add BPNet model ENCSR584FHS (ENCSR892DRK)

.gitattributes

@@ -33,3 +33,8 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.zip filter=lfs diff=lfs merge=lfs -text
 *.zst filter=lfs diff=lfs merge=lfs -text
 *tfevents* filter=lfs diff=lfs merge=lfs -text
+fold_0/saved_model/variables/variables.data-00000-of-00001 filter=lfs diff=lfs merge=lfs -text
+fold_1/saved_model/variables/variables.data-00000-of-00001 filter=lfs diff=lfs merge=lfs -text
+fold_2/saved_model/variables/variables.data-00000-of-00001 filter=lfs diff=lfs merge=lfs -text
+fold_3/saved_model/variables/variables.data-00000-of-00001 filter=lfs diff=lfs merge=lfs -text
+fold_4/saved_model/variables/variables.data-00000-of-00001 filter=lfs diff=lfs merge=lfs -text

README.md

@@ -0,0 +1,137 @@
+---
+license: cc-by-4.0
+library_name: bpnet
+tags:
+  - bpnet
+  - dna
+  - genomics
+  - transcription-factor-binding
+  - chip-seq
+  - encode
+  - encode-bpnet-atlas
+  - hg38
+  - qc-passed
+  - REST
+---
+
+# ENCODE BPNet Atlas
+
+As part of the ENCODE 4 Project, we trained BPNet models on 2,339 ENCODE
+transcription factor ChIP-seq experiments spanning 788 targets across
+175 biosamples. Here, we provide all models for open-source use.
+
+For more information about the models, see:
+
+- Main ENCODE 4 Paper
+- A unified lexicon of predictive DNA sequence motifs from ENCODE transcription
+  factor binding and chromatin accessibility assays (Deshpande et al., Zenodo 2025)
+- Base-resolution models of transcription-factor binding reveal soft motif syntax
+  (Avsec et al., Nat Genet 2021)
+
+## BPNet model: REST ChIP-seq in A549 (ENCSR892DRK)
+
+- Model: BPNet
+- Assay: TF ChIP-seq
+- Target: REST
+- Experiment: [ENCSR892DRK](https://www.encodeproject.org/experiments/ENCSR892DRK/)
+- Model annotation: [ENCSR584FHS](https://www.encodeproject.org/annotations/ENCSR584FHS/)
+- Biosample: A549 (Full name: Homo sapiens A549)
+- Cell slim(s): cancer cell
+- Organ slim(s): lung
+- Developmental slim(s): endoderm
+- System slim(s): respiratory system
+- Assembly: hg38
+
+## QC
+
+- Status: passed
+- Notes: Found direct motif (counts, profile);
+
+## Directory structure
+
+5-fold cross-validation. Each `fold_*/` contains the trained BPNet model in two formats:
+
+- `fold_0/model.h5` — BPNet model in .h5 (Keras) format
+- `fold_0/saved_model/` — BPNet model in TensorFlow SavedModel format (a directory; load directly)
+- `config.json` — training / architecture parameters
+
+## Instructions
+
+BPNet takes a one-hot DNA sequence plus control (bias) inputs and predicts
+stranded profile logits and total logcounts. The control inputs come from the
+matched WCE/Input DNA control and **can be passed as zeros**.
+
+### 1. Loading the SavedModel and making predictions
+
+```python
+import numpy as np
+import tensorflow as tf
+from scipy.special import logsumexp
+
+model = tf.saved_model.load("fold_0/saved_model")
+# sequence: (N, 2114, 4) one-hot [A,C,G,T]
+# profile_bias_input: (N, 1000, 2) per-base profile bias from WCE/Input control, or zeros
+# counts_bias_input:  (N, 2) log2 total counts from WCE/Input control, or zeros
+predictions = model.signatures["serving_default"](**{
+    "sequence": sequence.astype("float32"),
+    "profile_bias_input_0": profile_bias_input.astype("float32"),
+    "counts_bias_input_0": counts_bias_input.astype("float32")})
+# predictions["profile_predictions"]:   (N, 1000, 2) logits (strands NOT independent)
+# predictions["logcounts_predictions"]: (N, 1) total logcount
+
+output_len = 1000
+def vectorized_prediction_to_profile(predictions):
+    logits_arr = predictions["profile_predictions"]
+    counts_arr = predictions["logcounts_predictions"]
+    pred_profile_logits = np.reshape(logits_arr, [-1, 1, output_len * 2])
+    probVals_array = np.exp(pred_profile_logits - logsumexp(
+        pred_profile_logits, axis=2).reshape([len(logits_arr), 1, 1]))
+    profile_predictions = np.multiply(
+        np.exp(counts_arr).reshape([len(counts_arr), 1, 1]), probVals_array)
+    plus  = np.reshape(profile_predictions, [len(counts_arr), output_len, 2])[:, :, 0]
+    minus = np.reshape(profile_predictions, [len(counts_arr), output_len, 2])[:, :, 1]
+    return plus, minus, counts_arr
+
+plus, minus, logcounts = vectorized_prediction_to_profile(predictions)
+```
+
+### 2. Loading the .h5 (Keras) and making predictions
+
+```python
+import numpy as np
+import tensorflow as tf
+import tensorflow.keras.backend as kb
+from tensorflow.keras.models import load_model
+from tensorflow.keras.utils import CustomObjectScope
+from bpnet.model.custommodel import CustomModel
+
+def get_model(model_path):
+    with CustomObjectScope({"kb": kb, "tf": tf, "CustomModel": CustomModel}):
+        return load_model(model_path)
+
+model = get_model("fold_0/model.h5")
+N = sequence.shape[0]
+predictions = model.predict([
+    sequence,                     # (N, 2114, 4)
+    np.zeros((N, 1000, 2)),       # profile_bias_input (or real WCE/Input control values)
+    np.zeros((N, 2))])            # counts_bias_input  (or real control log2 counts)
+# predictions[0]: (N, 1000, 2) logits;  predictions[1]: (N, 1) logcounts
+# convert with the same vectorized_prediction_to_profile() (predictions[0], predictions[1])
+```
+
+## Docker image to load and use the models
+
+`kundajelab/bpnet-atlas` (placeholder — image forthcoming).
+
+## Code
+
+- Code: https://github.com/kundajelab/bpnet/
+- Toolbox & downstream analysis: https://github.com/kundajelab/bpnet/wiki
+
+## License & citation
+
+External data users may freely download, analyze and publish results based on any
+ENCODE data without restrictions.
+
+Released under the ENCODE data-use policy. Please cite the ENCODE Project
+Consortium and the model software: BPNet (Avsec et al., Nat Genet 2021).

config.json

@@ -0,0 +1,45 @@
+{
+    "input_len": 2114,
+    "output_profile_len": 1000,
+    "motif_module_params": {
+        "filters": [64],
+        "kernel_sizes": [21],
+        "padding": "valid"
+    },
+    "syntax_module_params": {
+        "num_dilation_layers": 8,
+        "filters": 64,
+        "kernel_size": 3,
+        "padding": "valid",
+        "pre_activation_residual_unit": true
+    },
+    "profile_head_params": {
+        "filters": 1,
+        "kernel_size":  75,
+        "padding": "valid"
+    },
+    "counts_head_params": {
+        "filters": 1,
+        "kernel_size":  75,
+        "padding": "valid",
+        "units": [1],
+        "activations":["linear"],
+		"dropouts":[0]
+		
+    },
+    "profile_bias_module_params": {
+        "kernel_sizes": [1]
+    },
+    "counts_bias_module_params": {
+    },
+    "use_attribution_prior": false,
+    "attribution_prior_params": {
+        "frequency_limit": 150,
+        "limit_softness": 0.2,
+        "grad_smooth_sigma": 3,
+        "profile_grad_loss_weight": 200,
+        "counts_grad_loss_weight": 100        
+    },
+    "loss_weights": [1, 251.0742334322453],
+    "counts_loss": "MSE"
+}

fold_0/model.h5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ac49a259acba8cb5c6ee7020918ff75c5e6e659164defebc87583a3ae773747d
+size 561784

fold_0/saved_model/saved_model.pb

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:d34fbc6911bc8b7a299ad8c0ccaa449e6f7b1c6d79c0c9673c1c5d1cd6246e98
+size 750201

fold_0/saved_model/variables/variables.data-00000-of-00001

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:bd1528bf90442b3d19f3a15a88f90c1f8dd587ff445afdb24d1dec8857f332a8
+size 1393322

fold_1/model.h5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:d880d3a7fc224a2f9f6ceb2f878366f6a99c01e230fbb6b3ddf6a209cbce25dc
+size 561784

fold_1/saved_model/saved_model.pb

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:3b46a99ab61203c341d17905a8ab897d82fb6512c8bf5c8c4fd4b97453fe3d91
+size 750201

fold_1/saved_model/variables/variables.data-00000-of-00001

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4a8c1b7918078fd1a44393a71eab3fbb84308916314caeedef3cd3ba55465300
+size 1393322

fold_2/model.h5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:7e3174cd126626a8e00d5af31cbead4bc05f339047ee0c38d5bdf3019fce3ba9
+size 561784

fold_2/saved_model/saved_model.pb

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:19c680db757b6f9ede3a115411987452c5641f37ee3119c0ac350ba3dfad6914
+size 750201

fold_2/saved_model/variables/variables.data-00000-of-00001

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:087b35303ac51dd0dd3f8219c749bf93fc6db2717f58a668b9b6c24ebe292e09
+size 1393322

fold_3/model.h5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:b5fada82d9bf2b042987d2a22bef1413e1788c26889873cc04ddd5dce6a57ebc
+size 561784

fold_3/saved_model/saved_model.pb

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:454eaeaac5d8daf8cd2e72a4d94f4c8a1b536110249557006a4f9be7ee7b8d07
+size 750201

fold_3/saved_model/variables/variables.data-00000-of-00001

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:3c9d29ae1930e61dc4f69231f3c11141c51d5c77d2e5827ad2f6047ec4d17d2b
+size 1393322

fold_4/model.h5

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:dfc02207092acef98b8e4d43747601a04d00f093b08955555b87cdc725ec8fe6
+size 561784

fold_4/saved_model/saved_model.pb

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:194dd5a2d26e8e1d9e26433a80dc3202d76ad96c1d839bc7ffe77ed247b5f488
+size 750201

fold_4/saved_model/variables/variables.data-00000-of-00001

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:3c8a80f593ea9eb648147940a036bc56293a50d598d733efac9961ee6c907fb3
+size 1393322