Skip to main content

Accessible and interoperable whole slide image analysis

Project description

LazySlide

Accessible and interoperable whole slide image analysis

bioRxiv badge ⬅️ read the preprint on BioRxiv

Documentation Status pypi version conda version PyPI - License scverse ecosystem

Installation | Tutorials | Preprint

LazySlide is a Python framework for whole slide image (WSI) analysis, designed to integrate seamlessly with the scverse ecosystem.

By adopting standardized data structures and APIs familiar to the single-cell and genomics community, LazySlide enables intuitive, interoperable, and reproducible workflows for histological analysis. It supports a range of tasks from basic preprocessing to advanced deep learning applications, facilitating the integration of histopathology into modern computational biology.

Contributions Welcome

💬 We warmly welcome contributions for documentation, tests, or even suggestions on what to add! Start by submitting an issue or pull request!

Key features

  • Interoperability: Built on top of SpatialData, ensuring compatibility with scverse tools like scanpy, anndata, and squidpy.
  • Accessibility: User-friendly APIs that cater to both beginners and experts in digital pathology.
  • Scalability: Efficient handling of large WSIs, enabling high-throughput analyses.
  • Multimodal integration: Combine histological data with transcriptomics, genomics, and textual annotations.
  • Foundation model support: Native integration with state-of-the-art models (e.g., UNI, CONCH, Gigapath, Virchow) for tasks like zero-shot classification and captioning.
  • Deep learning ready: Provides PyTorch dataloaders for seamless integration into machine learning pipelines.​

figure

Documentation

Comprehensive documentation is available at https://lazyslide.readthedocs.io. It includes tutorials, API references, and guides to help you get started.​

System requirements

LazySlide has been tested from Python 3.11 to 3.13 (with GitHub Action) on Windows, Linux, and MacOS. Version for dependencies is usually flexible, for the specific version used in development, please see pyproject.toml and uv.lock.

Installation

Lazyslide is available at the PyPI. This means that you can get it with your favourite package manager:

  • pip install lazyslide or
  • uv add lazyslide

A typical installation time on a MacBook Pro with uv takes ~4s.

For full instructions, please refer to the Installation page in the documentation.

Quick start

With a few lines of code, you can quickly run process a whole slide image (tissue segmentation, tesselation, feature extraction) (~7s on a MacBook Pro):

import lazyslide as zs

wsi = zs.datasets.sample()

# Pipeline
zs.pp.find_tissues(wsi)
zs.pp.tile_tissues(wsi, tile_px=256, mpp=0.5)
zs.tl.feature_extraction(wsi, model='resnet50')

# Access the features
features = wsi['resnet50_tiles']

# Visualize the 1st and 99th features
zs.pl.tiles(wsi, feature_key="resnet50", color=["1", "99"])

To use your slide file

from wsidata import open_wsi

wsi = open_wsi("path_to_slide")

Contributing

We welcome contributions from the community. Please refer to our contributing guide for guidelines on how to contribute.

Licence

LazySlide is released under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lazyslide-0.9.0.tar.gz (111.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lazyslide-0.9.0-py3-none-any.whl (161.3 kB view details)

Uploaded Python 3

File details

Details for the file lazyslide-0.9.0.tar.gz.

File metadata

  • Download URL: lazyslide-0.9.0.tar.gz
  • Upload date:
  • Size: 111.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.8.22

File hashes

Hashes for lazyslide-0.9.0.tar.gz
Algorithm Hash digest
SHA256 f4230935c15ed28b1169b85d3265ed314e721d763a0e738add4b0088fa73f709
MD5 645c551d8fe8353eac7b14deb11691ae
BLAKE2b-256 da393829a6d3880fa06395f8f281a26a73b2d920be8d07d8db95f76ef4163431

See more details on using hashes here.

File details

Details for the file lazyslide-0.9.0-py3-none-any.whl.

File metadata

  • Download URL: lazyslide-0.9.0-py3-none-any.whl
  • Upload date:
  • Size: 161.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.8.22

File hashes

Hashes for lazyslide-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 721979a91ce73408cddcde19445165a268f5e6f19f40df35d767727e55b44788
MD5 b83859db96a89acb5285ae7b186fad7f
BLAKE2b-256 bb4b4c7f3d323edd494d587902751ad78ce6dd0025e4d518c0f953d6ccb620ba

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page