spaCy/website/docs/api
Daniël de Kok 319eb508b5
Add a spacy benchmark speed subcommand (#11902)
* Add a `spacy evaluate speed` subcommand

This subcommand reports the mean batch performance of a model on a data set with
a 95% confidence interval. For reliability, it first performs some warmup
rounds. Then it will measure performance on batches with randomly shuffled
documents.

To avoid having too many spaCy commands, `speed` is a subcommand of `evaluate`
and accuracy evaluation is moved to its own `evaluate accuracy` subcommand.

* Fix import cycle

* Restore `spacy evaluate`, make `spacy benchmark speed` an alias

* Add documentation for `spacy benchmark`

* CREATES -> PRINTS

* WPS -> words/s

* Disable formatting of benchmark speed arguments

* Fail with an error message when trying to speed bench empty corpus

* Make it clearer that `benchmark accuracy` is a replacement for `evaluate`

* Fix docstring webpage reference

* tests: check `evaluate` output against `benchmark accuracy`
2023-01-12 11:55:21 +01:00
..
architectures.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
attributeruler.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
attributes.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
cli.mdx Add a spacy benchmark speed subcommand (#11902) 2023-01-12 11:55:21 +01:00
coref.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
corpus.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
cython-classes.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
cython-structs.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
cython.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
data-formats.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
dependencymatcher.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
dependencyparser.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
doc.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
docbin.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
edittreelemmatizer.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
entitylinker.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
entityrecognizer.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
entityruler.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
example.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
index.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
kb_in_memory.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
kb.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
language.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
legacy.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
lemmatizer.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
lexeme.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
lookups.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
matcher.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
morphologizer.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
morphology.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
phrasematcher.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
pipe.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
pipeline-functions.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
scorer.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
sentencerecognizer.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
sentencizer.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
span-resolver.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
span.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
spancategorizer.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
spangroup.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
spanruler.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
stringstore.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
tagger.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
textcategorizer.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
tok2vec.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
token.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
tokenizer.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
top-level.mdx Clean up displacy port-related error messages, docs (#12089) 2023-01-12 14:54:09 +09:00
transformer.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
vectors.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00
vocab.mdx Website migration from Gatsby to Next (#12058) 2023-01-11 17:30:07 +01:00