From 638103eb1b6a05e24c0dea9eb2d925726945a738 Mon Sep 17 00:00:00 2001 From: Raphael Mitsch Date: Mon, 24 Apr 2023 21:18:13 +0200 Subject: [PATCH] Update docs. --- website/docs/api/inmemorylookupkb.mdx | 2 +- website/docs/api/kb.mdx | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/website/docs/api/inmemorylookupkb.mdx b/website/docs/api/inmemorylookupkb.mdx index e23ac4b08..f9897ab2d 100644 --- a/website/docs/api/inmemorylookupkb.mdx +++ b/website/docs/api/inmemorylookupkb.mdx @@ -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"} diff --git a/website/docs/api/kb.mdx b/website/docs/api/kb.mdx index f6c499268..141876591 100644 --- a/website/docs/api/kb.mdx +++ b/website/docs/api/kb.mdx @@ -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"}