From c974d72e7e458ed1e7d1f26cd02756701d530f9f Mon Sep 17 00:00:00 2001 From: Viktor Date: Wed, 22 Mar 2023 17:09:48 +0100 Subject: [PATCH] Update readme.md --- code/features-index/index-reverse/readme.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/code/features-index/index-reverse/readme.md b/code/features-index/index-reverse/readme.md index f42307c0..5a9db1e5 100644 --- a/code/features-index/index-reverse/readme.md +++ b/code/features-index/index-reverse/readme.md @@ -2,9 +2,12 @@ The reverse index contains a mapping from word to document id. -There are two tiers of this index, one priority index which only indexes terms that are flagged with priority flags1, -and a full index that indexes all terms. The full index also provides access to term-level metadata, while the priority -index is a binary index. +There are two tiers of this index. + +* A priority index which only indexes terms that are flagged with priority flags1. +* A full index that indexes all terms. + +The full index also provides access to term-level metadata, while the priority index is a binary index that only offers information about which documents has a specific word. [1] See WordFlags in [common/model](../../common/model/) and KeywordMetadata in [features-convert/keyword-extraction](../../features-convert/keyword-extraction). @@ -14,4 +17,4 @@ KeywordMetadata in [features-convert/keyword-extraction](../../features-convert/ * [ReverseIndexFullConverter](src/main/java/nu/marginalia/index/full/ReverseIndexFullConverter.java) constructs the full index. * [ReverseIndexFullReader](src/main/java/nu/marginalia/index/full/ReverseIndexFullReader.java) interrogates the full index. * [ReverseIndexPriorityConverter](src/main/java/nu/marginalia/index/priority/ReverseIndexPriorityConverter.java) constructs the priority index. -* [ReverseIndexPriorityReader](src/main/java/nu/marginalia/index/priority/ReverseIndexPriorityReader.java) interrogates the priority index. \ No newline at end of file +* [ReverseIndexPriorityReader](src/main/java/nu/marginalia/index/priority/ReverseIndexPriorityReader.java) interrogates the priority index.