Skip to main content

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)

Metadata

Release files for prism-embedder 1.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for prism-embedder 1.1.1
File Size Uploaded
prism_embedder-1.1.1.tar.gz 54.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for prism-embedder 1.1.1
File Interpreter ABI Platform
prism_embedder-1.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 118.5 kB

Release files / prism_embedder-1.1.1.tar.gz

Download URL prism_embedder-1.1.1.tar.gz
Size 54.8 kB
Tags Source
SHA-256 checksum
How to use checksums
74b76b62d7d997a3aeacf203fc3b71f689087e14c21baa658afb46e26fe83dfd
BLAKE2b-256 checksum
How to use checksums
16bd7f93065f941a37aa65ce274d2653431f757a9114a70f668e073a5031beb3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.13

Release files / prism_embedder-1.1.1-py3-none-any.whl

Download URL prism_embedder-1.1.1-py3-none-any.whl
Size 63.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
737ce8c3a0c5050c67169ac6ce2e01638f1c7e885a502813211000769355e4f3
BLAKE2b-256 checksum
How to use checksums
6d7a6c197e347b2789de6a9bc936a75053cb1df45c2ff4f3482d60898a27cd52
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.13

Release history Release notifications | RSS feed

This release

1.1.1 This release

2 release files

1.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page