Add BPNet model ENCSR867KCV (ENCSR000ATM)

.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 K562 (ENCSR000ATM)
+
+- Model: BPNet
+- Assay: TF ChIP-seq
+- Target: REST
+- Experiment: [ENCSR000ATM](https://www.encodeproject.org/experiments/ENCSR000ATM/)
+- Model annotation: [ENCSR867KCV](https://www.encodeproject.org/annotations/ENCSR867KCV/)
+- Biosample: K562 (Full name: Homo sapiens K562)
+- Cell slim(s): leukocyte, hematopoietic cell, cancer cell
+- Organ slim(s): bodily fluid, blood
+- Developmental slim(s): mesoderm
+- System slim(s): immune 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, 587.01615368936],
+    "counts_loss": "MSE"
+}

fold_0/model.h5

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

fold_0/saved_model/saved_model.pb

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

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

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

fold_1/model.h5

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

fold_1/saved_model/saved_model.pb

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

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

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

fold_2/model.h5

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

fold_2/saved_model/saved_model.pb

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

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

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

fold_3/model.h5

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

fold_3/saved_model/saved_model.pb

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

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

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

fold_4/model.h5

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

fold_4/saved_model/saved_model.pb

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

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

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