Metadata-Version: 2.1
Name: st-visium-datasets
Version: 0.2.2
Summary: 
License: MIT
Author: Ouail Bendidi
Author-email: ouail.bendidi@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: datasets (>=2.15.0,<3.0.0)
Requires-Dist: httpx (>=0.25.2,<0.26.0)
Requires-Dist: imagecodecs (>=2023.3.16,<2024.0.0)
Requires-Dist: pandas (>=2.0.3,<3.0.0)
Requires-Dist: parsel (>=1.8.1,<2.0.0)
Requires-Dist: pillow (>=10.1.0,<11.0.0)
Requires-Dist: pydantic (>=2,<3)
Requires-Dist: pydantic-settings (>=2.1.0,<3.0.0)
Requires-Dist: rich (>=13.7.0,<14.0.0)
Requires-Dist: scipy (==1.10.*) ; python_version < "3.9"
Requires-Dist: scipy (>=1.11.4,<2.0.0) ; python_version >= "3.9"
Requires-Dist: tabulate (>=0.9.0,<0.10.0)
Requires-Dist: tifffile (>=2023.4.12,<2024.0.0)
Requires-Dist: typing-extensions (>=4.0.0)
Description-Content-Type: text/markdown

# st-visium-datasets


Spatial Transcriptomics Atlas for 10XGenomics datasets in huggingface datasets format :huggingface:

## Installation

TODO

## Usage

This library provides a common interface for 10XGenomics 'Gene Expression' datasets based on huggingface.

This library provides a single dataset: `visium` with different configurations

```python
from st_visium_datasets import load_visium_dataset
import torch

ds = load_visium_dataset() # default lodas 'all' config
# or ds = load_visium_dataset("human")

device = torch.device("cuda" if torch.cuda.is_available() else "cpu")

torch_ds = ds.with_format("torch", device=device)
# cf: https://huggingface.co/docs/datasets/v2.15.0/en/use_with_pytorch
```

## Availlable configs

| name                   |   number_of_spots_under_tissue |   number_of_genes_detected |
|------------------------|--------------------------------|----------------------------|
| all                    |                         344961 |                    1651817 |
| human                  |                         192976 |                     863878 |
| human-heart            |                           8482 |                      40491 |
| human-lymph-node       |                           8074 |                      48178 |
| human-kidney           |                           5936 |                      18068 |
| human-colorectal       |                           9080 |                      18077 |
| human-skin             |                           3458 |                      18069 |
| human-prostate         |                          14334 |                      68215 |
| human-ovary            |                          15153 |                      77975 |
| human-brain            |                          27696 |                     110543 |
| human-large-intestine  |                           6276 |                      39440 |
| human-spinal-cord      |                           5624 |                      39951 |
| human-cerebellum       |                           4992 |                      17355 |
| human-brain-cerebellum |                           9984 |                      41163 |
| human-lung             |                          10053 |                      36143 |
| human-breast           |                          38063 |                     217985 |
| human-colon            |                          25771 |                      72225 |
| mouse                  |                         151985 |                     787939 |
| mouse-olfactory-bulb   |                           2370 |                      38664 |
| mouse-kidney           |                           6000 |                      57469 |
| mouse-brain            |                         123254 |                     614201 |
| mouse-kidney-brain     |                           2805 |                      19399 |
| mouse-mouse-embryo     |                          12877 |                      38808 |
| mouse-lung-brain       |                           4679 |                      19398 |

