FineST: Fine-grained Spatial Transcriptomic
Project description
A tatistical model and toolbox to identify the super-resolved ligand-receptor interaction with spatial co-expression (i.e., spatial association). Uniquely, FineST can distinguish co-expressed ligand-receptor pairs (LR pairs) from spatially separating pairs at sub-spot level or single-cell level, and identify the super-resolved ligand-receptor interaction (LRI).
It comprises three components (Training-Imputation-Discovery) after HE image feature is extracted:
Step0: HE image feature extraction
Step1: Training FineST on the within spots
Step2: Super-resolution spatial RNA-seq imputation
Step3: Fine-grained LR pair and CCC pattern discovery
Installation
FineST is available through PyPI. To install, type the following command line and add -U for updates:
pip install -U FineST
Alternatively, install from this GitHub repository for latest (often development) version (time: < 1 min):
pip install -U git+https://github.com/LingyuLi-math/FineST
Installation using Conda
$ git clone https://github.com/LingyuLi-math/FineST.git
$ conda create --name FineST python=3.8
$ conda activate FineST
$ cd FineST
$ pip install -r requirements.txt
Typically installation is completed within a few minutes. Then install pytorch, refer to pytorch installation.
$ conda install pytorch=1.7.1 torchvision torchaudio cudatoolkit=11.0 -c pytorch
Verify the installation using the following command:
python
>>> import torch
>>> print(torch.__version__)
>>> print(torch.cuda.is_available())
Get Started for Visium HD data
Illustrate using a single slice of 10x Visium HD human colorectal cancer (CRC) data with 16-um bin.
Step0: HE image feature extraction
Input
Visium_HD_Human_Colon_Cancer_tissue_image.btf: Raw histology image (.btf Visium HD or .tif Visium)
tissue_positions.parquet: Spot/bin locations (.parquet Visium HD or .csv Visium)
Output
HD_CRC_16um_pth_32_16_image: Segmeted histology image patches (.png)
HD_CRC_16um_pth_32_16: Extracted image feature embeddiings for each patche (.pth)
python .FineST/HIPT_image_feature_extract.py --dataset HD_CRC_16um --position ./Colon_Cancer/square_016um/spatial/tissue_positions.parquet --image ./Colon_Cancer/Visium_HD_Human_Colon_Cancer_tissue_image.btf --output_path_img ./HD_CRC_16um_pth_32_16_image --output_path_pth ./HD_CRC_16um_pth_32_16 --patch_size 32 --logging_folder ./Finetune/HIPT_image_feature_extract/
HIPT_image_feature_extract.py also output the execution time:
The image segment execution time for the loop is: 62.491 seconds
The image feature extract time for the loop is: 1717.818 seconds
Step1: Training FineST on the within spots
Step2: Super-resolution spatial RNA-seq imputation
Step3: Fine-grained LR pair and CCC pattern discovery
Detailed Manual
The full manual is at finest-rtd-tutorial for installation, tutorials and examples.
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file finest-0.0.5.tar.gz.
File metadata
- Download URL: finest-0.0.5.tar.gz
- Upload date:
- Size: 48.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.8.20
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f10dafe5aa306e327a084fd4e7af84d2ea86577024b324be6d5e10a4253e8d18
|
|
| MD5 |
163788da93cbc2dbdcca05be6afe1734
|
|
| BLAKE2b-256 |
baf5daa12d25f5d73d4aaaf45f34a327bc05780ee151abd5b00d25493957bf0a
|
File details
Details for the file FineST-0.0.5-py3-none-any.whl.
File metadata
- Download URL: FineST-0.0.5-py3-none-any.whl
- Upload date:
- Size: 52.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.8.20
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8a57777f8881cf0cbce0be7d9482cb3f7fa4e9142a109e091b258a7447c1efa9
|
|
| MD5 |
ab2389105999f9db502815084cebb48d
|
|
| BLAKE2b-256 |
1edacb8c6af7d5541b97dad566c5b2dc3e78bb404ae3efac0ff543ccf0a25ecc
|