Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

DeepDETAILS: Deep-learning-based DEconvolution of Tissue profiles with Accurate Interpretation of Locus-specific Signals


Supported platforms Supported Python versions PyPI DeepDETAILS compendium

Installation

Recommended: install with conda/mamba so binary dependencies (bedtools, bedGraphToBigWig) are installed automatically:

conda install -c bioconda -c conda-forge "pytorch=2.6.0=cuda*" deepdetails

Alternatively, install with pip (you must provide the binaries yourself):

pip install DeepDETAILS

If you install via pip, make sure bedGraphToBigWig and bedtools are on your PATH. DeepDETAILS uses these tools when exporting deconvolved results to bigWig files.

Get started

Step 1: Prepare datasets for deconvolution

DeepDETAILS requires the following input files:

  • Strand-specific signals for the bulk library (bigWig format)
  • Region of interests (e.g. peaks) in the bulk library (bed format)
  • Aligned fragments from the reference sc/snATAC-seq (bed-like tabular format, required columns: chrom, chromStart, chromEnd, barcode, and readSupport). Example
  • Cell type annotation for each cell barcode (tabular format, required columns: barcode and cell type annotation).
  • Reference genome sequence (fasta format).
  • Chromosome size.
deepdetails prep-data \
    --bulk-pl bulk.pl.bw \
    --bulk-mn bulk.mn.bw \
    --regions bulk.peaks.bed \
    --fragments fragments.tsv.gz \
    --barcodes barcodes.tsv \
    --accessible-regions atac_peaks.bed \
    --save-to ./dataset \
    --genome-fa GRCh38_no_alt_analysis_set_GCA_000001405.15.fasta \
    --chrom-size chrNameLength.txt

Step 2: Deconvolution

After building the dataset folder, you can run the deconvolution process (requires GPU):

deepdetails deconv \
    --dataset ./dataset \
    --save-to . \
    --study-name sample-a

The outputs from a successful deconvolution process look like the following:

.
├── sample-a
│   └── 250212144109: The folder containing deconvolution results (name changes according to the time).
│       ├── epoch=0-step=2538.ckpt: Trained model
│       ├── hparams.yaml: Hyperparameters
│       ├── metrics.csv: Training log
...
│       └── preview972.0.131072.0000.s21250212144109.png: Preview genome browser views
├── sample-a.counts.csv.gz: Deconvolved read counts (1-kb resolution) for each cell type
└── sample-a.predictions.h5: Deconvolved signal (1-bp resolution) for each cell type

Step 3: Visualize the results (optional)

This step exports deconvolved signal tracks (bigWig) to visualize the signals in each cell type, and it's optional. You need to locate the exported predictions from the previous step by looking for files like sample-name.predictions.h5. After you get the file, you can run the following command:

deepdetails build-bw \
    -p sample-name.predictions.h5 \
    --save-to . \
    --chrom-size chrNameLength.txt

You should be able to see deconvolved signal tracks for each cell type (named like cell_type.pl.bw / cell_type.mn.bw) in the output directory after the command finishes.

Step 4: Visualize sequence attributions (optional)

This step exports sequence attribution tracks from trained DeepDETAILS models (using Input X Gradient):

deepdetails attr \
  -m sample-a/250212144109/epoch=0-step=2538.ckpt \
  --dataset ./dataset \
  --chrom-size chrNameLength.txt

Reference

If you find DeepDETAILS helpful, please cite:

Yao, L. et al. High-resolution reconstruction of cell-type-specific transcriptional regulatory processes from bulk sequencing samples. Nat Biotechnol 1–12 (2026) doi:10.1038/s41587-026-03218-w.

Download files

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

Source Distribution

deepdetails-1.0.0rc1.tar.gz (23.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

deepdetails-1.0.0rc1-py3-none-any.whl (88.2 kB view details)

Uploaded Python 3

File details

Details for the file deepdetails-1.0.0rc1.tar.gz.

File metadata

  • Download URL: deepdetails-1.0.0rc1.tar.gz
  • Upload date:
  • Size: 23.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for deepdetails-1.0.0rc1.tar.gz
Algorithm Hash digest
SHA256 b442a84cabd097c71215c71bf8341165077d74fb1c854f259c4f442fb6a293dc
MD5 c5a51ed58a26de12646701491432fd6c
BLAKE2b-256 7b9c055c6e659a7259cc50e302bc64f90be7d4f93769f92af996ac72cbe9f43f

See more details on using hashes here.

Provenance

The following attestation bundles were made for deepdetails-1.0.0rc1.tar.gz:

Publisher: publish.yml on liyao001/DeepDETAILS

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file deepdetails-1.0.0rc1-py3-none-any.whl.

File metadata

  • Download URL: deepdetails-1.0.0rc1-py3-none-any.whl
  • Upload date:
  • Size: 88.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for deepdetails-1.0.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 610291e3e5d4a942ec69d82a640f9cfa50cb55c99d19791cf02d0ce2e9cdeece
MD5 9e32c492a251d969fb30c0df520fb28e
BLAKE2b-256 61a2623ae5f063b401aa26f5171250527ce95550354a6f43d79cb3cbe1c44f23

See more details on using hashes here.

Provenance

The following attestation bundles were made for deepdetails-1.0.0rc1-py3-none-any.whl:

Publisher: publish.yml on liyao001/DeepDETAILS

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

1.0.0rc1 This release

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page