Skip to main content

GEARS: Predicting transcriptional outcomes of novel multi-gene perturbations

This repository hosts the official implementation of GEARS, a method that can predict transcriptional response to both single and multi-gene perturbations using single-cell RNA-sequencing data from perturbational screens.

gears

Installation

Install PyG, and then do pip install cell-gears.

[New] Updates in v0.1.0

  • Preprocessed dataloader now available for Replogle 2022 RPE1 and K562 essential datasets
  • Added custom split, fixed no-test split

Core API Interface

Using the API, you can (1) reproduce the results in our paper and (2) train GEARS on your perturbation dataset using a few lines of code.

from gears import PertData, GEARS

# get data
pert_data = PertData('./data')
# load dataset in paper: norman, adamson, dixit.
pert_data.load(data_name = 'norman')
# specify data split
pert_data.prepare_split(split = 'simulation', seed = 1)
# get dataloader with batch size
pert_data.get_dataloader(batch_size = 32, test_batch_size = 128)

# set up and train a model
gears_model = GEARS(pert_data, device = 'cuda:8')
gears_model.model_initialize(hidden_size = 64)
gears_model.train(epochs = 20)

# save/load model
gears_model.save_model('gears')
gears_model.load_pretrained('gears')

# predict
gears_model.predict([['CBL', 'CNN1'], ['FEV']])
gears_model.GI_predict(['CBL', 'CNN1'], GI_genes_file=None)

To use your own dataset, create a scanpy adata object with a gene_name column in adata.var, and two columns condition, cell_type in adata.obs. Then run:

pert_data.new_data_process(dataset_name = 'XXX', adata = adata)
# to load the processed data
pert_data.load(data_path = './data/XXX')

Demos

Name Description
Dataset Tutorial Tutorial on how to use the dataset loader and read customized data
Model Tutorial Tutorial on how to train GEARS
Plot top 20 DE genes Tutorial on how to plot the top 20 DE genes
Uncertainty Tutorial on how to train an uncertainty-aware GEARS model

Colab

Name Description
Using Trained Model Use a model trained on Norman et al. 2019 to make predictions (Needs Colab Pro)

Cite Us

@article{roohani2023predicting,
  title={Predicting transcriptional outcomes of novel multigene perturbations with gears},
  author={Roohani, Yusuf and Huang, Kexin and Leskovec, Jure},
  journal={Nature Biotechnology},
  year={2023},
  publisher={Nature Publishing Group US New York}
}

Paper: Link

Code for reproducing figures: Link

Download files

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

Source Distribution

cell-gears-0.1.1.tar.gz (28.9 kB view details)

Uploaded Source

Built Distribution

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

cell_gears-0.1.1-py3-none-any.whl (31.1 kB view details)

Uploaded Python 3

File details

Details for the file cell-gears-0.1.1.tar.gz.

File metadata

  • Download URL: cell-gears-0.1.1.tar.gz
  • Upload date:
  • Size: 28.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.10

File hashes

Hashes for cell-gears-0.1.1.tar.gz
Algorithm Hash digest
SHA256 c507260233d0d298453d8aee676f4b1de3c61329a1f7b6e25411dfa54990f8e4
MD5 61ecf61d8e1fba3b8014d891404c71d4
BLAKE2b-256 0ffbc2bde4e50b2311e61a9538dbe1cae9002c59e5ba2a741c7c36bd6ed54d87

See more details on using hashes here.

File details

Details for the file cell_gears-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: cell_gears-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 31.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.10

File hashes

Hashes for cell_gears-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f6974ded5bbd854aecfd9c07bce629e6473e5d56136d020f6facbd30ef34c4fb
MD5 6a8de391930ec8cfa8cbec4fd02723cb
BLAKE2b-256 031117b54dbc692b2f77a8c96a91c76f28aaead4fb2728e6b13802bf131830ed

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