SEAM: Meta-explanations for interpreting sequence-based deep learning models
Project description
SEAM: systematic explanation of attribution-based mechanisms for regulatory genomics
SEAM (Systematic Explanation of Attribution-based for Mechanisms) is a Python suite to use meta-explanations to interpret sequence-based deep learning models for regulatory genomics data. For installation instructions, tutorials, and documentation, please refer to the SEAM website, https://seam-nn.readthedocs.io/. For an extended discussion of this approach and its applications, please refer to our paper:
- Seitz, E.E., McCandlish, D.M., Kinney, J.B., and Koo P.K. Deciphering the determinants of mechanistic variation in regulatory sequences. bioRxiv (2025). (unpublished)
Installation:
With Anaconda sourced, create a new environment via the command line:
conda create --name seam
Next, activate this environment via conda activate seam
, and install the following packages:
pip install seam-nn
Finally, when you are done using the environment, always exit via conda deactivate
.
Notes
SEAM has been tested on Mac and Linux operating systems. Typical installation time on a normal computer is less than 1 minute.
If you have any issues installing SEAM, please see:
- https://seam-nn.readthedocs.io/en/latest/installation.html
- https://github.com/evanseitz/seam-nn/issues
For issues installing SQUID, the package used for sequence generation and inference, please see:
- https://squid-nn.readthedocs.io/en/latest/installation.html
- https://github.com/evanseitz/squid-nn/issues
Older DNNs may require inference via Tensorflow 1.x or related packages in conflict with SEAM defaults. Users will need to run SEAM piecewise within separate environments:
- Tensorflow 1.x environment for generating in silico sequence-function-mechanism dataset
- Tensorflow 2.x environment for applying SEAM to explain in silico sequence-function-mechanism dataset
Usage:
SEAM provides a simple interface that takes as input a sequence-based deep-learning model (e.g., a DNN), which is used as an oracle to generate an in silico sequence-function-mechanism dataset representing a localized region of sequence space. SEAM uses a meta-explanation framework to interpret the in silico sequence-function-mechanism dataset, deciphering the determinants of mechanistic variation in regulatory sequences.
API figure: To be done.
Examples
Google Colab examples for applying SEAM on previously-published deep learning models are available at the following links:
Expected run time for the "Figure 2. Local library with hierarchical clustering | DeepSTARR" demo (above) is ~3.6 minutes using Google Colab T4 GPU.
Python script examples are provided in the examples/
folder for locally running SEAM and exporting outputs to file. Additional dependencies for these examples may be required and outlined at the top of each script. Examples include:
- To be done.
Citation:
If this code is useful in your work, please cite our paper.
bibtex TBD
License:
Copyright (C) 2023–2025 Evan Seitz, David McCandlish, Justin Kinney, Peter Koo
The software, code sample and their documentation made available on this website could include technical or other mistakes, inaccuracies or typographical errors. We may make changes to the software or documentation made available on its web site at any time without prior notice. We assume no responsibility for errors or omissions in the software or documentation available from its web site. For further details, please see the LICENSE file.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file seam_nn-0.2.1.tar.gz
.
File metadata
- Download URL: seam_nn-0.2.1.tar.gz
- Upload date:
- Size: 79.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.11.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5a770f895d1a43ef5ec96df19ec1bacabb773b67fb6031e3ef63781cab3eadc2 |
|
MD5 | ad28b9090b120acfd0032c0de923ee66 |
|
BLAKE2b-256 | f0e7ab74675bcfa56f9cc20c8d491148d4b9647ef5858b1a72c38c2999ab46c0 |
File details
Details for the file seam_nn-0.2.1-py3-none-any.whl
.
File metadata
- Download URL: seam_nn-0.2.1-py3-none-any.whl
- Upload date:
- Size: 88.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.11.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ee6d3872159a5c7318418fb1fe766d7a4be4a5f94e1d47286996716da2df54c0 |
|
MD5 | 43955da6dd925e432d051e56c0022ae1 |
|
BLAKE2b-256 | 1e1e87561e071cb011df025946b37b4de1f5592d66116f864ea4e8662404e30f |