From b0aa9972dba657a01a36e8916ce1501b97f54915 Mon Sep 17 00:00:00 2001
From: manonBlanco <blanco@teklia.com>
Date: Thu, 2 Nov 2023 09:14:59 +0100
Subject: [PATCH] Apply suggestions
---
dan/ocr/predict/__init__.py | 2 +-
dan/ocr/predict/inference.py | 2 +-
docs/usage/predict/index.md | 2 +-
3 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/dan/ocr/predict/__init__.py b/dan/ocr/predict/__init__.py
index 3500fbed..000d7c99 100644
--- a/dan/ocr/predict/__init__.py
+++ b/dan/ocr/predict/__init__.py
@@ -31,7 +31,7 @@ def add_predict_parser(subcommands) -> None:
parser.add_argument(
"--model",
type=pathlib.Path,
- help="Path to the directory containing the model, the YAML parameters file and the charset file to be used for prediction.",
+ help="Path to the directory containing the model, the YAML parameters file and the charset file to use for prediction.",
required=True,
)
parser.add_argument(
diff --git a/dan/ocr/predict/inference.py b/dan/ocr/predict/inference.py
index 2bea4bee..7f463a33 100644
--- a/dan/ocr/predict/inference.py
+++ b/dan/ocr/predict/inference.py
@@ -437,7 +437,7 @@ def run(
Predict a single image save the output
:param image: Path to the image to predict.
:param image_dir: Path to the folder where the images to predict are stored.
- :param model: Path to the directory containing the model, the YAML parameters file and the charset file to be used for prediction.
+ :param model: Path to the directory containing the model, the YAML parameters file and the charset file to use for prediction.
:param output: Path to the output folder where the results will be saved.
:param confidence_score: Whether to compute confidence score.
:param attention_map: Whether to plot the attention map.
diff --git a/docs/usage/predict/index.md b/docs/usage/predict/index.md
index 9ab4edaa..bfa15869 100644
--- a/docs/usage/predict/index.md
+++ b/docs/usage/predict/index.md
@@ -9,7 +9,7 @@ Use the `teklia-dan predict` command to apply a trained DAN model on an image.
| `--image` | Path to the image to predict. Must not be provided with `--image-dir`. | `pathlib.Path` | |
| `--image-dir` | Path to the folder where the images to predict are stored. Must not be provided with `--image`. | `pathlib.Path` | |
| `--image-extension` | The extension of the images in the folder. Ignored if `--image-dir` is not provided. | `str` | .jpg |
-| `--model` | Path to the directory containing the model, the YAML parameters file and the charset file to be used for prediction | `pathlib.Path` | |
+| `--model` | Path to the directory containing the model, the YAML parameters file and the charset file to use for prediction. | `pathlib.Path` | |
| `--output` | Path to the output folder. Results will be saved in this directory. | `pathlib.Path` | |
| `--tokens` | Path to a yaml file containing a mapping between starting tokens and end tokens. Needed for entities. | `pathlib.Path` | |
| `--temperature` | Temperature scaling scalar parameter. | `float` | `1.0` |
--
GitLab