Skip to content

Commit

Permalink
docs: add callbacks documentation (#564)
Browse files Browse the repository at this point in the history
  • Loading branch information
LMMilliken committed Oct 7, 2022
1 parent dfa62f8 commit 42a2413
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/walkthrough/using-callbacks.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 42a2413

Please sign in to comment.