Skip to content

theislab/geome

Repository files navigation

geome

Tests Documentation

The repo provides a set of tools for creating PyTorch Geometric (PyG) data objects from AnnData objects, which are commonly used for storing and manipulating single-cell genomics data. In addition, the repo includes functionality for creating PyTorch Lightning (PyTorch-Lightning) DataModule objects from the PyG data objects, which can be used to create graph neural network (GNN) data pipelines. The PyG data objects represent graphs, where the nodes represent cells and the edges represent relationships between the cells, and can be used to perform GNN tasks such as node classification, graph classification, and link prediction. The repo is written in Python and utilizes the PyTorch, PyTorch Geometric, and PyTorch-Lightning libraries.

Getting started

Please refer to the documentation. In particular, the

Installation

You need to have Python 3.9 or newer installed on your system. If you don't have Python installed, we recommend installing Mambaforge.

There are several alternative options to install geome:

  1. Install the latest development version:

Without GPU support:

mamba create -n geome  python=3.10
mamba activate geome
pip install torch==2.1.0
pip install torch-scatter torch-sparse torch-cluster
pip install git+https://github.com/theislab/geome.git@main

With GPU:

mamba create -n geome  python=3.10
mamba activate geome
mamba install pytorch==2.1.0 torchvision==0.16.0 torchaudio==2.1.0 pytorch-cuda=12.1 -c pytorch -c nvidia
pip install torch-scatter torch-sparse torch-cluster -f https://data.pyg.org/whl/torch-2.1.0+cu121.html
pip install git+https://github.com/theislab/geome.git@main

Release notes

See the changelog.

Contact

For questions and help requests, you can reach out in the scverse discourse. If you found a bug, please use the issue tracker.

Credits

Some of the data for DatasetHartmann is distributed in this package. It was originally retrieved from: https://zenodo.org/record/3951613#.Y9flQS-B1qv

This project was generated from @cjolowicz's Hypermodern Python Cookiecutter template.

Citation

t.b.a