Skip to content
Snippets Groups Projects
Verified Commit adfd2b90 authored by Yoann Schneider's avatar Yoann Schneider :tennis:
Browse files

Document new argument

parent cc85e2b8
No related branches found
No related tags found
1 merge request!480Evaluate specific sets only
This commit is part of merge request !480. Comments created here will be created in the context of that merge request.
Hide whitespace changes
Inline Side-by-side
docs/usage/evaluate/index.md
+ 6
− 5
View file @ adfd2b90
......@@ -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
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment