From eb5956318c232fca43d8b393669768d1ffd47e42 Mon Sep 17 00:00:00 2001 From: Jakub Kaczmarzyk Date: Sat, 11 Nov 2023 16:47:55 -0500 Subject: [PATCH] [DOCS] add video walkthrough to user guide + update version switcher (#201) * [skip ci] add 0.4.1 and 0.5.0 * [skip ci] add video walkthrough --- docs/_static/switcher.json | 14 ++++++++++++-- docs/user_guide.rst | 11 +++++++++++ 2 files changed, 23 insertions(+), 2 deletions(-) diff --git a/docs/_static/switcher.json b/docs/_static/switcher.json index 75414c0..06bed0d 100644 --- a/docs/_static/switcher.json +++ b/docs/_static/switcher.json @@ -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", diff --git a/docs/user_guide.rst b/docs/user_guide.rst index d6d876f..33229ca 100644 --- a/docs/user_guide.rst +++ b/docs/user_guide.rst @@ -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 + + + Getting help ------------