Hugging Face's logo

Spaces:
andreped
/
wsi-annotation-demo
Sleeping

App Files Community
wsi-annotation-demo / README.md
andreped's picture
andreped
Added new snapshot of HF Space
eedfc49 unverified
preview code
|
raw
history blame
2.52 kB
metadata
title: wsi-annotation-demo
emoji: 🔬
colorFrom: blue
colorTo: red
sdk: docker
sdk_version: 24.0.6
app_file: Dockerfile
pinned: false

wsi-annotation-demo

license

Why?

This repository was developed to demonstrate how to do the following:

  • Creating a simple web application for rendering a whole slide image in real time.
  • Allow annotating a whole slide image in real-time.
  • Containerizing and deploying a web app for deployment on Hugging Face Spaces.

To access the live demo, click on the Hugging Face badge above. Below is a snapshot of the current state of the demo app.

demo-hf-spaces

Stack

For this demonstration, we have used the following:

Component Description
OpenSeadragon The actual library for rendering the WSI
Annotorious Library supporting annotation of large images
Deep Zoom Image (DZI) Image file format compatible with OpenSeadragon
npm Installation of frontend dependencies
nginx HTTP web server
Docker Containerization of the web app
Hugging Face Spaces Deployment platform

Continuous integration

For this project, we continuously update the Hugging Face deployment for each commit to the main branch.

Build Type Status
HF Space Deploy CI
File Size Check CI

Local development

This example is for macOS development, so brew is required.

  1. Install node:
brew install node
  1. Install deps:
npm install
  1. Open in browser:
open index.html

Docker

  1. Build image:
docker build -t wsi-annotation .
  1. Run image:
docker run -p 7860:7860 wsi-annotation
  1. Open in browser:
open http://localhost:7860

License

This project has MIT License.