diff --git a/docs/usage/evaluate/index.md b/docs/usage/evaluate/index.md index cdb1c9939706311c66374a18ca47400f01352ac7..c672b466ab2de0cad2e25440c4f6554dfb693faa 100644 --- a/docs/usage/evaluate/index.md +++ b/docs/usage/evaluate/index.md @@ -20,11 +20,12 @@ This will, for each evaluated split: The display of the worst predictions does not support batch evaluation. If the `training.data.batch_size` parameter is not equal to `1`, then the `WER` displayed is the `WER` of the **whole batch** and not just the image. -| Parameter | Description | Type | Default | -| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | ------- | -| `--config` | Path to the configuration file. | `pathlib.Path` | | -| `--nerval-threshold` | Distance threshold for the match between gold and predicted entity during Nerval evaluation. `0` would impose perfect matches, `1` would allow completely different strings to be considered as a match. | `float` | `0.3` | -| `--output-json` | Where to save evaluation results in JSON format. | `pathlib.Path` | `None` | +| Parameter | Description | Type | Default | +| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | -------------------------- | +| `--config` | Path to the configuration file. | `pathlib.Path` | | +| `--nerval-threshold` | Distance threshold for the match between gold and predicted entity during Nerval evaluation. `0` would impose perfect matches, `1` would allow completely different strings to be considered as a match. | `float` | `0.3` | +| `--output-json` | Where to save evaluation results in JSON format. | `pathlib.Path` | `None` | +| `--sets` | Which sets should be evaluated. | `str` | `["train", "val", "test"]` | ## Examples