explosion/spaCy
1
1
Fork 0
mirror of https://github.com/explosion/spaCy.git synced 2025-07-11 16:52:21 +03:00
Code Issues Packages Projects Releases Wiki Activity

fix training.batch_size example (#12963)

Browse Source
This commit is contained in:
Magdalena Aniol 2023-09-06 16:38:13 +02:00 committed by svlandeg
parent 807f36eaa1
commit 1c0205967d
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
website/docs/usage/training.mdx
View File

@ -180,7 +180,7 @@ Some of the main advantages and features of spaCy's training config are:
Under the hood, the config is parsed into a dictionary. It's divided into Under the hood, the config is parsed into a dictionary. It's divided into
sections and subsections, indicated by the square brackets and dot notation. For sections and subsections, indicated by the square brackets and dot notation. For
example, `[training]` is a section and `[training.batch_size]` a subsection. example, `[training]` is a section and `[training.batcher]` a subsection.
Subsections can define values, just like a dictionary, or use the `@` syntax to Subsections can define values, just like a dictionary, or use the `@` syntax to
refer to [registered functions](#config-functions). This allows the config to refer to [registered functions](#config-functions). This allows the config to
not just define static settings, but also construct objects like architectures, not just define static settings, but also construct objects like architectures,
@ -254,7 +254,7 @@ For cases like this, you can set additional command-line options starting with
block. block.
```bash ```bash
$ python -m spacy train config.cfg --paths.train ./corpus/train.spacy --paths.dev ./corpus/dev.spacy --training.batch_size 128 $ python -m spacy train config.cfg --paths.train ./corpus/train.spacy --paths.dev ./corpus/dev.spacy --training.max_epochs 3
``` ```
Only existing sections and values in the config can be overwritten. At the end Only existing sections and values in the config can be overwritten. At the end
@ -279,7 +279,7 @@ process. Environment variables **take precedence** over CLI overrides and values
defined in the config file. defined in the config file.
```bash ```bash
$ SPACY_CONFIG_OVERRIDES="--system.gpu_allocator pytorch --training.batch_size 128" ./your_script.sh $ SPACY_CONFIG_OVERRIDES="--system.gpu_allocator pytorch --training.max_epochs 3" ./your_script.sh
``` ```
### Reading from standard input {id="config-stdin"} ### Reading from standard input {id="config-stdin"}
@ -578,16 +578,17 @@ now-updated model to the predicted docs.
The training configuration defined in the config file doesn't have to only The training configuration defined in the config file doesn't have to only
consist of static values. Some settings can also be **functions**. For instance, consist of static values. Some settings can also be **functions**. For instance,
the `batch_size` can be a number that doesn't change, or a schedule, like a the batch size can be a number that doesn't change, or a schedule, like a
sequence of compounding values, which has shown to be an effective trick (see sequence of compounding values, which has shown to be an effective trick (see
[Smith et al., 2017](https://arxiv.org/abs/1711.00489)). [Smith et al., 2017](https://arxiv.org/abs/1711.00489)).
```ini {title="With static value"} ```ini {title="With static value"}
[training] [training.batcher]
batch_size = 128 @batchers = "spacy.batch_by_words.v1"
size = 3000
``` ```
To refer to a function instead, you can make `[training.batch_size]` its own To refer to a function instead, you can make `[training.batcher.size]` its own
section and use the `@` syntax to specify the function and its arguments – in section and use the `@` syntax to specify the function and its arguments – in
this case [`compounding.v1`](https://thinc.ai/docs/api-schedules#compounding) this case [`compounding.v1`](https://thinc.ai/docs/api-schedules#compounding)
defined in the [function registry](/api/top-level#registry). All other values defined in the [function registry](/api/top-level#registry). All other values
@ -606,7 +607,7 @@ from your configs.
> optimizer. > optimizer.
```ini {title="With registered function"} ```ini {title="With registered function"}
[training.batch_size] [training.batcher.size]
@schedules = "compounding.v1" @schedules = "compounding.v1"
start = 100 start = 100
stop = 1000 stop = 1000
@ -1027,14 +1028,14 @@ def my_custom_schedule(start: int = 1, factor: float = 1.001):
``` ```
In your config, you can now reference the schedule in the In your config, you can now reference the schedule in the
`[training.batch_size]` block via `@schedules`. If a block contains a key `[training.batcher.size]` block via `@schedules`. If a block contains a key
starting with an `@`, it's interpreted as a reference to a function. All other starting with an `@`, it's interpreted as a reference to a function. All other
settings in the block will be passed to the function as keyword arguments. Keep settings in the block will be passed to the function as keyword arguments. Keep
in mind that the config shouldn't have any hidden defaults and all arguments on in mind that the config shouldn't have any hidden defaults and all arguments on
the functions need to be represented in the config. the functions need to be represented in the config.
```ini {title="config.cfg (excerpt)"} ```ini {title="config.cfg (excerpt)"}
[training.batch_size] [training.batcher.size]
@schedules = "my_custom_schedule.v1" @schedules = "my_custom_schedule.v1"
start = 2 start = 2
factor = 1.005 factor = 1.005