Making use of LightningDataModule and simplification of data loading

This merge request adds LightningDataModule to better organize the code and make better use of lightning's features. This centralizes common tasks such as DataLoader creation and application of transforms into a base class to be inherited from.

Data loading was also simplified by removing custom Sample classes and maker functions, and the addition of RuntimeDataset and CachedDataset.

Remaining tasks:

• (@dcarron) Create a common/default DataModule for the shenzhen dataset that takes protocols and transforms as parameters to avoid copying code for each protocol configuration
• (@dcarron) Add typehints to ShenzenDataModule
• (@dcarron) Investigate issue where training a new model with ElasticDeformation as a transform converges more slowly if the data is not cached.
• (@andre.anjos) Update documentation on ShenzenDataModule
• (@biosignal) Update all datasets, using Shenzhen as a reference
  • (@mdelitroz) Montgomery
  • (@mdelitroz) Hivtb
  • (@andre.anjos) Indian
  • (@andre.anjos) Padchest
  • (@mdelitroz) Tbpoc
  • (@andre.anjos) tbx11_simplified -> renamed as tbx11k, protocol v1 (uses original dataset organisation)
  • (@andre.anjos) tbx11_simplified_v2 -> renamed as tbx11k, protocol v2 (uses original dataset organisation)
  • (@andre.anjos) mc_ch -> renamed as montgomery-shenzhen
  • (@andre.anjos) mc_ch_in -> renamed as montgomery-shenzhen-indian
  • (@andre.anjos) mc_ch_in_11k -> renamed as montgomery-shenzhen-indian-tbx11k-v1
  • (@andre.anjos) mc_ch_in_11k_v2 -> renamed as montgomery-shenzhen-indian-tbx11k-v2
  • (@andre.anjos) mc_ch_in_pc -> renamed as montgomery-shenzhen-indian-padchest
  • (@andre.anjos) nih_cxr14_re -> renamed as nih-cxr14 (n.b.: multi-class dataset, radiological findings)
  • (@andre.anjos) nih_cxr14_re_pc -> renamed as nih-cxr14-padchest
• (@dcarron) Update models
• (@dcarron) Update evaluation scripts
• (@dcarron) Update support for extra_validation datasets
• (@biosignal) Update full documentation
• (@biosignal) Update unit tests

Addresses the following issues:

• Closes #14 (closed)
• Closes #18 (closed)
• Closes #19 (closed)
• Closes #21 (closed)
• Closes #29 (closed)

pyproject.toml

@@ -3,8 +3,8 @@
 # SPDX-License-Identifier: GPL-3.0-or-later
 
 [build-system]
-    requires = ["setuptools>=61.0.0", "wheel"]
-    build-backend = "setuptools.build_meta"
+requires = ["setuptools>=61.0.0", "wheel"]
+build-backend = "setuptools.build_meta"
 
 [project]
 name = "ptbench"
@@ -12,13 +12,11 @@ version = "1.0.0b0"
 requires-python = ">=3.10"
 description = "Benchmarks for training and evaluating deep models for the detection of active Pulmonary Tuberculosis from Chest X-Ray imaging."
 dynamic = ["readme"]
-license = {text = "GNU General Public License v3 (GPLv3)"}
-authors = [
-    {name = "Geoffrey Raposo", email = "geoffrey@raposo.ch"}
-]
+license = { text = "GNU General Public License v3 (GPLv3)" }
+authors = [{ name = "Geoffrey Raposo", email = "geoffrey@raposo.ch" }]
 maintainers = [
-    {name = "Andre Anjos", email = "andre.anjos@idiap.ch"},
-    {name = "Daniel Carron", email = "daniel.carron@idiap.ch"}
+    { name = "Andre Anjos", email = "andre.anjos@idiap.ch" },
+    { name = "Daniel Carron", email = "daniel.carron@idiap.ch" },
 ]
 classifiers = [
     "Development Status :: 4 - Beta",
@@ -29,21 +27,21 @@ classifiers = [
     "Topic :: Software Development :: Libraries :: Python Modules",
 ]
 dependencies = [
-   "clapper",
-   "click",
-   "numpy",
-   "pandas",
-   "scipy",
-   "scikit-learn",
-   "tqdm",
-   "psutil",
-   "tabulate",
-   "matplotlib",
-   "pillow",
-   "torch>=1.8",
-   "torchvision>=0.10",
-   "lightning>=2.0.3",
-   "tensorboard",
+    "clapper",
+    "click",
+    "numpy",
+    "pandas",
+    "scipy",
+    "scikit-learn",
+    "tqdm",
+    "psutil",
+    "tabulate",
+    "matplotlib",
+    "pillow",
+    "torch>=1.8",
+    "torchvision>=0.10",
+    "lightning>=2.0.3",
+    "tensorboard",
 ]
 
 [project.urls]
@@ -62,12 +60,8 @@ doc = [
     "sphinx-copybutton",
     "sphinx-inline-tabs",
     "sphinx-click",
-    ]
-test = [
-    "pytest",
-    "pytest-cov",
-    "coverage",
-    ]
+]
+test = ["pytest", "pytest-cov", "coverage"]
 
 [project.scripts]
 ptbench = "ptbench.scripts.cli:cli"
@@ -487,10 +481,10 @@ padchest_tb_idiap_rs = "ptbench.configs.datasets.padchest_RS.tb_idiap"
 
 [tool.setuptools]
 zip-safe = true
-package-dir = {"" = "src"}
+package-dir = { "" = "src" }
 
 [tool.setuptools.dynamic]
-readme = {file = "README.md"}
+readme = { file = "README.md" }
 
 [tool.distutils.bdist_wheel]
 universal = true
@@ -505,10 +499,6 @@ lines_between_types = 1
 line-length = 80
 
 [tool.pytest.ini_options]
-addopts = [
-    "--cov=ptbench",
-    "--cov-report=term-missing",
-    "--import-mode=append",
-]
+addopts = ["--cov=ptbench", "--cov-report=term-missing", "--import-mode=append"]
 junit_logging = "all"
 junit_log_passing_tests = false