SpiceMix: a probabilistic graphical model for spatial transcriptomics data
Project description
SpiceMix
SpiceMix is an unsupervised tool for analyzing data of the spatial transcriptome. SpiceMix models the observed expression of genes within a cell as a mixture of latent factors. These factors are assumed to have some spatial affinity between neighboring cells. The factors and affinities are not known a priori, but are learned by SpiceMix directly from the data, by an alternating optimization method that seeks to maximize their posterior probability given the observed gene expression. In this way, SpiceMix learns a more expressive representation of the identity of cells from their spatial transcriptome data than other available methods.
SpiceMix can be applied to any type of spatial transcriptomics data, including MERFISH, seqFISH, HDST, and Slide-seq.
Install
pip install spicemix
Usage
from pathlib import Path
import anndata as ad
import torch
from spicemix.model import SpiceMixPlus
# Load datasets
datasets = []
replicate_names = []
for fov in range(5):
dataset = ad.read_h5ad(f"./example_st_dataset_fov_{replicate}.h5ad") # Each dataset must have spatial information stored as an adjacency matrix
name = f"{fov}"
datasets.append(dataset)
replicate_names.append(name)
# Define hyperparameters
K = 20 # Number of metagenes
lambda_Sigma_x_inv = 1e-4 # Spatial affinity regularization hyperparameter
torch_context = dict(device='cuda:0', dtype=torch.float32) # Context for PyTorch tensor instantiation
# Initialize
spicemixplus_demo = SpiceMixPlus(
K=K,
datasets=datasets,
lambda_Sigma_x_inv=lambda_Sigma_x_inv,
torch_context=torch_context
)
# Train
## Initialization with NMF
for iteration in range(10):
spicemixplus_demo.estimate_parameters(update_spatial_affinities=False)
spicemixplus_demo.estimate_weights(use_neighbors=False)
## Using spatial information
num_iterations = 200
for iteration in range(num_iterations):
spicemixplus_demo.estimate_parameters()
spicemixplus_demo.estimate_weights()
# Save to disk
result_filepath = Path(f"./demo_{num_iterations}_iterations.h5ad")
spicemixplus_demo.save_results(result_filepath)
# Plot results
...
Tests
To run the provided tests and ensure that SpiceMix can run on your platform, follow the instructions below:
- Download this repo.
git clone https://github.com/alam-shahul/SpiceMixPlus.git
- Install
pytest
in your environment.
pip install pytest
- Navigate to the root directory of this repo.
- Run the following command. With GPU resources, this test should execute without errors in ~2.5 minutes:
python -m pytest -s tests/test_spicemix_shared.py
Cite
Cite our paper:
@article{chidester2020spicemix,
title={SPICEMIX: Integrative single-cell spatial modeling for inferring cell identity},
author={Chidester, Benjamin and Zhou, Tianming and Ma, Jian},
journal={bioRxiv},
year={2020},
publisher={Cold Spring Harbor Laboratory}
}
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file popari-0.0.27.tar.gz
.
File metadata
- Download URL: popari-0.0.27.tar.gz
- Upload date:
- Size: 48.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.23.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1ab81b2eeb606dd807dccd9e7dd5d3c72f56768fe24f9331121b6dd3a2d2e7da |
|
MD5 | 7395948523f64af576f5dfa9b50ddf34 |
|
BLAKE2b-256 | 2fb0643c720779abec6e806cd4356e3b458fc6f80867c90957359cb536b75928 |
File details
Details for the file popari-0.0.27-py3-none-any.whl
.
File metadata
- Download URL: popari-0.0.27-py3-none-any.whl
- Upload date:
- Size: 56.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.23.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | df31df6ed0de7eace8ee30965db001630dc2f8f0d1d9b9116b04ef3fbd27f38b |
|
MD5 | 9149bf2cc1261fbd3018a9180f4688fa |
|
BLAKE2b-256 | 8db0d23de62cc0b0ef8c76c10f4c5ecbeec76650c535bdd09a0358146883998a |