From d6d5d3426db1757936feae8f0b6900ecf3d77293 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sol=C3=A8ne=20Tarride?= <starride@teklia.com>
Date: Thu, 12 Oct 2023 15:54:36 +0200
Subject: [PATCH] Fix documentation
---
dan/ocr/decoder.py | 4 ++--
docs/get_started/training.md | 2 +-
docs/usage/index.md | 2 +-
3 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/dan/ocr/decoder.py b/dan/ocr/decoder.py
index 644f8d3b..b62c0f6c 100644
--- a/dan/ocr/decoder.py
+++ b/dan/ocr/decoder.py
@@ -597,8 +597,8 @@ class CTCLanguageDecoder:
) -> Dict[str, List[Union[str, float]]]:
"""
Decode a feature vector using n-gram language modelling.
- :param features: Feature vector of size (batch_size, n_tokens, n_frames).
- :param batch_sizes: Prediction length of size batch_size.
+ :param batch_features: Feature vector of size (batch_size, n_tokens, n_frames).
+ :param batch_frames: Prediction length of size batch_size.
:return: A dictionary containing the hypotheses and their confidences.
"""
# Reshape from (batch_size, n_tokens, n_frames) to (batch_size, n_frames, n_tokens)
diff --git a/docs/get_started/training.md b/docs/get_started/training.md
index 92eda24c..1cb5a0cf 100644
--- a/docs/get_started/training.md
+++ b/docs/get_started/training.md
@@ -32,4 +32,4 @@ To train a DAN model, please refer to the [documentation of the training command
## 3. Predict
-Once the training is complete, you can apply a trained DAN model on an image using the [predict command](../usage/predict.md) and the `inference_parameters.yml` file, located in `{training.output_folder}/results`.
+Once the training is complete, you can apply a trained DAN model on an image using the [predict command](../usage/predict/index.md) and the `inference_parameters.yml` file, located in `{training.output_folder}/results`.
diff --git a/docs/usage/index.md b/docs/usage/index.md
index c926d9b9..1bd57fec 100644
--- a/docs/usage/index.md
+++ b/docs/usage/index.md
@@ -9,4 +9,4 @@ When `teklia-dan` is installed in your environment, you may use the following co
: To train a new DAN model. More details in [the dedicated section](./train/index.md).
`teklia-dan predict`
-: To predict an image using a trained DAN model. More details in [the dedicated section](./predict.md).
+: To predict an image using a trained DAN model. More details in [the dedicated section](./predict/index.md).
--
GitLab