license: apache-2.0
tags:
- biology
scprint: Large Cell Model for scRNAseq data
scPRINT is a large transformer model built for the inference of gene network (connections between genes explaining the cell's expression profile) from scRNAseq data.
It uses novel encoding and decoding of the cell expression profile as well as new pre-training methodologies to learn a cell model.
scPRINT can do lots of things:
- expression denoising: increase the resolution of your scRNAseq data
- cell embedding: generate a low-dimensional representation of your dataset
- label prediction: predict the cell type, disease, sequencer, sex, and ethnicity of your cells
- gene network inference: generate a gene network from any cell or cell cluster in your scRNAseq dataset
Read the paper! if you want to know more about scPRINT.
Install it from PyPI
If you want to be using flashattention2, know that it only supports triton 2.0 MLIR's version and torch==2.0.0 for now.
👷 WIP ...
Install it in dev mode
For the moment scPRINT has been tested on MacOS and Linux (Ubuntu 20.04) with Python 3.10.
If you want to be using flashattention2, know that it only supports triton 2.0 MLIR's version and torch==2.0.0 for now.
conda create -n "[whatever]" python==3.10
git clone https://github.com/jkcobject/scPRINT
git clone https://github.com/jkobject/GRnnData
git clone https://github.com/jkobject/benGRN
cd scPRINT
git submodule init
git submodule update
pip install 'lamindb[jupyter,bionty]'
pip install -e scDataloader
pip install -e ../GRnnData/
pip install -e ../benGRN/
pip install torch==2.0.0 torchvision==0.15.1 torchaudio==2.0.1
# install the dev tooling if you need it too
pip install -e ".[dev]"
pip install -r requirements-dev.txt
pip install triton==2.0.0.dev20221202 --no-deps # only if you have a compatible gpu (e.g. not available for apple GPUs for now, see https://github.com/triton-lang/triton?tab=readme-ov-file#compatibility)
# install triton as mentioned in .toml if you want to
mkdocs serve # to view the dev documentation
We use additional packages we developped, refer to their documentation for more information:
- scDataLoader: a dataloader for training large cell models.
- GRnnData: a package to work with gene networks from single cell data.
- benGRN: a package to benchmark gene network inference methods from single cell data.
lamin.ai
⚠️ if you want to use the scDataloader's multi dataset mode or if you want to preprocess datasets and other functions of the model, you will need to use lamin.ai.
In that case connect with google or github to lamin.ai, then be sure to connect before running anything (or before starting a notebook): lamin login <email> --key <API-key>. Follow the instructions on their website.
Usage
scPRINT's basic commands
This is the most minimal example of how scprint gets used:
from lightning.pytorch import Trainer
from scprint import scPrint
from scdataloader import DataModule
datamodule = DataModule(...)
model = scPrint(...)
trainer = Trainer(...)
trainer.fit(model, datamodule=datamodule)
...
or
$ scprint fit/train/predict/test --config config/[medium|large|vlarge] ...
Notes on GPU/CPU usage with triton
If you do not have triton installed you will not be able to take advantage of gpu acceleration, but you can still use the model on the cpu.
In that case, if loading from a checkpoint that was trained with flashattention, you will need to specify transformer="normal" in the load_from_checkpoint function like so:
model = scPrint.load_from_checkpoint(
'../data/temp/last.ckpt', precpt_gene_emb=None,
transformer="normal")
We now explore the different usages of scPRINT:
I want to generate gene networks from scRNAseq data:
-> refer to the section 1. gene network inference in this notebook.
-> more examples in this notebook ./notebooks/assessments/bench_omni.ipynb.
I want to generate cell embeddings and cell label predictions from scRNAseq data:
-> refer to the embeddings and cell annotations section in this notebook.
I want to denoising my scRNAseq dataset:
-> refer to the Denoising of B-cell section in this notebook.
-> More example in our benchmark notebook ./notebooks/assessments/bench_denoising.ipynb.
I want to generate an atlas level embedding
-> refer to the notebook nice_umap.ipynb.
Documentation
/!\ WIP /!\
Model Weights
Model weights are available on hugging face.
Development
Read the CONTRIBUTING.md file.
Read the training runs document to know more about how training was performed and the results there.
acknowledgement: python template laminDB lightning
Awesome Large Cell Model created by Jeremie Kalfon.