[skip ci] 📝 Update Jupyter Notebooks for Release v1.6.0 (#885)

- Update Jupyter Notebooks for the New Release - Fix issues with API changes e.g., device instead of ON_GPU flag.
TissueImageAnalytics · Dec 2, 2024 · 9a62c10 · 9a62c10
1 parent 4a1940d
commit 9a62c10
Show file tree

Hide file tree

Showing 9 changed files with 5,343 additions and 5,295 deletions.
diff --git a/examples/05-patch-prediction.ipynb b/examples/05-patch-prediction.ipynb
diff --git a/examples/06-semantic-segmentation.ipynb b/examples/06-semantic-segmentation.ipynb
diff --git a/examples/07-advanced-modeling.ipynb b/examples/07-advanced-modeling.ipynb
diff --git a/examples/08-nucleus-instance-segmentation.ipynb b/examples/08-nucleus-instance-segmentation.ipynb
@@ -158,7 +158,7 @@
    "source": [
     "### GPU or CPU runtime\n",
     "\n",
-    "Processes in this notebook can be accelerated by using a GPU. Therefore, whether you are running this notebook on your system or Colab, you need to check and specify if you are using GPU or CPU hardware acceleration. In Colab, you need to make sure that the runtime type is set to GPU in the *\"Runtime→Change runtime type→Hardware accelerator\"*. If you are *not* using GPU, consider changing the `ON_GPU` flag to `Flase` value, otherwise, some errors will be raised when running the following cells.\n",
+    "Processes in this notebook can be accelerated by using a GPU. Therefore, whether you are running this notebook on your system or Colab, you need to check and specify appropriate [device](https://pytorch.org/docs/stable/tensor_attributes.html#torch.device) e.g., \"cuda\" or \"cpu\" whether you are using GPU or CPU. In Colab, you need to make sure that the runtime type is set to GPU in the *\"Runtime→Change runtime type→Hardware accelerator\"*. If you are *not* using GPU, consider changing the `device` flag to `cpu` value, otherwise, some errors will be raised when running the following cells.\n",
     "\n"
    ]
   },
@@ -173,8 +173,7 @@
    },
    "outputs": [],
    "source": [
-    "# Should be changed to False if no cuda-enabled GPU is available.\n",
-    "ON_GPU = True  # Default is True."
+    "device = \"cuda\"  # Choose appropriate device"
    ]
   },
   {
@@ -356,7 +355,7 @@
     "    [img_file_name],\n",
     "    save_dir=\"sample_tile_results/\",\n",
     "    mode=\"tile\",\n",
-    "    on_gpu=ON_GPU,\n",
+    "    device=device,\n",
     "    crash_on_exception=True,\n",
     ")"
    ]
@@ -386,7 +385,7 @@
     "\n",
     "- `mode`: the mode of inference which can be set to either `'tile'` or `'wsi'` for plain histology images or structured whole slides images, respectively.\n",
     "\n",
-    "- `on_gpu`: can be `True` or `False` to dictate running the computations on GPU or CPU.\n",
+    "- `device`: specify appropriate [device](https://pytorch.org/docs/stable/tensor_attributes.html#torch.device) e.g., \"cuda\", \"cuda:0\", \"mps\", \"cpu\" etc.\n",
     "\n",
     "- `crash_on_exception`: If set to `True`, the running loop will crash if there is an error during processing a WSI. Otherwise, the loop will move on to the next image (wsi) for processing. We suggest that you first make sure that the prediction is working as expected by testing it on a couple of inputs and then set this flag to `False` to process large cohorts of inputs.\n",
     "\n",
@@ -5615,13 +5614,13 @@
     ")\n",
     "\n",
     "# WSI prediction\n",
-    "# if ON_GPU=False, this part will take more than a couple of hours to process.\n",
+    "# if device=\"cpu\", this part will take more than a couple of hours to process.\n",
     "wsi_output = inst_segmentor.predict(\n",
     "    [wsi_file_name],\n",
     "    masks=None,\n",
     "    save_dir=\"sample_wsi_results/\",\n",
     "    mode=\"wsi\",\n",
-    "    on_gpu=ON_GPU,\n",
+    "    device=device,\n",
     "    crash_on_exception=True,\n",
     ")"
    ]
@@ -5638,7 +5637,7 @@
     "1. Setting `mode='wsi'` in the arguments to `predict` tells the program that the input are in WSI format.\n",
     "1. `masks=None`: the `masks` argument to the `predict` function is handled in the same way as the imgs argument. It is a list of paths to the desired image masks. Patches from `imgs` are only processed if they are within a masked area of their corresponding `masks`. If not provided (`masks=None`), then a tissue mask is generated for whole-slide images or, for image tiles, the entire image is processed.\n",
     "\n",
-    "The above code cell might take a while to process, especially if `ON_GPU=False`. The processing time mostly depends on the size of the input WSI.\n",
+    "The above code cell might take a while to process, especially if `device=\"cpu\"`. The processing time mostly depends on the size of the input WSI.\n",
     "The output, `wsi_output`, of `predict`  contains a list of paths to the input WSIs and the corresponding output results saved on  disk. The results for nucleus instance segmentation in `'wsi'` mode are stored in a Python dictionary, in the same way as was done for `'tile'` mode.\n",
     "We use `joblib` to load the outputs for this sample WSI and then inspect the results dictionary.\n",
     "\n"
@@ -5788,11 +5787,12 @@
     ")\n",
     "\n",
     "color_dict = {\n",
