From e19b490d75d50f95ddcec46ddcf83b062dcff523 Mon Sep 17 00:00:00 2001 From: shademe Date: Wed, 9 Nov 2022 13:55:32 +0100 Subject: [PATCH] Pass `epoch` to callback, rename `current_step` to `step` --- spacy/training/loop.py | 2 +- website/docs/api/data-formats.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/spacy/training/loop.py b/spacy/training/loop.py index 25b0df2fc..885257772 100644 --- a/spacy/training/loop.py +++ b/spacy/training/loop.py @@ -202,7 +202,7 @@ def train_while_improving( start_time = timer() for step, (epoch, batch) in enumerate(train_data): if before_update: - before_update_args = {"current_step": step} + before_update_args = {"step": step, "epoch": epoch} before_update(nlp, before_update_args) dropout = next(dropouts) # type: ignore for subbatch in subdivide_batch(batch, accumulate_gradient): diff --git a/website/docs/api/data-formats.md b/website/docs/api/data-formats.md index 111d77264..768844cf3 100644 --- a/website/docs/api/data-formats.md +++ b/website/docs/api/data-formats.md @@ -186,7 +186,7 @@ process that are used when you run [`spacy train`](/api/cli#train). | `accumulate_gradient` | Whether to divide the batch up into substeps. Defaults to `1`. ~~int~~ | | `batcher` | Callable that takes an iterator of [`Doc`](/api/doc) objects and yields batches of `Doc`s. Defaults to [`batch_by_words`](/api/top-level#batch_by_words). ~~Callable[[Iterator[Doc], Iterator[List[Doc]]]]~~ | | `before_to_disk` | Optional callback to modify `nlp` object right before it is saved to disk during and after training. Can be used to remove or reset config values or disable components. Defaults to `null`. ~~Optional[Callable[[Language], Language]]~~ | -| `before_update` | Optional callback that is invoked at the start of each training step with the `nlp` object and a `Dict` containing the following entries: `current_step`. Can be used to make deferred changes to components. Defaults to `null`. ~~Optional[Callable[[Language, Dict[str, Any]], None]]~~ | +| `before_update` | Optional callback that is invoked at the start of each training step with the `nlp` object and a `Dict` containing the following entries: `step`, `epoch`. Can be used to make deferred changes to components. Defaults to `null`. ~~Optional[Callable[[Language, Dict[str, Any]], None]]~~ | | `dev_corpus` | Dot notation of the config location defining the dev corpus. Defaults to `corpora.dev`. ~~str~~ | | `dropout` | The dropout rate. Defaults to `0.1`. ~~float~~ | | `eval_frequency` | How often to evaluate during training (steps). Defaults to `200`. ~~int~~ |