explosion/spaCy
1
1
Fork 0
mirror of https://github.com/explosion/spaCy.git synced 2025-04-22 10:02:01 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update docstrings.

Browse Source
This commit is contained in:
Raphael Mitsch 2023-03-15 09:25:41 +01:00
parent 3cfc1c6acc
commit 80fb0666b9
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
spacy/kb/kb.pyx
View File

@ -32,9 +32,10 @@ cdef class KnowledgeBase:
def get_candidates_batch(self, mentions: Iterable[Span]) -> Iterable[Iterable[Candidate]]:
"""
Return candidate entities for specified texts. Each candidate defines the entity, the original mention,
and the prior probability of this mention resolving to that entity.
If no candidate is found for a given text, an empty list is returned.
Return candidate entities for specified mention texts. Each candidate defines at least the entity and the
entity's embedding vector. Depending on the KB implementation, further properties - such as the prior
probability of the specified mention text resolving to that entity - might be included.
If the no candidates are found for a given mention text, an empty list is returned.
mentions (Iterable[Span]): Mentions for which to get candidates.
RETURNS (Iterable[Iterable[Candidate]]): Identified candidates.
"""
@ -42,10 +43,10 @@ cdef class KnowledgeBase:
def get_candidates(self, mention: Span) -> Iterable[Candidate]:
"""
Return candidate entities for specified text. Each candidate defines at least the entity and the entity's
embedding vector. Depending on the KB implementation, further properties - such as the prior probability of the
specified mention text resolving to that entity - might be included.
If the no candidate is found for a given text, an empty list is returned.
Return candidate entities for specified mention text. Each candidate defines at least the entity and the
entity's embedding vector. Depending on the KB implementation, further properties - such as the prior
probability of the specified mention text resolving to that entity - might be included.
If the no candidate is found for the given mention text, an empty list is returned.
mention (Span): Mention for which to get candidates.
RETURNS (Iterable[Candidate]): Identified candidates.
"""