Update docs.

This commit is contained in:
Raphael Mitsch 2023-04-24 21:18:13 +02:00
parent ee5d7f4a33
commit 638103eb1b
2 changed files with 4 additions and 4 deletions

View File

@ -175,7 +175,7 @@ implementation of `KnowledgeBase.get_candidates()`.
| Name | Description |
| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `mentions` | The textual mention or alias. ~~Iterator[SpanGroup]~~ |
| `mentions` | The textual mentions or aliases (one `SpanGroup` per `Doc` instance). ~~Iterator[SpanGroup]~~ |
| **RETURNS** | An iterator over iterables of iterables with relevant [`InMemoryCandidate`](/api/kb#candidate) objects (per mention and doc). ~~Iterator[Iterable[Iterable[InMemoryCandidate]]]~~ |
## InMemoryLookupKB.get_vector {id="get_vector",tag="method"}

View File

@ -78,9 +78,9 @@ implementation of `KnowledgeBase.get_candidates()`.
> candidates = kb.get_candidates([SpanGroup(doc, spans=[doc[0:2], doc[3:]]])
> ```
| Name | Description |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| `mentions` | The textual mention or alias. ~~Iterator[SpanGroup]~~ |
| Name | Description |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `mentions` | The textual mentions or aliases (one `SpanGroup` per `Doc` instance). ~~Iterator[SpanGroup]~~ |
| **RETURNS** | An iterator (per document) over iterables (per mention) of iterables (per candidate for this mention) with relevant `Candidate` objects. ~~Iterator[Iterable[Iterable[Candidate]]]~~ |
## KnowledgeBase.get_vector {id="get_vector",tag="method"}