Skip to content

Commit

Permalink
[DOCS] add video walkthrough to user guide + update version switcher (#…
Browse files Browse the repository at this point in the history
…201)

* [skip ci] add 0.4.1 and 0.5.0

* [skip ci] add video walkthrough
  • Loading branch information
kaczmarj authored Nov 11, 2023
1 parent a277f5b commit eb59563
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 2 deletions.
14 changes: 12 additions & 2 deletions docs/_static/switcher.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,20 @@
"url": "https://wsinfer.readthedocs.io/en/latest/"
},
{
"name": "0.4.0 (stable)",
"version": "v0.4.0",
"name": "0.5.0 (stable)",
"version": "v0.5.0",
"url": "https://wsinfer.readthedocs.io/en/stable/"
},
{
"name": "0.4.1",
"version": "v0.4.1",
"url": "https://wsinfer.readthedocs.io/en/v0.4.1/"
},
{
"name": "0.4.0",
"version": "v0.4.0",
"url": "https://wsinfer.readthedocs.io/en/v0.4.0/"
},
{
"name": "0.3.6",
"version": "v0.3.6",
Expand Down
11 changes: 11 additions & 0 deletions docs/user_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,17 @@ https://openslide.cs.cmu.edu/download/openslide-testdata/Aperio/.

The rest of this page assumes that slides are saved to the directory :code:`slides`.

Video walkthrough
-----------------

In this video, Jakub demonstrates from beginning to end how one can use WSInfer to detect
tumor regions in a whole slide image. He shows how to install PyTorch and WSInfer,
use the command line :code:`wsinfer` tool, and visualize results in QuPath.

.. raw:: html

<iframe width="560" height="315" src="https://www.youtube.com/embed/0X86_A4vopw?si=JtXsmBd8OUcDndS5" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

Getting help
------------

Expand Down

0 comments on commit eb59563

Please sign in to comment.