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=*=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)
  • Regions of interest (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). Records should be sorted by their coordinates (sort -k1,1 -k2,2n).
  • 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.

Metadata

Release files for DeepDETAILS 1.0.0rc2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for DeepDETAILS 1.0.0rc2
File Size Uploaded Provenance Actions
deepdetails-1.0.0rc2.tar.gz 23.9 MB With provenance Details for deepdetails-1.0.0rc2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for DeepDETAILS 1.0.0rc2
File Interpreter ABI Platform Actions
deepdetails-1.0.0rc2-py3-none-any.whl Python 3 none any Details for deepdetails-1.0.0rc2-py3-none-any.whl

Total release size: 24.0 MB

Release files / deepdetails-1.0.0rc2.tar.gz

Download URL deepdetails-1.0.0rc2.tar.gz
Size 23.9 MB
Tags Source
SHA-256 checksum
How to use checksums
5f8f35d4e4f73eb92a07a0a9ee9ceccb479a3daf6cb79cb3d9476a83e6dd8d7a
BLAKE2b-256 checksum
How to use checksums
cc7ee2f3e0e0b0dc438f05a776b1a442982e51f08dc8dc52330d34b988d86105
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 12, 2026.

Transparency log

Release files / deepdetails-1.0.0rc2-py3-none-any.whl

Download URL deepdetails-1.0.0rc2-py3-none-any.whl
Size 81.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e0fdd0f67ef7e465f2b0d2f3e2be1603b8e286d2072d92098eead24f732fb85d
BLAKE2b-256 checksum
How to use checksums
440071b21b5681d5d2ce53a486be901866b3b0b18cb83209fd1e77d85958a5a6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 12, 2026.

Transparency log

Security for DeepDETAILS 1.0.0rc2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for deepdetails-1.0.0rc2.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 12, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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