Create readme.md

SimonEff · Mar 25, 2024 · 8627e00 · 8627e00
1 parent d945cc4
commit 8627e00
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/autotagger/readme.md b/autotagger/readme.md
@@ -0,0 +1,15 @@
+# Know how Management OLL autotagger
+## About
+* Local tagging using Spacy language model `de-core-news-lg`
+* Local search using BM25Okapi
+* Web UI using FastAPI & Uvicorn
+* PDF support via PyPDF2
+* Docx support via python-docx
+
+## Requirements
+* Python 3.12
+* `python -m pip install -r requirements.txt`
+
+## Usage
+* Preprocess documents: `python create_tags.py`
+* Run web UI: `python app.py`