spaCy/website/docs/api
Raphael Mitsch 1f23c615d7
Refactor KB for easier customization (#11268)
* Add implementation of batching + backwards compatibility fixes. Tests indicate issue with batch disambiguation for custom singular entity lookups.

* Fix tests. Add distinction w.r.t. batch size.

* Remove redundant and add new comments.

* Adjust comments. Fix variable naming in EL prediction.

* Fix mypy errors.

* Remove KB entity type config option. Change return types of candidate retrieval functions to Iterable from Iterator. Fix various other issues.

* Update spacy/pipeline/entity_linker.py

Co-authored-by: Paul O'Leary McCann <polm@dampfkraft.com>

* Update spacy/pipeline/entity_linker.py

Co-authored-by: Paul O'Leary McCann <polm@dampfkraft.com>

* Update spacy/kb_base.pyx

Co-authored-by: Paul O'Leary McCann <polm@dampfkraft.com>

* Update spacy/kb_base.pyx

Co-authored-by: Paul O'Leary McCann <polm@dampfkraft.com>

* Update spacy/pipeline/entity_linker.py

Co-authored-by: Paul O'Leary McCann <polm@dampfkraft.com>

* Add error messages to NotImplementedErrors. Remove redundant comment.

* Fix imports.

* Remove redundant comments.

* Rename KnowledgeBase to InMemoryLookupKB and BaseKnowledgeBase to KnowledgeBase.

* Fix tests.

* Update spacy/errors.py

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

* Move KB into subdirectory.

* Adjust imports after KB move to dedicated subdirectory.

* Fix config imports.

* Move Candidate + retrieval functions to separate module. Fix other, small issues.

* Fix docstrings and error message w.r.t. class names. Fix typing for candidate retrieval functions.

* Update spacy/kb/kb_in_memory.pyx

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

* Update spacy/ml/models/entity_linker.py

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

* Fix typing.

* Change typing of mentions to be Span instead of Union[Span, str].

* Update docs.

* Update EntityLinker and _architecture docs.

* Update website/docs/api/entitylinker.md

Co-authored-by: Paul O'Leary McCann <polm@dampfkraft.com>

* Adjust message for E1046.

* Re-add section for Candidate in kb.md, add reference to dedicated page.

* Update docs and docstrings.

* Re-add section + reference for KnowledgeBase.get_alias_candidates() in docs.

* Update spacy/kb/candidate.pyx

* Update spacy/kb/kb_in_memory.pyx

* Update spacy/pipeline/legacy/entity_linker.py

* Remove canididate.md. Remove mistakenly added config snippet in entity_linker.py.

Co-authored-by: Paul O'Leary McCann <polm@dampfkraft.com>
Co-authored-by: Sofie Van Landeghem <svlandeg@users.noreply.github.com>
2022-09-08 10:38:07 +02:00
..
architectures.md Refactor KB for easier customization (#11268) 2022-09-08 10:38:07 +02:00
attributeruler.md Document scorers in registry and components from #8766 (#8929) 2021-08-12 12:50:03 +02:00
attributes.md Add API docs for token attribute symbols (#10836) 2022-06-23 08:16:38 +02:00
cli.md Add a way to get the URL to download a pipeline to the CLI (#11175) 2022-09-02 11:58:21 +02:00
corpus.md Remove NBSP's across tables in the docs (#10842) 2022-05-25 09:48:39 +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 adding spans to doc_annotation in Example.to_dict (#11261) 2022-08-05 12:26:38 +02:00
dependencymatcher.md add additional REL_OP (#10371) 2022-07-27 13:16:44 +02:00
dependencyparser.md Update docs for pipeline initialize() methods (#11221) 2022-08-03 16:53:02 +02:00
doc.md Add Doc.from_json() (#10688) 2022-06-02 14:03:47 +02:00
docbin.md Fix point typo on docbin docs (#9097) 2021-08-31 10:55:44 +02:00
edittreelemmatizer.md Update docs for pipeline initialize() methods (#11221) 2022-08-03 16:53:02 +02:00
entitylinker.md Refactor KB for easier customization (#11268) 2022-09-08 10:38:07 +02:00
entityrecognizer.md Update docs for pipeline initialize() methods (#11221) 2022-08-03 16:53:02 +02:00
entityruler.md Add SpanRuler component (#9880) 2022-06-02 13:12:53 +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_in_memory.md Refactor KB for easier customization (#11268) 2022-09-08 10:38:07 +02:00
kb.md Refactor KB for easier customization (#11268) 2022-09-08 10:38:07 +02:00
language.md Allow string argument for disable/enable/exclude (#11406) 2022-08-31 09:02:34 +02:00
legacy.md Add ConsoleLogger.v2 (#11214) 2022-08-29 10:23:05 +02:00
lemmatizer.md Switch ru and uk lemmatizers to pymorphy3 (#11345) 2022-08-22 11:27:14 +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 docs (#11123) 2022-07-24 17:16:36 +09:00
morphologizer.md Update docs for pipeline initialize() methods (#11221) 2022-08-03 16:53:02 +02:00
morphology.md Document Assigned Attributes of Pipeline Components (#9041) 2021-09-01 12:09:39 +02:00
phrasematcher.md 🏷 Add Mypy check to CI and ignore all existing Mypy errors (#9167) 2021-10-14 15:21:40 +02:00
pipe.md Document scorers in registry and components from #8766 (#8929) 2021-08-12 12:50:03 +02:00
pipeline-functions.md add doc cleaner to menu (#10862) 2022-05-30 08:51:19 +02:00
scorer.md Add micro PRF for morph scoring (#9546) 2021-10-29 10:29:29 +02:00
sentencerecognizer.md Update docs for pipeline initialize() methods (#11221) 2022-08-03 16:53:02 +02:00
sentencizer.md Update overwrite and scorer in API docs (#9384) 2021-10-11 10:35:07 +02:00
span.md Add SpanRuler component (#9880) 2022-06-02 13:12:53 +02:00
spancategorizer.md Update docs for pipeline initialize() methods (#11221) 2022-08-03 16:53:02 +02:00
spangroup.md SpanGroup(s)-related optimizations (#11380) 2022-08-31 09:03:20 +02:00
spanruler.md the 'new' indicator wants a 'number' (#10997) 2022-06-21 22:01:16 +02:00
stringstore.md Fix misspelt keyword in StringStore example 2022-05-29 10:49:19 +01:00
tagger.md Update docs for pipeline initialize() methods (#11221) 2022-08-03 16:53:02 +02:00
textcategorizer.md Update docs for pipeline initialize() methods (#11221) 2022-08-03 16:53:02 +02:00
tok2vec.md Update docs for pipeline initialize() methods (#11221) 2022-08-03 16:53:02 +02:00
token.md token.md: Fix documentation of Token.ancestors (#10917) 2022-06-06 14:32:36 +09:00
tokenizer.md Add tokenizer option to allow Matcher handling for all rules (#10452) 2022-03-24 13:21:32 +01:00
top-level.md Allow string argument for disable/enable/exclude (#11406) 2022-08-31 09:02:34 +02:00
transformer.md Update docs for pipeline initialize() methods (#11221) 2022-08-03 16:53:02 +02:00
vectors.md Docs for v3.3 (#10628) 2022-04-28 14:09:35 +02:00
vocab.md Add vector deduplication (#10551) 2022-03-30 08:54:23 +02:00