From ac1f954c270ea7668018d6b3d7bf7e19f989b528 Mon Sep 17 00:00:00 2001
From: Yoann Schneider <yschneider@teklia.com>
Date: Wed, 1 Feb 2023 10:07:45 +0000
Subject: [PATCH] Document training subcommands
---
dan/ocr/line/__init__.py | 4 ++--
docs/usage/train.md | 8 ++++++++
2 files changed, 10 insertions(+), 2 deletions(-)
diff --git a/dan/ocr/line/__init__.py b/dan/ocr/line/__init__.py
index 603a060d..9ebcdea7 100644
--- a/dan/ocr/line/__init__.py
+++ b/dan/ocr/line/__init__.py
@@ -7,7 +7,7 @@ from dan.ocr.line.train import run as run_train
def add_generate_parser(subcommands) -> None:
parser = subcommands.add_parser(
"generate",
- description=__doc__,
+ description="Generate synthetic data to train DAN models.",
help="Generate synthetic data to train DAN models.",
)
parser.set_defaults(func=run_generate)
@@ -16,7 +16,7 @@ def add_generate_parser(subcommands) -> None:
def add_line_parser(subcommands) -> None:
parser = subcommands.add_parser(
"line",
- description=__doc__,
+ description="Train a DAN model at line level.",
help="Train a DAN model at line level.",
)
parser.set_defaults(func=run_train)
diff --git a/docs/usage/train.md b/docs/usage/train.md
index cacc7c67..ba0aa224 100644
--- a/docs/usage/train.md
+++ b/docs/usage/train.md
@@ -2,6 +2,14 @@
Use the `teklia-dan train` command to train a new DAN model.
+Two subcommands are available depending on your dataset:
+
+`line`
+: Train a DAN model at line-level.
+
+`document`
+: Train a DAN model at document-level.
+
## Remarks (for pre-training and training)
All hyperparameters are specified and editable in the training scripts (meaning are in comments).
--
GitLab