Skip to main content

Pan-cancer detection of T-cell clonal expansion from single-cell RNA sequencing (CUDA-enabled)

Project description

PyPI version Python versions License Visitors

scXpand Logo

scXpand: Pan-cancer Detection of T-cell Clonal Expansion

Detect T-cell clonal expansion from single-cell RNA sequencing data without paired TCR sequencing

PreprintDocumentationInstallationQuick StartUsage GuideCitation

scXpand Datasets Overview

A framework for predicting T-cell clonal expansion from single-cell RNA sequencing data.

Manuscript in preparation - detailed methodology and benchmarks coming soon.

View full documentation for comprehensive guides and API reference.


Features

  • Multiple Model Architectures:
    • Autoencoder-based: Encoder-decoder with reconstruction and classification heads
    • MLP: Multi-layer perceptron
    • LightGBM: Gradient boosted decision trees
    • Linear Models: Logistic regression and support vector machines
  • Scalable Processing: Handles millions of cells with memory-efficient data streaming from disk during training
  • Automated Hyperparameter Optimization: Built-in Optuna integration for model tuning

Installation

For detailed installation instructions, please refer to our Installation Guide.

Published Version Install

CUDA version (NVIDIA GPU):

pip install --upgrade scxpand-cuda --extra-index-url https://download.pytorch.org/whl/cu128

CPU/Apple Silicon/Other GPUs:

pip install --upgrade scxpand

Development Setup (Install from Source)

See the Installation Guide


Quick Start

import scxpand
# Make sure that "your_data.h5ad" includes only T cells for the results to be meaningful
# Ensure that "your_data.var_names" are provided as Ensembl IDs (as the pre-trained models were trained using this gene representation)
# Please refer to our documentation for more information

# List available pre-trained models
scxpand.list_pretrained_models()

# Run inference with automatic model download
results = scxpand.run_inference(
    model_name="pan_cancer_autoencoder",  # default model
    data_path="your_data.h5ad"
)

# Access predictions
predictions = results.predictions
if results.has_metrics:
    print(f"AUROC: {results.get_auroc():.3f}")

See our Tutorial Notebook for a complete example with data preprocessing, T-cell filtering, gene ID conversion, and model application using a real breast cancer dataset.


Documentation

Setup & Getting Started:

Using Pre-trained Models:

Training Your Own Models:

Understanding Results:

📖 Full Documentation - Complete guides, API reference, and interactive tutorials


License

This project is licensed under the MIT License – see the LICENSE file for details.


Citation

If you use scXpand in your research, please cite:

Shorer, O., Amit, R., and Yizhak, K. (2025). scXpand: Pan-cancer detection of T-cell clonal expansion from single-cell RNA sequencing without paired single-cell TCR sequencing. Preprint at bioRxiv, https://doi.org/10.1101/2025.09.14.676069.

BibTeX
@article{shorer2025scxpand,
  title={scXpand: Pan-cancer detection of T-cell clonal expansion from single-cell RNA sequencing without paired single-cell TCR sequencing},
  author={Shorer, Ofir and Amit, Ron and Yizhak, Keren},
  year={2025},
  journal={bioRxiv},
  doi={https://doi.org/10.1101/2025.09.14.676069}
}

This project was created in favor of the scientific community worldwide, with a special dedication to the cancer research community.

We hope you'll find this repository helpful, and we warmly welcome any requests or suggestions - please don't hesitate to reach out!

Visitor Map

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

scxpand_cuda-0.3.14.dev0.tar.gz (7.0 MB view details)

Uploaded Source

Built Distribution

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

scxpand_cuda-0.3.14.dev0-py3-none-any.whl (141.5 kB view details)

Uploaded Python 3

File details

Details for the file scxpand_cuda-0.3.14.dev0.tar.gz.

File metadata

  • Download URL: scxpand_cuda-0.3.14.dev0.tar.gz
  • Upload date:
  • Size: 7.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.22

File hashes

Hashes for scxpand_cuda-0.3.14.dev0.tar.gz
Algorithm Hash digest
SHA256 fda2851e5dd2e86afbb63016c33f715d316906dcacccfe043c330216c338ddce
MD5 0c8fa53d09ec74493b2ebc8357fd22b1
BLAKE2b-256 1ce48965097a739dbcb34b3ce3968cf8768d26abbc7618e1f8d89f110bce782a

See more details on using hashes here.

File details

Details for the file scxpand_cuda-0.3.14.dev0-py3-none-any.whl.

File metadata

File hashes

Hashes for scxpand_cuda-0.3.14.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 b4b462aedafbfe32b30b45bf123d5f7e7e9c99378e2191f1e8e4e1a7f436b93e
MD5 a1e8d61ed24b7b2e497ee30d27dee7e4
BLAKE2b-256 7c312a8f26e6e4cd8ac889d533155358ee921570bbd6f784e51fa2d842b237e9

See more details on using hashes here.

Supported by

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