From 486ebe3f69c0557016fc6b925090224598e55e80 Mon Sep 17 00:00:00 2001 From: manonBlanco <blanco@teklia.com> Date: Tue, 13 Jun 2023 09:11:29 +0200 Subject: [PATCH] Update documentation --- docs/usage/train/parameters.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/usage/train/parameters.md b/docs/usage/train/parameters.md index 7447e082..0fb2f376 100644 --- a/docs/usage/train/parameters.md +++ b/docs/usage/train/parameters.md @@ -8,7 +8,7 @@ All hyperparameters are specified and editable in the training scripts (meaning | `dataset_name` | Name of the dataset. | `str` | | | `dataset_level` | Level of the dataset. Should be named after the element type. | `str` | | | `dataset_variant` | Variant of the dataset. Usually empty for HTR datasets, `"_sem"` for HTR+NER datasets. | `str` | | -| `dataset_path` | Path to the dataset. | `str` | +| `dataset_path` | Path to the dataset. | `str` | | | `dataset_params.config.dataset_manager` | Dataset manager class. | custom class | `OCRDatasetManager` | | `dataset_params.config.dataset_class` | Dataset class. | custom class | `OCRDataset` | | `dataset_params.config.datasets` | Dataset dictionary with the dataset name as key and dataset path as value. | `dict` | | @@ -18,7 +18,7 @@ All hyperparameters are specified and editable in the training scripts (meaning | `dataset_params.config.width_divisor` | Factor to reduce the height of the feature vector before feeding the decoder. | `int` | `32` | | `dataset_params.config.padding_value` | Image padding value. | `int` | `0` | | `dataset_params.config.padding_token` | Transcription padding value. | `int` | `None` | -| `dataset_params.config.constraints` | Whether to add end-of-transcription and start-of-transcription tokens in labels. | `list` | `["add_eot", "add_sot"]` | +| `dataset_params.config.constraints` | Whether to add end-of-transcription and start-of-transcription tokens in labels. | `list` | `[]` | | `dataset_params.config.normalize` | Normalize with mean and variance of training dataset. | `bool` | `True` | | `dataset_params.config.preprocessings` | List of pre-processing functions to apply to input images. | `list` | (see [dedicated section](#data-preprocessing)) | | `dataset_params.config.augmentation` | Configuration for data augmentation. | `dict` | (see [dedicated section](#data-augmentation)) | -- GitLab