-    "    0: (\"neoplastic epithelial\", (255, 0, 0)),\n",
-    "    1: (\"Inflammatory\", (255, 255, 0)),\n",
-    "    2: (\"Connective\", (0, 255, 0)),\n",
-    "    3: (\"Dead\", (0, 0, 0)),\n",
-    "    4: (\"non-neoplastic epithelial\", (0, 0, 255)),\n",
+    "    0: (\"background\", (255, 165, 0)),\n",
+    "    1: (\"neoplastic epithelial\", (255, 0, 0)),\n",
+    "    2: (\"Inflammatory\", (255, 255, 0)),\n",
+    "    3: (\"Connective\", (0, 255, 0)),\n",
+    "    4: (\"Dead\", (0, 0, 0)),\n",
+    "    5: (\"non-neoplastic epithelial\", (0, 0, 255)),\n",
     "}\n",
     "\n",
     "# Create the overlay image\n",

diff --git a/examples/09-multi-task-segmentation.ipynb b/examples/09-multi-task-segmentation.ipynb
@@ -105,7 +105,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
+   "execution_count": null,
    "metadata": {
     "id": "UEIfjUTaJLPj",
     "outputId": "e4f383f2-306d-4afd-cd82-fec14a184941",
@@ -169,13 +169,13 @@
    "source": [
     "### GPU or CPU runtime\n",
     "\n",
-    "Processes in this notebook can be accelerated by using a GPU. Therefore, whether you are running this notebook on your system or Colab, you need to check and specify whether you are using GPU or CPU hardware acceleration. In Colab, make sure that the runtime type is set to GPU, using the menu *Runtime→Change runtime type→Hardware accelerator*. If you are *not* using GPU, change the `ON_GPU` flag to `False`.\n",
+    "Processes in this notebook can be accelerated by using a GPU. Therefore, whether you are running this notebook on your system or Colab, you need to check and specify appropriate [device](https://pytorch.org/docs/stable/tensor_attributes.html#torch.device) e.g., \"cuda\" or \"cpu\" whether you are using GPU or CPU. In Colab, you need to make sure that the runtime type is set to GPU in the *\"Runtime→Change runtime type→Hardware accelerator\"*. If you are *not* using GPU, consider changing the `device` flag to `cpu` value, otherwise, some errors will be raised when running the following cells.\n",
     "\n"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": null,
    "metadata": {
     "id": "haTA_oQIY1Vy",
     "tags": [
@@ -184,8 +184,7 @@
    },
    "outputs": [],
    "source": [
-    "# Should be changed to False if no cuda-enabled GPU is available.\n",
-    "ON_GPU = True  # Default is True."
+    "device = \"cuda\"  # Choose appropriate device"
    ]
   },
   {
@@ -205,7 +204,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": null,
    "metadata": {
     "colab": {
      "base_uri": "https://localhost:8080/"
@@ -260,7 +259,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": null,
    "metadata": {
     "colab": {
      "base_uri": "https://localhost:8080/"
@@ -335,7 +334,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": null,
    "metadata": {
     "colab": {
      "base_uri": "https://localhost:8080/"
@@ -390,7 +389,7 @@
     "    [img_file_name],\n",
     "    save_dir=global_save_dir / \"sample_tile_results\",\n",
     "    mode=\"tile\",\n",
-    "    on_gpu=ON_GPU,\n",
+    "    device=device,\n",
     "    crash_on_exception=True,\n",
     ")"
    ]
@@ -418,7 +417,7 @@
     "\n",
     "- `mode`: the mode of inference which can be set to either `'tile'` or `'wsi'`, for plain histology images or structured whole slides images, respectively.\n",
     "\n",
-    "- `on_gpu`: can be either `True` or `False` to dictate running the computations on GPU or CPU.\n",
+    "- `device`: specify appropriate [device](https://pytorch.org/docs/stable/tensor_attributes.html#torch.device) e.g., \"cuda\", \"cuda:0\", \"mps\", \"cpu\" etc.\n",
     "\n",
     "- `crash_on_exception`: If set to `True`, the running loop will crash if there is an error during processing a WSI. Otherwise, the loop will move on to the next image (wsi) for processing. We suggest that you first make sure that prediction is working as expected by testing it on a couple of inputs and then set this flag to `False` to process large cohorts of inputs.\n",
     "\n",
@@ -430,7 +429,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 8,
+   "execution_count": null,
    "metadata": {
     "colab": {
      "base_uri": "https://localhost:8080/",
@@ -546,7 +545,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 10,
+   "execution_count": null,
    "metadata": {
     "colab": {
      "base_uri": "https://localhost:8080/"
@@ -595,7 +594,7 @@
     "    masks=None,\n",
     "    save_dir=global_save_dir / \"sample_wsi_results/\",\n",
     "    mode=\"wsi\",\n",
-    "    on_gpu=ON_GPU,\n",
+    "    device=device,\n",
     "    crash_on_exception=True,\n",
     ")"
    ]
@@ -612,13 +611,13 @@
     "1. Setting `mode='wsi'` in the `predict` function indicates that we are predicting region segmentations for inputs in the form of WSIs.\n",
     "1. `masks=None` in the `predict` function: the `masks` argument is a list of paths to the desired image masks. Patches from `imgs` are only processed if they are within a masked area of their corresponding `masks`. If not provided (`masks=None`), then either a tissue mask is automatically generated for whole-slide images or the entire image is processed as a collection of image tiles.\n",
     "\n",
-    "The above cell might take a while to process, especially if you have set `ON_GPU=False`. The processing time depends on the size of the input WSI and the selected resolution. Here, we have not specified any values and we use the assumed input resolution (20x) of HoVer-Net+.\n",
+    "The above cell might take a while to process, especially if you have set `device=\"cpu\"`. The processing time depends on the size of the input WSI and the selected resolution. Here, we have not specified any values and we use the assumed input resolution (20x) of HoVer-Net+.\n",
     "\n"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 12,
+   "execution_count": null,
    "metadata": {
     "colab": {
      "base_uri": "https://localhost:8080/",