Update docs [ci skip]

This commit is contained in:
Ines Montani 2020-08-31 17:06:33 +02:00
parent c3b6cbd740
commit 3929431af1

View File

@ -357,8 +357,8 @@ are returned: one for logging the information for each training step, and a
second function that is called to finalize the logging when the training is second function that is called to finalize the logging when the training is
finished. To log each training step, a finished. To log each training step, a
[dictionary](/usage/training#custom-logging) is passed on from the [dictionary](/usage/training#custom-logging) is passed on from the
[training script](/api/cli#train), including information such as the training [`spacy train`](/api/cli#train), including information such as the training loss
loss and the accuracy scores on the development set. and the accuracy scores on the development set.
There are two built-in logging functions: a logger printing results to the There are two built-in logging functions: a logger printing results to the
console in tabular format (which is the default), and one that also sends the console in tabular format (which is the default), and one that also sends the
@ -366,6 +366,8 @@ results to a [Weights & Biases](https://www.wandb.com/) dashboard. Instead of
using one of the built-in loggers listed here, you can also using one of the built-in loggers listed here, you can also
[implement your own](/usage/training#custom-logging). [implement your own](/usage/training#custom-logging).
#### spacy.ConsoleLogger.v1 {#ConsoleLogger tag="registered function"}
> #### Example config > #### Example config
> >
> ```ini > ```ini
@ -373,19 +375,21 @@ using one of the built-in loggers listed here, you can also
> @loggers = "spacy.ConsoleLogger.v1" > @loggers = "spacy.ConsoleLogger.v1"
> ``` > ```
#### spacy.ConsoleLogger.v1 {#ConsoleLogger tag="registered function"}
Writes the results of a training step to the console in a tabular format. Writes the results of a training step to the console in a tabular format.
<Accordion title="Example console output"> <Accordion title="Example console output" spaced>
```cli
$ python -m spacy train config.cfg
```
``` ```
$ python -m spacy train config.cfg
Using CPU Using CPU
Loading config and nlp from: config.cfg Loading config and nlp from: config.cfg
Pipeline: ['tok2vec', 'tagger'] Pipeline: ['tok2vec', 'tagger']
Start training Start training
Training. Initial learn rate: 0.0 Training. Initial learn rate: 0.0
E # LOSS TOK2VEC LOSS TAGGER TAG_ACC SCORE E # LOSS TOK2VEC LOSS TAGGER TAG_ACC SCORE
--- ------ ------------ ----------- ------- ------ --- ------ ------------ ----------- ------- ------
1 0 0.00 86.20 0.22 0.00 1 0 0.00 86.20 0.22 0.00