Skip to content

Commit 0b9257d

Browse files
committed
test: drop cuda tests
1 parent c76cafb commit 0b9257d

File tree

2 files changed

+35
-38
lines changed

2 files changed

+35
-38
lines changed

docs/index.md

Lines changed: 35 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,54 @@
1-
# Histolytics
2-
3-
![Logo](img/histolytics_logo.png)
4-
51
<div align="center">
62

7-
<b>A Python library for scalable panoptic spatial analysis of histological WSIs</b>
8-
9-
</div>
10-
11-
<div align="center">
3+
![Logo](imgs/histolytics_logo.png)
124

13-
<a href="https://github.com/HautaniemiLab/histolytics/actions/workflows/tests.yml">
14-
<img src="https://img.shields.io/github/actions/workflow/status/HautaniemiLab/histolytics/tests.yml?label=tests" alt="Github Test">
15-
</a>
16-
<a href="https://github.com/HautaniemiLab/histolytics/blob/main/LICENSE">
17-
<img src="https://img.shields.io/github/license/HautaniemiLab/histolytics" alt="License">
18-
</a>
19-
<a href="https://pypi.org/project/histolytics/">
20-
<img src="https://img.shields.io/pypi/pyversions/histolytics" alt="Python - Version">
21-
</a>
22-
<a href="https://pypi.org/project/histolytics/">
23-
<img src="https://img.shields.io/pypi/v/histolytics" alt="Package - Version">
24-
</a>
5+
**A Python library for scalable panoptic spatial analysis of histological WSIs**
256

