From 42a2413ce1349f9b5541465763af8fd1c955eeb1 Mon Sep 17 00:00:00 2001 From: LMMilliken Date: Fri, 7 Oct 2022 14:26:25 +0200 Subject: [PATCH] docs: add callbacks documentation (#564) --- docs/walkthrough/using-callbacks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/walkthrough/using-callbacks.md b/docs/walkthrough/using-callbacks.md index 2d8b6eef9..7ca734f46 100644 --- a/docs/walkthrough/using-callbacks.md +++ b/docs/walkthrough/using-callbacks.md @@ -43,7 +43,7 @@ The evaluation callback is used to calculate performance metrics for the model b INFO Pushing artifact to Hubble ... __main__.py:231 ``` -The evaluation callback is triggered at the end of each epoch, in which the model is evaluated using the `query_data` and `index_data` datasets that were provided when the callback was created. It is worth noting that the evaluation callback and the eval_data parameter of the fir method do not do the same thing. The eval data parameter takes a Document Array (or the name of one that has been pushed on Hubble) and uses its contents to evaluate the loss of the model whereas the evaluation callback is used to evaluate the quality of the searches using metrics such as average precision and recall. These search metrics can be used by other callbacks if the evaluation callback is first in the list of callbacks when creating a run. +The evaluation callback is triggered at the end of each epoch, in which the model is evaluated using the `query_data` and `index_data` datasets that were provided when the callback was created. It is worth noting that the evaluation callback and the eval_data parameter of the fit method do not do the same thing. The eval data parameter takes a Document Array (or the name of one that has been pushed on Hubble) and uses its contents to evaluate the loss of the model whereas the evaluation callback is used to evaluate the quality of the searches using metrics such as average precision and recall. These search metrics can be used by other callbacks if the evaluation callback is first in the list of callbacks when creating a run. ## Best Model Checkpoint