From 843479e98efe7dddeb330895e7784ca950eb9ef3 Mon Sep 17 00:00:00 2001 From: Marcel Rosier Date: Sat, 23 Aug 2025 14:04:41 +0200 Subject: [PATCH 1/3] Fix too short underline --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 93b29e3..a78483f 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,5 +1,5 @@ stroke_segmentor documentation -=================== +====================================== .. include:: ../README_preprocessed.md :parser: myst_parser.sphinx_ From 3467e7b5e5e1f3fcc77de4de982fbc81ca9f5bf9 Mon Sep 17 00:00:00 2001 From: Marcel Rosier Date: Sat, 23 Aug 2025 14:04:53 +0200 Subject: [PATCH 2/3] Add default import and simpify docstring --- stroke_segmentor/__init__.py | 2 ++ stroke_segmentor/inferer.py | 8 -------- 2 files changed, 2 insertions(+), 8 deletions(-) diff --git a/stroke_segmentor/__init__.py b/stroke_segmentor/__init__.py index bb35ec8..1ad64a5 100644 --- a/stroke_segmentor/__init__.py +++ b/stroke_segmentor/__init__.py @@ -1,3 +1,5 @@ from loguru import logger logger.disable("stroke_segmentor") + +from stroke_segmentor.inferer import Inferer # noqa: F401 diff --git a/stroke_segmentor/inferer.py b/stroke_segmentor/inferer.py index 0838ee6..7dbc9fc 100644 --- a/stroke_segmentor/inferer.py +++ b/stroke_segmentor/inferer.py @@ -15,14 +15,6 @@ class Inferer: Handles inference for stroke segmentation using DWI and ADC images. This class wraps a model handler to perform inference on given images and can optionally save the resulting segmentation mask to disk. - - Basic usage: - ``` - .. code-block:: python - - inferer = Inferer() - prediction = inferer.infer(adc_path, dwi_path, segmentation_path) - ``` """ def __init__( From e423f7712a225984c8f514571cd3cbe65e5b307b Mon Sep 17 00:00:00 2001 From: Marcel Rosier Date: Sat, 23 Aug 2025 14:06:21 +0200 Subject: [PATCH 3/3] Fix too long underline --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index a78483f..b812fde 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,5 +1,5 @@ stroke_segmentor documentation -====================================== +============================== .. include:: ../README_preprocessed.md :parser: myst_parser.sphinx_