26-
</div>
27-
28-
<div align="center">
29-
<h2><b>Welcome to Histolytics documentation</b></h2>
7+
[![Github Test](https://img.shields.io/github/actions/workflow/status/HautaniemiLab/histolytics/tests.yml?label=tests)](https://github.com/HautaniemiLab/histolytics/blob/main/.github/workflows/tests.yml) [![License](https://img.shields.io/github/license/HautaniemiLab/histolytics)](https://github.com/HautaniemiLab/histolytics/blob/main/LICENSE) [![Python - Version](https://img.shields.io/pypi/pyversions/histolytics)](https://www.python.org/)
8+
[![Package - Version](https://img.shields.io/pypi/v/histolytics)](https://pypi.org/project/histolytics/) [![Model Checkpoints](https://img.shields.io/badge/%F0%9F%A4%97%20HF-Model%20Hub-yellow)](https://huggingface.co/histolytics-hub)
309
</div>
3110

3211
## Introduction
3312

34-
**histolytics** is a spatial analysis library for histological whole slide images (WSI) library built upon [`torch`](https://pytorch.org/), [`geopandas`](https://geopandas.org/en/stable/index.html) and [`libpysal`](https://pysal.org/libpysal/). The library contains multi-task encoder-decoder architectures for **panoptic segmentation** of WSIs into [`__geo_interface__`](https://gist.github.com/sgillies/2217756)-format and a wide array of spatial analysis tools for the resulting segmentation masks.
13+
**histolytics** is a spatial analysis library for histological whole slide images (WSI). Built upon [`torch`](https://pytorch.org/), [`geopandas`](https://geopandas.org/en/stable/index.html) and [`libpysal`](https://pysal.org/libpysal/), the library provides a comprehensive and scalable framework for **panoptic segmentation** and **interpretable panoptic spatial analysis** of routine histopathology slides.
14+
3515

36-
## Features 🌟
37-
- WSI-level panoptic segmentation
38-
- Several panoptic segmentation models for histological WSIs
16+
## Panoptic Segmentation Features 🌟
17+
- Fast WSI-level panoptic segmentation. See [example](https://hautaniemilab.github.io/histolytics/user_guide/seg/panoptic_segmentation/).
18+
- Low memory-footprint segmentation results with [`__geo_interface__`](https://gist.github.com/sgillies/2217756)-specification.
19+
- Multiple vectorized segmentation output formats (geojson/feather/parquet).
20+
- Several panoptic segmentation model architectures for histological WSIs with flexible backbone support: See [example](https://hautaniemilab.github.io/histolytics/user_guide/seg/backbones/)
3921
- Pre-trained models in model-hub. See: [histolytics-hub](https://huggingface.co/histolytics-hub)
40-
- Versatile spatial analysis tools for segmented WSIs
22+
23+
## Spatial Analysis Features 📊
24+
- Fast Spatial Querying of WSI-scale panoptic segmentation maps. See [example](https://hautaniemilab.github.io/histolytics/user_guide/spatial/querying/)
25+
- Spatial indexing/partitioning for localized spatial statistics and analysis. See [example](https://hautaniemilab.github.io/histolytics/user_guide/spatial/partitioning/)
26+
- Graph-based neighborhood analysis for local cell neighborhoods. See [example](https://hautaniemilab.github.io/histolytics/user_guide/spatial/nhoods/)
27+
- Plotting utilities for spatial data visualization. See [example](https://hautaniemilab.github.io/histolytics/user_guide/spatial/legendgram/)
28+
- Spatial clustering and cluster centrography metrics. See [example](https://hautaniemilab.github.io/histolytics/user_guide/spatial/clustering/)
29+
- Large set of morphological, intensity, chromatin distribution, and textural features at nuclear level. See [example](https://hautaniemilab.github.io/histolytics/user_guide/spatial/nuclear_features/)
30+
- Large set of collagen fiber and intensity based features to characterize stroma and ECM. See [example](https://hautaniemilab.github.io/histolytics/user_guide/spatial/stromal_features/)
31+
32+
## Example Workflows 🧪
33+
- Immuno-oncology Profiling:
34+
- [Spatial Statistics of TILs](https://hautaniemilab.github.io/histolytics/user_guide/workflows/TIL_workflow/).
35+
- [Profiling TLS and Lymphoid Aggregates](https://hautaniemilab.github.io/histolytics/user_guide/workflows/tls_lymphoid_aggregate/).
36+
- Nuclear Pleomorphism:
37+
- [Nuclear Morphology Analysis](https://hautaniemilab.github.io/histolytics/user_guide/workflows/nuclear_morphology/).
38+
- [Nuclear Chromatin Distribution Analysis](https://hautaniemilab.github.io/histolytics/user_guide/workflows/chromatin_patterns/).
39+
- TME Characterization:
40+
- [Collagen Fiber Disorder Analysis](https://hautaniemilab.github.io/histolytics/user_guide/workflows/collagen_orientation/).
41+
- [Characterization of Desmoplastic Stroma](https://hautaniemilab.github.io/histolytics/user_guide/workflows/clustering_desmoplasia/).
42+
- Nuclei Neighborhoods:
43+
- [Tumor Cell Accessibility](https://hautaniemilab.github.io/histolytics/user_guide/workflows/tumor_cell_accessibility/).
44+
4145

4246
## Installation 🛠️
4347

4448
```shell
4549
pip install histolytics
4650
```
4751

48-
## Getting started with Histolytics
49-
50-
- [Segmentation Quick Start](https://hautaniemilab.github.io/histolytics/user_guide/seg/getting_started_seg/)
51-
- [API Reference](https://hautaniemilab.github.io/histolytics/api/)
52-
53-
5452
## Models 🤖
5553

5654
- Panoptic [HoVer-Net](https://www.sciencedirect.com/science/article/abs/pii/S1361841519301045)
@@ -68,7 +66,7 @@ We welcome contributions! To get started:
6866
3. Ensure all tests pass and add new tests as needed.
6967
4. Submit a pull request describing your changes.
7068

71-
See the [contributing guide](https://github.com/HautaniemiLab/histolytics/blob/main/CONTRIBUTING.md) for detailed guidelines.
69+
See [contributing guide](https://github.com/HautaniemiLab/histolytics/blob/main/CONTRIBUTING.md) for detailed guidelines.
7270

7371
## Citation
7472

tests/test_nuc_feats.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,6 @@ def sample_data():
5353
[
5454
# Basic metrics
5555
(("chrom_area", "chrom_nuc_prop"), "cpu", False, 2),
56-
(("chrom_area", "chrom_nuc_prop"), "cuda", False, 2),
5756
# All metrics
5857
(
5958
(

0 commit comments

Comments
 (0)