From f3e0b8c92631f10e809e7718aa0de25388600bff Mon Sep 17 00:00:00 2001
From: Andre Anjos <andre.dos.anjos@gmail.com>
Date: Wed, 4 Oct 2023 22:32:19 +0200
Subject: [PATCH] [doc] Fix docs of generate-saliencymaps
---
src/ptbench/scripts/click.py | 2 +-
src/ptbench/scripts/generate_saliencymaps.py | 15 +++++++--------
2 files changed, 8 insertions(+), 9 deletions(-)
diff --git a/src/ptbench/scripts/click.py b/src/ptbench/scripts/click.py
index 39cf96f9..07dfe697 100644
--- a/src/ptbench/scripts/click.py
+++ b/src/ptbench/scripts/click.py
@@ -27,4 +27,4 @@ class ConfigCommand(_BaseConfigCommand):
if self.epilog:
formatter.write_paragraph()
for line in self.epilog.split("\n"):
- formatter.write_text(line)
+ formatter.write(line + "\n")
diff --git a/src/ptbench/scripts/generate_saliencymaps.py b/src/ptbench/scripts/generate_saliencymaps.py
index a7232fed..7ba30ede 100644
--- a/src/ptbench/scripts/generate_saliencymaps.py
+++ b/src/ptbench/scripts/generate_saliencymaps.py
@@ -7,10 +7,11 @@ import typing
import click
-from clapper.click import ConfigCommand, ResourceOption, verbosity_option
+from clapper.click import ResourceOption, verbosity_option
from clapper.logging import setup
from ..models.typing import VisualisationType
+from .click import ConfigCommand
logger = setup(__name__.split(".")[0], format="%(levelname)s: %(message)s")
@@ -20,15 +21,13 @@ logger = setup(__name__.split(".")[0], format="%(levelname)s: %(message)s")
cls=ConfigCommand,
epilog="""Examples:
-\b
- 1. Generates saliency maps for all prediction dataloaders on a datamodule,
- using a pre-trained DenseNet model, and saves them as numpy-pickeled
- objects on the output directory:
+1. Generates saliency maps for all prediction dataloaders on a datamodule,
+ using a pre-trained DenseNet model, and saves them as numpy-pickeled
+ objects on the output directory:
- .. code:: sh
+ .. code:: sh
-\b
- ptbench generate-saliencymaps -vv densenet tbx11k-v1-healthy-vs-atb --weight=path/to/model_final.pth --output-folder=path/to/visualisations
+ ptbench generate-saliencymaps -vv densenet tbx11k-v1-healthy-vs-atb --weight=path/to/model_final.pth --output-folder=path/to/visualisations
""",
)
--
GitLab