From 0d7e2872e07161a75e43738921e7e045db8fc739 Mon Sep 17 00:00:00 2001
From: dcarron <daniel.carron@idiap.ch>
Date: Mon, 29 Jan 2024 10:19:08 +0100
Subject: [PATCH] [doc] Remove type aliases from docstrings because of autodoc
issue
Autodoc cannot solve type aliases.
See https://github.com/sphinx-doc/sphinx/issues/10785
---
src/mednet/config/data/hivtb/datamodule.py | 1 -
src/mednet/config/data/montgomery/datamodule.py | 1 -
src/mednet/config/data/nih_cxr14/datamodule.py | 1 -
src/mednet/config/data/padchest/datamodule.py | 1 -
src/mednet/config/data/shenzhen/datamodule.py | 1 -
src/mednet/config/data/tbpoc/datamodule.py | 1 -
src/mednet/config/data/tbx11k/datamodule.py | 1 -
src/mednet/engine/device.py | 2 +-
src/mednet/models/separate.py | 1 -
src/mednet/models/transforms.py | 2 +-
10 files changed, 2 insertions(+), 10 deletions(-)
diff --git a/src/mednet/config/data/hivtb/datamodule.py b/src/mednet/config/data/hivtb/datamodule.py
index 2185b14d..3ad4dc63 100644
--- a/src/mednet/config/data/hivtb/datamodule.py
+++ b/src/mednet/config/data/hivtb/datamodule.py
@@ -51,7 +51,6 @@ class RawDataLoader(_BaseRawDataLoader):
Returns
-------
- Sample
The sample representation.
"""
image = PIL.Image.open(os.path.join(self.datadir, sample[0])).convert(
diff --git a/src/mednet/config/data/montgomery/datamodule.py b/src/mednet/config/data/montgomery/datamodule.py
index c7aac4c8..edb2cd71 100644
--- a/src/mednet/config/data/montgomery/datamodule.py
+++ b/src/mednet/config/data/montgomery/datamodule.py
@@ -51,7 +51,6 @@ class RawDataLoader(_BaseRawDataLoader):
Returns
-------
- Sample
The sample representation.
"""
# N.B.: Montgomery images are encoded as grayscale PNGs, so no need to
diff --git a/src/mednet/config/data/nih_cxr14/datamodule.py b/src/mednet/config/data/nih_cxr14/datamodule.py
index 7c3edcef..50fc6056 100644
--- a/src/mednet/config/data/nih_cxr14/datamodule.py
+++ b/src/mednet/config/data/nih_cxr14/datamodule.py
@@ -74,7 +74,6 @@ class RawDataLoader(_BaseRawDataLoader):
Returns
-------
- Sample
The sample representation.
"""
file_path = sample[0] # default
diff --git a/src/mednet/config/data/padchest/datamodule.py b/src/mednet/config/data/padchest/datamodule.py
index 3abf944d..b40a9e13 100644
--- a/src/mednet/config/data/padchest/datamodule.py
+++ b/src/mednet/config/data/padchest/datamodule.py
@@ -52,7 +52,6 @@ class RawDataLoader(_BaseRawDataLoader):
Returns
-------
- Sample
The sample representation.
"""
# N.B.: PadChest images are encoded as 16-bit grayscale images
diff --git a/src/mednet/config/data/shenzhen/datamodule.py b/src/mednet/config/data/shenzhen/datamodule.py
index 15102202..c9ab8a64 100644
--- a/src/mednet/config/data/shenzhen/datamodule.py
+++ b/src/mednet/config/data/shenzhen/datamodule.py
@@ -52,7 +52,6 @@ class RawDataLoader(_BaseRawDataLoader):
Returns
-------
- Sample
The sample representation.
"""
# N.B.: Image.convert("L") is required to normalize grayscale back to
diff --git a/src/mednet/config/data/tbpoc/datamodule.py b/src/mednet/config/data/tbpoc/datamodule.py
index a7870e13..05a2cfad 100644
--- a/src/mednet/config/data/tbpoc/datamodule.py
+++ b/src/mednet/config/data/tbpoc/datamodule.py
@@ -46,7 +46,6 @@ class RawDataLoader(_BaseRawDataLoader):
Returns
-------
- Sample
The sample representation.
"""
# images from TBPOC are encoded as grayscale JPEGs, no need to
diff --git a/src/mednet/config/data/tbx11k/datamodule.py b/src/mednet/config/data/tbx11k/datamodule.py
index 5baa60ff..dc721886 100644
--- a/src/mednet/config/data/tbx11k/datamodule.py
+++ b/src/mednet/config/data/tbx11k/datamodule.py
@@ -161,7 +161,6 @@ class RawDataLoader(_BaseRawDataLoader):
Returns
-------
- Sample
The sample representation.
"""
image = PIL.Image.open(os.path.join(self.datadir, sample[0]))
diff --git a/src/mednet/engine/device.py b/src/mednet/engine/device.py
index 8d5574e7..d751fae5 100644
--- a/src/mednet/engine/device.py
+++ b/src/mednet/engine/device.py
@@ -122,7 +122,7 @@ class DeviceManager:
Returns
-------
- device
+ torch.device
The **first** torch device (if a list of ids is set).
"""
diff --git a/src/mednet/models/separate.py b/src/mednet/models/separate.py
index 244d386b..6238dff0 100644
--- a/src/mednet/models/separate.py
+++ b/src/mednet/models/separate.py
@@ -49,7 +49,6 @@ def separate(batch: Sample) -> list[BinaryPrediction | MultiClassPrediction]:
Returns
-------
- list[BinaryPrediction | MultiClassPrediction]
A list of predictions that contains the predictions and associated metadata
for each processed sample.
"""
diff --git a/src/mednet/models/transforms.py b/src/mednet/models/transforms.py
index f67d1f66..14c7205a 100644
--- a/src/mednet/models/transforms.py
+++ b/src/mednet/models/transforms.py
@@ -71,7 +71,7 @@ def rgb_to_grayscale(img: torch.Tensor) -> torch.Tensor:
Returns
-------
- torch
+ torch.Tensor
Transformed tensor with a single (grayscale) color channel.
"""
if img.ndim < 3:
--
GitLab