From f60ee766940205169c0455f1cb73353febb2b228 Mon Sep 17 00:00:00 2001 From: dfuhrmann Date: Thu, 2 Jul 2026 08:39:46 +0000 Subject: [PATCH] README.md aktualisiert --- README.md | 47 +++++++++++++++++------------------------------ 1 file changed, 17 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index a26d278..0f9b321 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,7 @@ ## Description -Dieses Tool konvertiert Rechnungen im PDF-Format vollautomatisch in das offizielle XRechnung-XML-Format (UBL-Standard, Version 3.0). Das System verarbeitet sensible Finanzdaten vollständig lokal auf der eigenen Hardware und verzichtet auf externe Cloud-Schnittstellen. - -Die Anwendung nutzt eine Hybrid-Architektur: -* **Stammdaten (Kopfdaten):** Ein lokales Large Language Model (LLM) extrahiert unstrukturierte Metadaten wie Rechnungsnummern, Datumsangaben, Bestell-Referenzen und Kundenadressen. Die Steuerung erfolgt über eine strikte JSON-Schema-Grammatik. -* **Positionen (Tabelle):** Ein nativer Python-Algorithmus extrahiert Artikelbeschreibungen, Mengen, Einheiten und Einzelpreise über reguläre Ausdrücke (Regex). Die finale Summenberechnung erfolgt finanzmathematisch präzise über das `decimal`-Modul inklusive kaufmännischem Runden. +Dieses Tool konvertiert Rechnungen im PDF-Format vollautomatisch in das offizielle XRechnung-XML-Format (UBL-Standard, Version 3.0). Das Tool verarbeitet sensible Finanzdaten vollständig lokal. ## Supported Model @@ -16,58 +12,49 @@ Das System ist auf das folgende Modell optimiert, welches sich im Verzeichnis `m * **Format:** GGUF * **Quantisierung:** Q8_0 -Hinweis: Es muss zwingend die Instruct-Variante des Modells verwendet werden. Das Basis-Modell (Base) ist für diese Anwendung nicht kompatibel. - ## Installation ### 1. Verzeichnisstruktur vorbereiten Erstellen Sie im Projektverzeichnis den Ordner für das lokale KI-Modell: -```bash +```cmd mkdir models ``` ### 2. Virtuelle Umgebung (venv) erstellen und aktivieren -Erstellen Sie eine isolierte Python-Umgebung und aktivieren Sie diese vor der Installation der Pakete. - -**Windows (PowerShell):** -```powershell +Erstellen Sie eine isolierte Python-Umgebung und aktivieren Sie diese über die Windows-Eingabeaufforderung (CMD): +```cmd python -m venv venv -.\venv\Scripts\Activate.ps1 -``` - -**Linux / macOS:** -```bash -python -m venv venv -source venv/bin/activate +.\venv\Scripts\activate.bat ``` ### 3. Modell platzieren Laden Sie die Modelldatei `Qwen3.5-4B-Instruct-Q8_0.gguf` herunter und platzieren Sie diese im erstellten Ordner. Der Pfad muss exakt wie folgt lauten: `models/Qwen3.5-4B-Instruct-Q8_0.gguf` -### 4. Abhängigkeiten installieren -Die Datei `requirements.txt` ist im Repository enthalten. Führen Sie in der aktivierten virtuellen Umgebung den passenden Befehl aus, um die Installation mit GPU-Beschleunigung (Nvidia CUDA) durchzuführen: -**Windows (PowerShell):** -```powershell -$env:GGML_CUDA="1"; pip install -r requirements.txt --force-reinstall --no-cache-dir +### 4. Abhängigkeiten installieren + +**A: Mit GPU-Beschleunigung (Nvidia CUDA)** +```cmd +set GGML_CUDA=1 +pip install -r requirements.txt --force-reinstall --no-cache-dir ``` -**Linux / macOS:** -```bash -GGML_CUDA=1 pip install -r requirements.txt --force-reinstall --no-cache-dir +**B: Reiner CPU-Modus (Keine Nvidia-Grafikkarte vorhanden)** +```cmd +pip install -r requirements.txt --force-reinstall --no-cache-dir ``` ## Use -Starten Sie die Applikation über das Terminal: -```bash +Starten Sie die Applikation über die aktivierte Eingabeaufforderung: +```cmd streamlit run app.py ``` Der Konversionsprozess gliedert sich in folgende Schritte: 1. **Dokumenten-Upload:** Laden Sie die Rechnungs-PDF über die Weboberfläche hoch. -2. **Extraktion:** Starten Sie die hybride Analyse über den dafür vorgesehenen Button. +2. **Extraktion:** Starten Sie die Analyse über den dafür vorgesehenen Button. 3. **Validierung:** Prüfen Sie die extrahierten Kopfdaten und die Positionstabelle in der Benutzeroberfläche. Da alle Felder editierbar sind, können Korrekturen direkt vorgenommen werden. 4. **Export:** Generieren Sie die finale XML-Datei über die Export-Funktion und starten Sie den Download.