161sh/CatgirlIntelligenceAgency
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update readme.md

Browse Source
This commit is contained in:
Viktor 2023-03-22 17:09:48 +01:00 committed by GitHub
parent e3675d2fa9
commit c974d72e7e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
code/features-index/index-reverse/readme.md
View File

@ -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 flags<sup>1</sup>,
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 flags<sup>1</sup>.
* 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.
* [ReverseIndexPriorityReader](src/main/java/nu/marginalia/index/priority/ReverseIndexPriorityReader.java) interrogates the priority index.