Skip to main content

Embedding of whole slide images with PRISM

Project description

PRISM Embedder

PRISM Embedder Logo

PyPI version Docker version

Extract slide-level embeddings from whole-slide images using PRISM.


👁️ Overview

PRISM Embedder is a containerized algorithm for computing slide-level representations from whole-slide images using PRISM.

⚠️ Access Required
This algorithm depends on the gated models PRISM and Virchow.
You need to have requested and been granted access to both models on Hugging Face.

🚀 Quickstart

Requirements:

  • Linux-based OS (e.g., Ubuntu 22.04)
  • Python 3.10+
  • Docker installed

1. Clone the repository

git clone https://github.com/clemsgrs/prism-embedder.git
cd prism-embedder

2. Download model weights

Download the required model weights:

./download_weights.sh

3. Kick-off woth Docker

Replace </path/to/your/slide.tif> and </path/to/your/mask.tif> with your actual file paths.
Replace </path/to/your/output/folder> with the path to a folder where you have write access.

docker pull waticlems/prism_embedder:latest
docker run --rm -it \
    -v </path/to/your/slide.tif>:/input/images/whole-slide-image/slide.tif:ro \
    -v </path/to/your/mask.tif>:/input/images/tissue-mask/mask.tif:ro \
    -v model:/opt/ml/model
    -v </path/to/your/output/folder>:/output \
    waticlems/prism_embedder:latest

Upon execution, the following files will be saved in /output:

  • image-neural-representation.json: 1280-dimensional slide-level embedding (JSON)
  • whole-slide-tiling-thumbnail.png: PNG image showing the tissue tiling layout

📌 TODO

  • add tSNE plot
  • improve CLI customization (e.g., for spacing, resolution)

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

prism_embedder-1.1.1.tar.gz (54.8 kB view details)

Uploaded Source

Built Distribution

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

prism_embedder-1.1.1-py3-none-any.whl (63.7 kB view details)

Uploaded Python 3

File details

Details for the file prism_embedder-1.1.1.tar.gz.

File metadata

  • Download URL: prism_embedder-1.1.1.tar.gz
  • Upload date:
  • Size: 54.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.13

File hashes

Hashes for prism_embedder-1.1.1.tar.gz
Algorithm Hash digest
SHA256 74b76b62d7d997a3aeacf203fc3b71f689087e14c21baa658afb46e26fe83dfd
MD5 6e8bc797b8154968bfc243aec0362534
BLAKE2b-256 16bd7f93065f941a37aa65ce274d2653431f757a9114a70f668e073a5031beb3

See more details on using hashes here.

File details

Details for the file prism_embedder-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: prism_embedder-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 63.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.13

File hashes

Hashes for prism_embedder-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 737ce8c3a0c5050c67169ac6ce2e01638f1c7e885a502813211000769355e4f3
MD5 d9d95e15b6ce1fd5c5214248ec39e234
BLAKE2b-256 6d7a6c197e347b2789de6a9bc936a75053cb1df45c2ff4f3482d60898a27cd52

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