Skip to main content

SEAM: Meta-explanations for interpreting sequence-based deep learning models

Project description

SEAM: systematic explanation of attribution-based mechanisms for regulatory genomics

PyPI version Downloads Documentation Status

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 manuscript, which we presented at the ICLR 2025 GEM Workshop:

  • Seitz, E.E., McCandlish, D.M., Kinney, J.B., and Koo P.K. Decoding the Mechanistic Impact of Genetic Variation on Regulatory Sequences with Deep Learning. Workshop on Generative and Experimental Perspectives for Biomolecular Design, International Conference on Learning Representations, April 15, 2025. https://openreview.net/forum?id=PtjMeyHcTt

A bioRxiv preprint is also currently underway.


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:

For issues installing SQUID, the package used for sequence generation and inference, please see:

Older DNNs that require inference via Tensorflow 1.x or related packages may be in conflict with SEAM defaults. Users will need to run SEAM piecewise within separate environments:

  1. Tensorflow 1.x environment for generating in silico sequence-function-mechanism dataset
  2. 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 oracle (e.g., a genomic DNN), which is used 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.

fig

Examples

Google Colab examples for applying SEAM on previously-published deep learning models are available at the links below.

Note: Due to memory requirements for calculating distance matrices, Colab Pro may be required for examples using hierarchical clustering with their current settings.

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.

SEAM Interactive Interpretability Tool:

A graphic user interface (GUI) is available for dynamically interpretting SEAM results. The GUI can be run using the command line interface from the seam folder via python seam_gui.py. The SEAM GUI requires pre-computed inputs that can be saved using the example scripts above.

fig

Citation:

If this code is useful in your work, please cite our paper.

bibtex TODO

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

seam_nn-0.5.5.tar.gz (98.3 kB view details)

Uploaded Source

Built Distribution

seam_nn-0.5.5-py3-none-any.whl (109.0 kB view details)

Uploaded Python 3

File details

Details for the file seam_nn-0.5.5.tar.gz.

File metadata

  • Download URL: seam_nn-0.5.5.tar.gz
  • Upload date:
  • Size: 98.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for seam_nn-0.5.5.tar.gz
Algorithm Hash digest
SHA256 e03a937c59ff57152f74353ce4ef2b06ac9f38d01efdc553089d9bc77642bc13
MD5 83b2258570808a23f26d184c51318b84
BLAKE2b-256 09c303c1ff7d21322d16b3b969e9406bc95b8fa13a2469137275d716b972d62e

See more details on using hashes here.

File details

Details for the file seam_nn-0.5.5-py3-none-any.whl.

File metadata

  • Download URL: seam_nn-0.5.5-py3-none-any.whl
  • Upload date:
  • Size: 109.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.9

File hashes

Hashes for seam_nn-0.5.5-py3-none-any.whl
Algorithm Hash digest
SHA256 438c614b3d7807110c82e0fa4a4f61de2277bbb0a1ec9f7399944f5c9f94671a
MD5 98ae0cc791935068fb16885fc4fb032e
BLAKE2b-256 cdaea1c99125e04829452173deaa05c7be327f833fcb856886fba3b02903536d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page