Skip to content

Commit

Permalink
[skip ci] add warnings regarding use cases
Browse files Browse the repository at this point in the history
  • Loading branch information
kaczmarj authored Mar 7, 2024
1 parent 18ae517 commit 417c3cd
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@

WSInfer-MIL is a command line tool to run pre-trained MIL models on whole slide images. It is the slide-level companion to [WSInfer](https://wsinfer.readthedocs.io/en/latest/), which provides patch-level classification.

> [!CAUTION]
> WSInfer-MIL is intended _only_ for research purposes.
# Install

WSInfer-MIL can be installed using `pip`. WSInfer-MIL will install PyTorch automatically
Expand Down Expand Up @@ -40,6 +43,9 @@ pip install wsinfer-mil

# Examples

> [!CAUTION]
> These models are intended _only_ for research purposes.
## With a model online

Jakub Kaczmarzyk has uploaded several pre-trained MIL models to HuggingFace for the community to explore. Over time, I (Jakub) hope that others may contribute MIL models too. If you are interested in this, please feel free to email me at jakub.kaczmarzyk at stonybrookmedicine dot edu.
Expand Down

0 comments on commit 417c3cd

Please sign in to comment.