explosion/spaCy
1
1
Fork 0
mirror of https://github.com/explosion/spaCy.git synced 2025-04-22 01:51:58 +03:00
Code Issues Packages Projects Releases Wiki Activity

Fix _distill_loop docstring wrt. stopping condition

Browse Source
This commit is contained in:
Daniël de Kok 2023-04-19 20:11:17 +02:00
parent 962c2972e4
commit abc4a7d320
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
spacy/training/loop.py
View File

@ -284,11 +284,12 @@ def _distill_loop(
before_update: Optional[Callable[["Language", Dict[str, Any]], None]],
student_to_teacher: Dict[str, str],
):
"""Train until an evaluation stops improving. Works as a generator,
with each iteration yielding a tuple `(batch, info, is_best_checkpoint)`,
where info is a dict, and is_best_checkpoint is in [True, False, None] --
None indicating that the iteration was not evaluated as a checkpoint.
The evaluation is conducted by calling the evaluate callback.
"""Distill until the data is exhausted or the maximum number of steps
has been reached. Works as a generator, with each iteration yielding
a tuple `(batch, info, is_best_checkpoint)`, where info is a dict, and
is_best_checkpoint is in [True, False, None] -- None indicating that
the iteration was not evaluated as a checkpoint. The evaluation is
conducted by calling the evaluate callback.
Positional arguments:
teacher (Language): The teacher pipeline to distill from.