spaCy/website/docs/api
Matthew Honnibal f9946154d9
Add SpanCategorizer component (#6747)
* Draft spancat model

* Add spancat model

* Add test for extract_spans

* Add extract_spans layer

* Upd extract_spans

* Add spancat model

* Add test for spancat model

* Upd spancat model

* Update spancat component

* Upd spancat

* Update spancat model

* Add quick spancat test

* Import SpanCategorizer

* Fix SpanCategorizer component

* Import SpanGroup

* Fix span extraction

* Fix import

* Fix import

* Upd model

* Update spancat models

* Add scoring, update defaults

* Update and add docs

* Fix type

* Update spacy/ml/extract_spans.py

* Auto-format and fix import

* Fix comment

* Fix type

* Fix type

* Update website/docs/api/spancategorizer.md

* Fix comment

Co-authored-by: Sofie Van Landeghem <svlandeg@users.noreply.github.com>

* Better defense

Co-authored-by: Sofie Van Landeghem <svlandeg@users.noreply.github.com>

* Fix labels list

Co-authored-by: Sofie Van Landeghem <svlandeg@users.noreply.github.com>

* Update spacy/ml/extract_spans.py

Co-authored-by: Sofie Van Landeghem <svlandeg@users.noreply.github.com>

* Update spacy/pipeline/spancat.py

Co-authored-by: Sofie Van Landeghem <svlandeg@users.noreply.github.com>

* Set annotations during update

* Set annotations in spancat

* fix imports in test

* Update spacy/pipeline/spancat.py

* replace MaxoutLogistic with LinearLogistic

* fix config

* various small fixes

* remove set_annotations parameter in update

* use our beloved tupley format with recent support for doc.spans

* bugfix to allow renaming the default span_key (scores weren't showing up)

* use different key in docs example

* change defaults to better-working parameters from project (WIP)

* register spacy.extract_spans.v1 for legacy purposes

* Upd dev version so can build wheel

* layers instead of architectures for smaller building blocks

* Update website/docs/api/spancategorizer.md

Co-authored-by: Adriane Boyd <adrianeboyd@gmail.com>

* Update website/docs/api/spancategorizer.md

Co-authored-by: Adriane Boyd <adrianeboyd@gmail.com>

* Include additional scores from overrides in combined score weights

* Parameterize spans key in scoring

Parameterize the `SpanCategorizer` `spans_key` for scoring purposes so
that it's possible to evaluate multiple `spancat` components in the same
pipeline.

* Use the (intentionally very short) default spans key `sc` in the
  `SpanCategorizer`
* Adjust the default score weights to include the default key
* Adjust the scorer to use `spans_{spans_key}` as the prefix for the
  returned score
* Revert addition of `attr_name` argument to `score_spans` and adjust
  the key in the `getter` instead.

Note that for `spancat` components with a custom `span_key`, the score
weights currently need to be modified manually in
`[training.score_weights]` for them to be available during training. To
suppress the default score weights `spans_sc_p/r/f` during training, set
them to `null` in `[training.score_weights]`.

* Update website/docs/api/scorer.md

* Fix scorer for spans key containing underscore

* Increment version

* Add Spans to Evaluate CLI (#8439)

* Add Spans to Evaluate CLI

* Change to spans_key

* Add spans per_type output

Co-authored-by: Adriane Boyd <adrianeboyd@gmail.com>

* Fix spancat GPU issues (#8455)

* Fix GPU issues

* Require thinc >=8.0.6

* Switch to glorot_uniform_init

* Fix and test ngram suggester

* Include final ngram in doc for all sizes
* Fix ngrams for docs of the same length as ngram size
* Handle batches of docs that result in no ngrams
* Add tests

Co-authored-by: Ines Montani <ines@ines.io>
Co-authored-by: Sofie Van Landeghem <svlandeg@users.noreply.github.com>
Co-authored-by: svlandeg <sofie.vanlandeghem@gmail.com>
Co-authored-by: Adriane Boyd <adrianeboyd@gmail.com>
Co-authored-by: Nirant <NirantK@users.noreply.github.com>
2021-06-24 12:35:27 +02:00
..
architectures.md Add SpanCategorizer component (#6747) 2021-06-24 12:35:27 +02:00
attributeruler.md Update docs [ci skip] 2020-10-09 10:36:06 +02:00
cli.md Add docs [ci skip] 2021-06-24 11:57:15 +10:00
corpus.md Integrate file readers 2020-10-02 01:36:06 +02:00
cython-classes.md Update docs, types and API consistency 2020-08-17 16:45:24 +02:00
cython-structs.md Update docs, types and API consistency 2020-08-17 16:45:24 +02:00
cython.md Update docs [ci skip] 2020-09-12 17:05:10 +02:00
data-formats.md Resizable textcat (#7862) 2021-06-16 11:45:00 +02:00
dependencymatcher.md doc fixes 2020-09-12 17:38:54 +02:00
dependencyparser.md Support negative examples in partial NER annotations (#8106) 2021-06-17 17:33:00 +10:00
doc.md Update sent_starts in Example.from_dict (#7847) 2021-04-22 11:32:45 +02:00
docbin.md small UX fix for DocBin (#6167) 2020-10-02 15:43:32 +02:00
entitylinker.md KB & NEL to/from bytes (#8113) 2021-05-20 18:11:30 +10:00
entityrecognizer.md Support negative examples in partial NER annotations (#8106) 2021-06-17 17:33:00 +10:00
entityruler.md Update docs [ci skip] 2020-10-06 10:31:48 +02:00
example.md Extend score_spans for overlapping & non-labeled spans (#7209) 2021-04-08 12:19:17 +02:00
index.md Update v3 docs 2020-07-03 16:48:21 +02:00
kb.md kb.get_candidates renamed to get_alias_candidates 2021-02-25 20:09:36 +01:00
language.md Fix docs (fix #8189) 2021-05-24 19:47:30 +09:00
legacy.md Resizable textcat (#7862) 2021-06-16 11:45:00 +02:00
lemmatizer.md Various docs updates for v3.1 (#8406) 2021-06-21 09:33:50 +02:00
lexeme.md fix 's typo's across code base (#8384) 2021-06-15 10:57:08 +02:00
lookups.md Update docs, types and API consistency 2020-08-17 16:45:24 +02:00
matcher.md Fix new version for match_alignments (#8021) 2021-05-07 09:55:20 +02:00
morphologizer.md Revert "Set annotations in update" (#6810) 2021-01-25 22:18:45 +08:00
morphology.md Proofreading 2020-09-24 13:15:28 +02:00
phrasematcher.md Run PhraseMatcher on Spans (#6918) 2021-02-10 23:43:32 +11:00
pipe.md adding new="3" mentions in the doc 2021-01-29 11:26:37 +01:00
pipeline-functions.md Remove transformers model max length section (#6807) 2021-01-25 19:59:34 +08:00
scorer.md Various docs updates for v3.0 (#8353) 2021-06-14 12:19:36 +02:00
sentencerecognizer.md Revert "Set annotations in update" (#6810) 2021-01-25 22:18:45 +08:00
sentencizer.md Update sentencizer documentation example with sentencizer pipe name (#7185) 2021-02-24 08:06:54 +01:00
span.md span.ent only returns first sentence (#7084) 2021-02-19 23:02:38 +11:00
spancategorizer.md Add SpanCategorizer component (#6747) 2021-06-24 12:35:27 +02:00
spangroup.md Add SpanGroup and Graph container types to represent arbitrary annotations (#6696) 2021-01-14 17:30:41 +11:00
stringstore.md Update docs, types and API consistency 2020-08-17 16:45:24 +02:00
tagger.md Revert "Set annotations in update" (#6810) 2021-01-25 22:18:45 +08:00
textcategorizer.md textcat scoring fix and multi_label docs (#6974) 2021-03-09 23:04:22 +11:00
tok2vec.md Revert "Set annotations in update" (#6810) 2021-01-25 22:18:45 +08:00
token.md fix 's typo's across code base (#8384) 2021-06-15 10:57:08 +02:00
tokenizer.md Merge remote-tracking branch 'upstream/master' into chore/update-develop-from-master-rc3 2021-01-14 11:49:58 +01:00
top-level.md fix docs (#8200) 2021-05-27 10:48:59 +02:00
transformer.md Merge remote-tracking branch 'upstream/develop' into chore/develop-into-master-v3.1 2021-06-15 15:05:17 +02:00
vectors.md Proofreading 2020-09-28 16:50:15 +02:00
vocab.md Extend docs related to Vocab.get_noun_chunks 2021-02-25 16:38:21 +01:00