Document FARMReader.train() evaluation report log level (deepset-ai#3129

) * Mention evaluation report logging level * Mention evaluation report logging level
joesalvati68 · Sep 1, 2022 · d4722c2 · d4722c2
1 parent 356537c
commit d4722c2
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/docs/_src/api/api/reader.md b/docs/_src/api/api/reader.md
@@ -144,7 +144,8 @@ parameter is not used and a single cpu device is used for inference.
 - `warmup_proportion`: Proportion of training steps until maximum learning rate is reached.
 Until that point LR is increasing linearly. After that it's decreasing again linearly.
 Options for different schedules are available in FARM.
-- `evaluate_every`: Evaluate the model every X steps on the hold-out eval dataset
+- `evaluate_every`: Evaluate the model every X steps on the hold-out eval dataset.
+Note that the evaluation report is logged at evaluation level INFO while Haystack's default is WARNING.
 - `save_dir`: Path to store the final model
 - `num_processes`: The number of processes for `multiprocessing.Pool` during preprocessing.
 Set to value of 1 to disable multiprocessing. When set to 1, you cannot split away a dev set from train set.

diff --git a/haystack/nodes/reader/farm.py b/haystack/nodes/reader/farm.py
@@ -395,7 +395,8 @@ def train(
         :param warmup_proportion: Proportion of training steps until maximum learning rate is reached.
                                   Until that point LR is increasing linearly. After that it's decreasing again linearly.
                                   Options for different schedules are available in FARM.
-        :param evaluate_every: Evaluate the model every X steps on the hold-out eval dataset
+        :param evaluate_every: Evaluate the model every X steps on the hold-out eval dataset.
+                               Note that the evaluation report is logged at evaluation level INFO while Haystack's default is WARNING.
         :param save_dir: Path to store the final model
         :param num_processes: The number of processes for `multiprocessing.Pool` during preprocessing.
                               Set to value of 1 to disable multiprocessing. When set to 1, you cannot split away a dev set from train set.