From c0d3f454c0e6784451503cf701e0990adb244712 Mon Sep 17 00:00:00 2001
From: dcarron <daniel.carron@idiap.ch>
Date: Wed, 26 Jul 2023 12:57:17 +0200
Subject: [PATCH] Update datamodule docstrings
---
src/ptbench/scripts/datamodule.py | 11 ++++++-----
1 file changed, 6 insertions(+), 5 deletions(-)
diff --git a/src/ptbench/scripts/datamodule.py b/src/ptbench/scripts/datamodule.py
index 6cadcc72..c16b6288 100644
--- a/src/ptbench/scripts/datamodule.py
+++ b/src/ptbench/scripts/datamodule.py
@@ -95,17 +95,17 @@ def list():
@datamodule.command(
epilog="""Examples:
- 1. Check if all files of the Montgomery dataset can be loaded:
+ 1. Check if all files from the fold_0 of the Montgomery database can be loaded:
.. code:: sh
- ptbench dataset check -vv shenzhen
+ ptbench datamodule check -vv montgomery_f0
- 2. Check if all files of multiple installed datasets can be loaded:
+ 2. Check if all files of multiple installed protocols can be loaded:
.. code:: sh
- ptbench dataset check -vv montgomery shenzhen
+ ptbench datamodule check -vv montgomery shenzhen
""",
)
@@ -116,7 +116,7 @@ def list():
@click.option(
"--limit",
"-l",
- help="Limit check to the first N samples in each dataset, making the "
+ help="Limit check to the first N samples in each datamodule, making the "
"check sensibly faster. Set it to zero to check everything.",
required=True,
type=click.IntRange(0),
@@ -129,6 +129,7 @@ def check(protocols, limit):
errors = 0
for protocol in protocols:
+ logger.info(f"Checking {protocol}")
try:
module = importlib.metadata.entry_points(group="ptbench.config")[
protocol
--
GitLab