Datasets:

PiotrSty
/

slayer-ocr-experiment-evidence

Languages:

Polish

License:

Dataset card Files Files and versions

xet

Community

slayer-ocr-experiment-evidence / github-head /README.md

PiotrSty

Mark SLAYER-OCR evidence registry public (part 2)

e99e060 verified about 1 month ago

preview code

Raw History Blame Contribute Delete

36.3 kB

OCR Engine / PolOCRBench

Silnik OCR dla polskich dokumentów oraz rozwijane zaplecze PolOCRBench: publicznego benchmarku transkrypcji całych stron, ekstrakcji tabel i informacji z dokumentów. Repozytorium zawiera backendy OCR, narzędzia treningowe, ewaluatory i artefakty eksperymentów. Nie jest jeszcze ukończonym benchmarkiem ani potwierdzonym silnikiem SOTA.

Aktualny stan: 30 września 2026

SLAYER-OCR 2.0: DATA ENGINE v2

Projekt przechodzi na ścieżkę generator -> teacher ensemble -> consensus -> annotation review -> clean dataset -> RF-DETR layout -> recognizer -> hard-example mining. Architektura, granice twierdzeń i bramki.
Dane, checkpointy i dowody eksperymentalne są archiwizowane poza repozytorium kodu w publicznej kolekcji SLAYER-OCR na Hugging Face. Każda część ma manifest SHA-256 i wskazanie commita źródłowego. Raport rejestru.
Dodano deterministyczny, lokalny moduł konsensusu layoutu. Zachowuje pełne propozycje teacherów, przyjmuje wyłącznie kworum różnych modeli, kieruje konflikty do review i eksportuje zaakceptowane weak labels jako COCO JSON dla RF-DETR. To infrastruktura danych, nie wynik jakości ani deklaracja SOTA.
Gotowy prywatny pilot teacherów: uruchom notebook GPU w Colab osobno w trzech świeżych sesjach dla qwen3-vl-4b, doclayout-yolo i surya-layout2. Zacznij od domyślnych dwóch stron. Każda sesja pobiera przypięte dane i model oraz zwraca osobny ZIP dowodowy bez skanów i referencji. Dla smoke testu są też notebooki bez przełączników: DocLayout-YOLO oraz Surya Layout.
Konsensus pełnych runów: otwórz notebook v3 CPU w Colab, wgraj dokładnie trzy ZIP-y teacherów i pobierz COCO weak labels, kolejkę review, hard examples oraz pełne provenance. Polityka v3 dopuszcza maksymalnie cztery jawne abstencje teachera na 60 stronach; nie liczy ich jako pustych głosów, zachowuje quorum dwóch niezależnych modeli i kieruje każdą taką stronę do hard-example mining. Dwustronicowy smoke ujawnił konflikty klas i poziomu szczegółowości. Pełny przebieg 60 stron zakończył się technicznie poprawnie: 161 obiektów przyjęto, 371 skierowano do review, a 58/60 stron oznaczono jako hard examples. Pełna adjudykacja została zakończona: 143 obiekty review przyjęto (w tym 5 relabeli), 228 odrzucono, a clean candidate zawiera 304 obiekty na 60 stronach. Prywatny eksporter RF-DETR tworzy zweryfikowany split 48/12 bez wspólnych kolekcji i dokładnych hashy obrazów. Dane i skany nadal nie są publikowane. Raport pełnego przebiegu. Wynik smoke i decyzja.
Polityka konsensusu v3 wykrywa konflikty skali bez mnożenia głosu jednego teachera i jawnie rejestruje ograniczone abstencje. Zamrożono też definicje klas layoutu. Walidator training.adjudicate_layout_consensus odrzuca niepełne decyzje i eksportuje prywatny kandydat JSONL/COCO bez skanów. Następnie training.build_layout_rfdetr_dataset sprawdza candidate i obrazy po SHA-256, buduje rozłączny kolekcyjnie format train/valid zgodny z RF-DETR oraz zapisuje manifest, provenance i sumy kontrolne.
Następny run: otwórz przypięty trening RF-DETR Small w Colab, wybierz GPU, uruchom wszystko i wgraj prywatny ZIP przygotowany przez eksporter. Notebook sprawdza hash całego ZIP-a i wszystkich plików, nie publikuje danych, zapisuje metryki per klasa oraz zwraca osobno ZIP dowodowy i ZIP modelu. Wynik jest pilotem deweloperskim, nie pomiarem końcowym.
Wynik pilota RF-DETR: trening zakończył się early stopping po epoce 30, a najlepszy checkpoint EMA z epoki 15 osiągnął mAP@50:95 = 0,3273 na 12 stronach z czterech rozłącznych kolekcji. Najmocniejsza jest klasa figure (EMA AP = 0,8238); table i marginalia pozostają słabe, a trzy klasy nie mają przykładów validation. Checkpoint przechodzi bramkę techniczną, ale jeszcze nie jakościową. Pełny raport.
Audyt najlepszego checkpointu: otwórz prywatny audyt RF-DETR w Colab, wybierz GPU i uruchom wszystko. Notebook prosi osobno o ZIP danych, modelu i dowodów treningowych, sprawdza ich pełne hashe, ponownie mierzy zapisany checkpoint na 12 stronach oraz pobiera jeden prywatny ZIP z predykcjami, porównaniami GT/model i kolejką hard examples. Niczego nie publikuje. Audyt został ukończony: checkpoint dokładnie odtwarza mAP@50:95 = 0,3273, ale przy progu diagnostycznym 0,25 wszystkie 12 stron zawiera FP lub FN. Nakładki ujawniły także niespójną granulację ramek i prawdopodobne braki GT, dlatego kolejną bramką jest ponowna adjudykacja 12 stron, a nie retrening na tych samych etykietach. Wynik audytu.
Prywatna adjudykacja GT: python -m training.build_rfdetr_layout_adjudication --dataset-archive <private-dataset.zip> --audit-archive <private-audit.zip> --output-dir <private-review-dir> buduje offline editor 12 stron z warstwami oryginalnego GT i predykcji RF-DETR, edycją ramek, statusem strony oraz eksportem decyzji JSON. Obrazy, predykcje i decyzje pozostają lokalne; repo zawiera tylko generator i zamrożoną politykę anotacji.
Pełny pilot 60 stron: DocLayout-YOLO i Surya ukończyły kompletne runy bez błędów. Poprawiony Qwen v3 ukończył 56/60 stron; cztery błędy generacji są zachowane jako jawne abstencje w polityce konsensusu v3. Zachowaj istniejące ZIP-y z notebooków DocLayout-YOLO, Surya Layout. Notebook Qwen v3 ponawia odpowiedź o złym JSON-ie, zachowuje surowe odpowiedzi przy błędzie i odrzuca wadliwe ramki bez utraty całej strony. Domyślnie konsensus odrzuca niekompletny run; zamrożona polityka v3 dopuszcza wyłącznie cztery udokumentowane abstencje bez detekcji. Przed pobraniem notebook sprawdza commit, a wynik nazywa qwen3-vl-4b-evidence-v3.zip. Notebooki są zablokowane na właściwym teacherze i PAGES = 60; ZIP zapisuje przypięty commit kodu i nie zawiera skanów ani tekstu referencyjnego.
Zamrożona konfiguracja pilota znajduje się w experiments/2026-09-28/slayer-layout-teacher-pilot-v1/config.json. Wykonano smoke oraz pełny prywatny przebieg 60 stron. Obrazy, predykcje i wynik konsensusu pozostają prywatne do czasu osobnej decyzji publikacyjnej oraz przeglądu licencji.

Eksperymentalny model SLAYER Vision ONNX

Paczka IR9/opset 18 przechodzi pełną statyczną walidację trzech grafów ONNX, ale nie jest jeszcze kandydatem na domyślny silnik OCR. Brakuje poprawnego tokenizera, kompletnej umowy preprocessingu i generacji oraz pomiaru CER/WER. Obecny tokens_decoded.json ma 167 tokenów z U+FFFD, więc dekodowanie przez konkatenację może psuć polskie znaki. Audyt i bramka integracji.
Gotowy test wykonawczy: uruchom dwie zamrożone strony IMPACT w Colab. Notebook używa przypiętych rewizji modelu, tokenizera, SigLIP i danych, dekoduje pełną sekwencję tokenów oraz pobiera ZIP dowodowy. To diagnostyka; dopiero wynik pokaże, czy model ma jakąkolwiek zdolność wiernej transkrypcji.
Wynik negatywny: na dwóch stronach model osiągnął CER 98,28% i WER 99,57%, generując krótkie podpisy zamiast transkrypcji. Checkpoint nie będzie rozwijany jako OCR pełnych stron. Wynik, dowody i decyzja.

Google Colab (dodano 24 września)

Zakończony holdout geometrii: 12 nowych kolekcji w Colab. Dla mixed-v3 prostokąt uzyskał CER 37,9231%, a line-band 38,0092%; przedział bootstrap 95% różnicy przecina zero. Prostokąt pozostaje wariantem domyślnym, a strojenie geometrii na tej próbie jest zamknięte. Zweryfikowany wynik i decyzja.
Następny etap: przegląd 45 znaków prywatnego alfabetu na skanach oraz trening recognizera dla historycznego druku. Starej pisowni, w tym á i ſ, nie modernizujemy; pozostaje częścią podstawowej metryki.
Gotowy korpus pilota recognizera: 258 linii train i 139 validation z rozłącznych kolekcji; linie z PUA/U+FFFD są w kwarantannie. Konfiguracja nie używa 12 kolekcji holdoutu geometrii ani końcowego testu. Uruchom trening w Colab oraz zobacz protokół i warunki promocji.
Recognizer v1 odrzucony: historyczny CER poprawił się z 34,85% do 27,19%, lecz real-lines-v1 pogorszył się o 3,99 pp, a EHRI o 11,21 pp. Wagi nie zostały opublikowane. Wynik i następny eksperyment.
Recognizer v2 zamrożony przed treningiem: jeden test replay łączy historyczne linie wyłącznie z treningowymi splitami EHRI i syntetycznego druku; progi promocji pozostają bez zmian. Uruchom w Colab · wynik v2 · protokół v2. V2 przechodzi zamrożone progi po naprawie porównania dokładnej granicy +2 pp; wagi nie zostały opublikowane.
Pełnostronicowy A/B zamrożony: 36 niezależnych stron, jeden przebieg detektora OpenCV i identyczne cropy dla mixed-v3 oraz prywatnego recognizera v2. Uruchom w Colab · protokół · wynik. V2 poprawił WER o 0,6480 pp, ale pogorszył główny CER o 0,6353 pp i nie przeszedł zamrożonych bramek. Mixed-v3 pozostaje domyślnym recognizerem całej strony.
Zakończony development kolejności czytania: 15 publicznych stron validation, jeden przebieg detektora i recognizera oraz trzy porządki tych samych linii: obecny row-major, automatyczny column-aware i diagnostyczny PAGE XML oracle. Uruchom w Colab · zamrożony protokół · wynik. Column-aware zmienił kolejność na 6 stronach, ale CER i WER pozostały identyczne; PAGE XML oracle także nie pomógł. Row-major pozostaje domyślny, a następnym celem jest geometria detekcji. Końcowe 36 stron nie uczestniczyło w wyborze.
Zakończony eksperyment: granice wierszy i interpunkcja w Colab. 33 nowe wycinki i 30 niezmienionych; automatyczne pobieranie pełnej paczki, kontrola wersji bibliotek i ZIP wyników. Metoda. Mixed-v3: CER 29,40% wobec 29,44% poprzednio, tylko jeden błąd mniej. Brak podstaw do zmiany wariantu domyślnego. Wynik i ograniczenia. Następny krok: osobna próbka walidacyjna, bez dalszego strojenia na tych 63 liniach.
Poprzedni eksperyment: porównanie automatycznych ramek na 63 liniach. 31 propozycji nowych wycinków i 32 jawne powroty do oryginału; obie wersje porównywane na tych samych referencjach. Metoda i ograniczenia. Mixed-v3: CER 31,64% → 29,44%, ale 9 regresji; robocze referencje, nie benchmark. Zweryfikowany wynik i audyt.
Otwórz test 63 linii w Colab.
Otwórz kontrolę geometrii A/B w Colab.

Wybierz środowisko GPU i uruchom wszystkie komórki. Dane są pobierane automatycznie lub osadzone; nie dodawaj osobnego datasetu. Ostatnia komórka pobiera ZIP wyników, który pozostaje też w /content. Zachowano modele, dane i metryki z Kaggle, w tym historyczną pisownię. To diagnostyka, nie trening. Wersje Colab sprawdzono lokalnie testami struktury i metryk; inferencja GPU wymaga uruchomienia w Colab.

Dane i ewaluacja

Podzadanie A, transkrypcja: zamrożony historyczny podzbiór IMPACT, 36 stron testowych z 3 kolekcji oraz pula 2531 regionów treningowych.
Odtwarzalne dane: importer przypiętej paczki Hugging Face sprawdza SHA-256, rozdzielenie kolekcji i brak wspólnych hashy obrazów train/test. Osobne kopie PNG zachowują piksele oryginalnych TIFF-ów i mają przenośne ścieżki.
Ewaluator v1.1: CER/WER oraz przybliżona ocena struktury Markdown; brakujące i błędne odpowiedzi dostają zero punktów za strukturę.
Baseline CPU: zapisane predykcje wszystkich stron, metadane silnika, hashe wag, wyniki obu protokołów i sumy kontrolne artefaktów.
Weryfikacja: 17 testów importera, konwertera i ewaluatorów przeszło. To testy tego zakresu zmian, nie deklaracja uruchomienia całego zestawu testów.

Wynik baseline'u CPU

Tesseract.js 7.0.0, pol+eng, OEM 1, PSM 3, jeden worker CPU:

Zbiór	Strony	CER micro	WER micro
IMPACT historyczny, całość	36	34,94%	81,23%
NA2_FT	15	27,35%	73,22%
Nowiny_z_Rakuz_FT	15	43,93%	87,78%
Powodzenia_FT	6	34,83%	87,94%

Niższe CER/WER oznacza mniej błędów. Odczyt trwał 392,10 s; wszystkie strony zwróciły tekst, ale nie oznacza to poprawnej transkrypcji. Jest to nowy pomiar, a nie odtworzenie wcześniejszej konfiguracji natywnego Tesseract pol tessdata_best.

Ograniczenie referencji: 86 znaków zastępczych U+FFFD na 23 stronach oraz 624 znaki prywatnego zakresu Unicode na 33 stronach wymagają przeglądu adnotacji. Zamrożonych referencji nie poprawiano na podstawie predykcji. Sam brak wspólnych hashy nie wyklucza podobnych skanów ani obecności dokumentów w pretreningu modeli.

Wyniki, surowe predykcje i metadane
Odtworzenie benchmarku i baseline'u
Zmiany protokołu ewaluacji
Zamrożone manifesty PolOCRBench
Lokalny panel audytu adnotacji: skan obok transkrypcji, kolejka podejrzanych znaków i eksport historii propozycji zmian. Panel nie modyfikuje zamrożonych referencji.
Uzgadnianie recenzji i nowa wersja manifestu: zgodność dwóch recenzentów, raport konfliktów oraz pełna historia zmian. Wynik jest kandydatem do wydania, bez automatycznej publikacji.
Runner Krakena na GPU i walidator zgłoszeń A: jawne hashe obu modeli, predykcje każdej strony i metadane środowiska. Test CUDA na Kaggle Tesla T4 zakończył się: 36/36 stron, bez błędów wykonania.
Notebook Kaggle: odtwarzalny baseline Krakena: włącz Internet i GPU T4, uruchom Run All, pobierz ZIP wyników. Notebook wykonuje smoke-test jednej strony przed pełnym pomiarem 36 stron; nie trenuje modelu.

Wynik Krakena i diagnostyka GPU

Kraken 7.1.1 z recognizerem i segmenterem fine-tunowanymi na EHRI osiągnął CER 79,56% / WER 107,61%, wobec 34,94% / 81,23% dla Tesseracta. Referencje i hashe zdekodowanych pikseli są zgodne między przebiegami. WER może przekraczać 100% przez nadmiarowe słowa. To wynik konkretnej konfiguracji, nie ocena wszystkich modeli Krakena.

Raport przebiegu Kaggle.
Diagnoza segmentacji i wycinków.
Kontrola wejścia recognizera i alfabetu.
Notebook diagnostyczny v2 oraz pełny kod komórki: uruchom kod jako jedną nową komórkę w tej samej sesji Kaggle po zakończonym baseline. Nie uruchamiaj ponownie Run All. Wymagane są zachowane obrazy i wyniki w /kaggle/working/polocrbench-kraken-*/. Wynik: kraken-input-check-*.zip.

Diagnostyka trzech stron tytułowych potwierdza błędy segmentacji i rozpoznawania. 175 rzeczywistych wycinków zgadza się z wcześniejszym eksportem; sprawdzone podglądy po normalizacji zachowują czytelny tekst. Alfabet modelu nie obejmuje części znaków historycznego druku. Nie wykluczono problemów checkpointu ani całej ścieżki inferencji. Poniższa kontrola EHRI osłabia hipotezę globalnie uszkodzonego checkpointu, ale nie dowodzi poprawności wszystkich konfiguracji.

Kontrole EHRI i historycznego druku

EHRI, jedna strona: CER 2,81% z geometrią ALTO i 7,60% z przewidywaną segmentacją. Możliwe nakładanie z treningiem lub walidacją; to kontrola działania, nie niezależny benchmark. Raport i notebook.
TrOCR, 15 regionów deweloperskich: Microsoft base-printed uzyskał CER 69,41%, a PiotrSty mixed-v3 23,42%. Duża część różnicy wynika z wielkości liter: dodatkowy pomiar po zamianie na małe litery daje odpowiednio 25,95% i 20,25%. Podstawowych wyników nie zastępujemy tym pomiarem diagnostycznym. Raport, instrukcja i notebook Kaggle.

Próbka druku obejmuje głównie nagłówki z trzech stron; referencje zawierają problematyczne znaki Unicode. Wyników regionów nie porównujemy bezpośrednio z benchmarkiem całych stron. Następny krok: większy zestaw deweloperski zwykłych wierszy tekstu, ze sprawdzoną geometrią i transkrypcjami oraz podziałem na dokumenty. Zamrożony test pozostaje poza doborem modeli i treningiem.

Przygotowanie przeglądu zwykłego tekstu: lokalna próbka 19 regionów z 10 stron zawiera 96 wierszy referencyjnych. Powstały 63 niezweryfikowane propozycje wycinków; 8 regionów wymaga ręcznego podziału. To materiał do przeglądu adnotacji, jeszcze nie nowy zbiór do ewaluacji.

Lokalne próby gazet

training/sample_us_pd_newspapers.py: mała próbka tekstowego datasetu, zachowanie surowego OCR, diagnostyka Unicode i pochodzenie danych.
training/probe_newspaper_correction.py: ograniczona próba dwóch stron przez OpenRouter, domyślnie dry-run; wykonanie wymaga --execute i klucza. Używa płatnego modelu openai/gpt-4o-mini, nie wariantu :free.
training/segment_newspaper_columns.py: podział według ręcznie określonych granic kolumn, wycinki bez zmiany pikseli i diagnostyka separatorów OpenCV. Nie jest automatyczną segmentacją artykułów.

Lokalne skany, wycinki i odpowiedzi API pozostają poza repozytorium (data/).

Zakres docelowy

Podzadania: A transkrypcja do Markdown, B tabele do HTML z oceną TEDS, C pola dokumentu do JSON z oceną field-level F1. Ewaluatory A/B/C, wynik zbiorczy, format zgłoszeń zgodny z AmuEval (out.tsv) oraz walidacja deklaracji tracków (constrained, open, zero-shot/API) są zaimplementowane — zobacz protokół ewaluacji i zamrożony prompt tracku zero-shot. Dalszej pracy wymagają: zbiory podzadania B/C (współczesne dokumenty, pismo ręczne, pełne strony z tabelami i polami) wraz z anotacją, ukryty Test B oraz publiczny leaderboard. Zaimplementowane miary nie są jeszcze zwalidowane jako ostateczne metryki rankingowe.

Podzadania B/C, wynik zbiorczy i tracki

python -m training.table_eval --manifest tables.jsonl --predictions run-b.jsonl --output b.json
python -m training.kie_eval --manifest kie.jsonl --predictions run-c.jsonl --output c.json   # --dump-schemas wypisuje schemat
python -m training.composite_score --report-a a.json --report-b b.json --report-c c.json --output composite.json
python -m training.submission_tsv --mode pack --subtask A --in-tsv in.tsv --predictions run.jsonl --out-tsv out.tsv
python -m training.validate_submission --manifest M.jsonl --predictions run.jsonl --subtask C --meta submission_meta.json

Wynik zbiorczy to średnia znormalizowanych wyników zgłoszonych podzadań (1 − CER, TEDS, F1); testy normalizacji i miar: tests/test_table_eval.py, tests/test_kie_eval.py, tests/test_composite_score.py, tests/test_submission_tsv.py. Baseline'y (Surya 2, Qwen-VL na Kaggle, model API z promptem zero-shot v1) i raport kosztów per strona: docs/POLLOCR_BASELINES_BC.md — pierwszy pomiar gpt-4o-mini na 4 stronach syntetycznych: composite 0,781. Podziały train/test A/Test B, bramka integralności (training/check_split_integrity.py) i wykryty nakład tekstu train↔testA: docs/POLLOCR_SPLIT_POLICY.md. Wydanie zbioru (HuggingFace + pakiety AmuEval + stub leaderboardu): docs/POLLOCR_RELEASE.md, budowniczy training/build_release.py, strona tools/leaderboard/index.html.

Generator dokumentów syntetycznych (A+B+C)

python -m training.generate_documents --output data/polocrbench-synth-v1 --count 1200 --seed 20260922 --split train

Generuje strony faktur, umów, pism urzędowych i formularzy z kompletnym ground truth dla trzech podzadań naraz (manifest-A/B/C.jsonl): transkrypcja Markdown, HTML-e tabel (z colspan) i pola KIE zgodne ze schematami training.kie_eval.SCHEMAS. Szablony treści (training/document_templates.py) są czyste i deterministyczne (NIP/PESEL z poprawnymi sumami kontrolnymi, kwoty spójne arytmetycznie z pozycjami); degradacje: clean, scan, photo, print_scan, compress, z parametrami w generation.json. Test B może wstrzymać typy i degradacje przez --types/--degradations. Ten sam seed odtwarza identyczne pliki. Testy: tests/test_generate_documents.py (m.in. samopunktacja wygenerowanego zbioru przez wszystkie ewaluatory = 1.0).

Biblioteka OCR

Aktualizacja po audycie (2026-09-12): zobacz plan CPU i zdalnych testów. CLI respektuje ENV, a jawne flagi mają pierwszeństwo. Tablice wejściowe muszą być RGB uint8. Wyniki zawierają źródłowy numer strony i geometrię po odwrotnym mapowaniu deskew. Korekta zachowuje raw_text/raw_confidence; zmieniony tekst nie dziedziczy pewności OCR. Niestandardowe checkpointy Paddle są odrzucane, dopóki nie ma ich jawnej integracji.

Pierwsze pomiary CPU i Fabryki: Tesseract stanowi osobny baseline; na małym teście korekta tekstowa zwiększała łączny CER. Wyniki nie są potwierdzeniem SOTA. Ucięte odpowiedzi korektora są odrzucane.

Silnik OCR w Pythonie: detekcja linii (CRAFT lub OpenCV) + TrOCR (rozpoznawanie), z wsparciem języków PL/EN, routingiem języka per linia i korektą tekstu przez Fabryka API (Bielik).

Architektura

obraz → preprocess (deskew) → detekcja linii → routing języka (PL/EN)
      → TrOCR (rozpoznawanie) → [korekta przez Fabryka/Bielik] → OcrResult

Detekcja: auto-wybór — CRAFT (craft-text-detector) gdy dostępny, w przeciwnym razie fallback OpenCV (morfologia + kontury; ocr/opencv_detector.py).
Rozpoznawanie: TrOCR (microsoft/trocr-base-printed dla EN; lokalny fine-tune QLoRA dla PL). Opcjonalnie Kraken (baseline segmentation + .mlmodel) dla maszynopisów/historycznych.
Korekta tekstu: Fabryka AI — Bielik (polski LLM) naprawia błędy OCR (diakrytyki, pocięte słowa, interpunkcja). Opcjonalna, wymaga klucza API.
Routing języka: heurystyka polskich diakrytyków + langdetect. Bez force_language linie idą najpierw modelem EN, a te wykryte jako PL są re-rozpoznawane modelem PL w drugim przebiegu (gdy model PL istnieje).
Porządek czytania: grupowanie linii w poziome pasy (top→bottom), wewnątrz left→right.

Uwaga PL: oficjalne modele TrOCR są tylko angielskie. Polskie diakrytyki wymagają fine-tunu — patrz training/README.md (QLoRA, wg wskazówek Slayer). Alternatywa bez treningu: włączyć korektę tekstu przez Fabryka API (Bielik) — patrz niżej.

Instalacja

pip install -e .
# dev (testy):
pip install -e ".[dev]"
# detektor CRAFT (wymaga Py <3.11 — stary pin opencv):
pip install -e ".[craft]"
# korekta przez Fabryka API:
pip install -e ".[correct]"
# backend Kraken (historyczne dokumenty / maszynopis):
pip install -e ".[kraken]"
# trening PL (GPU):
pip install -e ".[train]"

Bez craft-text-detector działa automatyczny detektor OpenCV — wystarczy do dokumentów i skanów na jasnym tle.

Użycie

Biblioteka

from ocr import recognize, OcrEngine, OcrConfig

# jednorazowo
result = recognize("dokument.png")
print(result.text)
for line in result.lines:
    print(line.text, line.bbox, line.language, line.confidence)

# wiele obrazów (współdzielenie modeli)
with OcrEngine(OcrConfig(force_language="pl")) as engine:
    for path in paths:
        print(engine.recognize(path).text)

# PDF — lista wyników per strona
with OcrEngine() as engine:
    pages = engine.recognize_pdf("dokument.pdf", pages="1-3", dpi=300)
    for i, page in enumerate(pages, 1):
        print(f"--- strona {i} ---\n{page.text}")

CLI

ocr recognize dokument.png                 # tekst
ocr recognize dokument.png --lang pl --json # JSON z bboxami
ocr recognize dokument.pdf                  # PDF — wszystkie strony
ocr recognize dokument.pdf --pages 1-3,5    # wybrane strony
ocr recognize dokument.png --correct        # korekta tekstu przez Fabryka/Bielik
ocr recognize dokument.png --no-deskew
ocr recognize dokument.png --device cpu
ocr check-fabryka                           # sprawdź połączenie z Fabryka API

Korekta tekstu przez Fabryka API (Bielik)

Korekta naprawia typowe błędy OCR (zamiana diakrytyków ą→a, ł→l, ę→e, pocięte słowa) przy użyciu polskiego modelu LLM Bielik przez Fabryka AI.

Endpoint jest wybierany automatycznie na podstawie prefixu klucza:

fab_live_... → https://fabryka.ai/v1 (lab)
sk-fab-... → https://router.fabryka.ai/v1 (router)

# 1. Pobierz klucz API z https://fabryka.ai (sekcja "Get API key")
# 2. Ustaw zmienną środowiskową:
export FABRYKA_API_KEY=fab_live_...   # lub sk-fab-...

# 3. Sprawdź połączenie:
ocr check-fabryka

# 4. Rozpoznaj z korektą:
ocr recognize dokument.png --correct

Lub w Pythonie:

from ocr import OcrEngine, OcrConfig

config = OcrConfig(correct_text=True)  # wymaga FABRYKA_API_KEY w env
with OcrEngine(config) as engine:
    result = engine.recognize("dokument.png")
    print(result.text)  # tekst po korekcie

Wymaga: pip install ocr-engine[correct] (pakiet openai). Brak klucza → korekta pominięta z ostrzeżeniem (graceful degradation). Błąd API → zwraca oryginalny tekst z retry (429/502/503/504 z exponential backoff).

Próg pewności (confidence)

Każda linia ma confidence ∈ [0,1] z rozpoznawania TrOCR. Próg pozwala flagować niskopewne linie i ograniczyć korektę tylko do nich (oszczędność API):

# oznacz linie z confidence < 0.7 flagą "low_confidence" w JSON:
ocr recognize dokument.png --json --confidence-threshold 0.7

# korekta Fabryka TYLKO dla niskopewnych linii:
ocr recognize dokument.png --correct-low-only --confidence-threshold 0.7

W selektywnej korekcie do API trafiają wyłącznie linie poniżej progu; jeśli korektor zwróci inną liczbę linii niż wysłano, oryginał zostaje zachowany.

Konfiguracja (zmienne środowiskowe)

Zmienna	Domyślnie	Opis
`OCR_FORCE_LANGUAGE`	(auto)	`pl`/`en` — wymuś język
`OCR_CORRECT_TEXT`	`false`	`true`/`false` — włącz korektę przez Fabryka
`FABRYKA_API_KEY`	(brak)	klucz API Fabryka (https://fabryka.ai)
`FABRYKA_MODEL`	`bielik-11b-v3`	model do korekty
`FABRYKA_BASE_URL`	`auto`	`auto` lub pełny URL (np. `https://router.fabryka.ai/v1`)
`OCR_RECOGNIZER_EN`	`microsoft/trocr-base-printed`	model TrOCR EN
`OCR_RECOGNIZER_PL`	`ocr/trocr-pl-base`	lokalny fine-tune PL
`OCR_DEVICE`	`auto`	`auto`/`cpu`/`cuda`
`OCR_CONFIDENCE_THRESHOLD`	`0.0`	próg flagowania niskopewnych linii
`OCR_CORRECT_LOW_ONLY`	`false`	korekta tylko linii poniżej progu
`OCR_RECOGNIZER_BACKEND`	`trocr`	`trocr`, `paddlevl` (PaddleOCR-VL VLM), lub `kraken`
`OCR_KRAKEN_MODEL`	`PiotrSty/ehri-dataset::models/polish_nfd_9313.mlmodel`	model Kraken (.mlmodel)
`OCR_KRAKEN_BINARIZE`	`false`	`true`/`false` — binarization nlbin przed Kraken

Backend PaddleOCR-VL (opcjonalny, SOTA)

Alternatywny backend rozpoznawania: PaddleOCR-VL — model VLM 0.9B, 109 języków (w tym polski), #1 na OmniDocBench. Nie wymaga fine-tuningu ani detektora per język.

pip install -e ".[vlm]"   # paddlepaddle + paddleocr[doc-parser]

ocr recognize dokument.png --backend paddlevl
python -m training.evaluate --data ./data/pl_lines_val --backend paddlevl

Uwagi: backend VLM nie raportuje confidence (w JSON: null), rozpoznaje linie po jednej (wolniejsze na CPU). Porównanie head-to-head z TrOCR: python -m training.evaluate --data <zbiór> --backend trocr|paddlevl.

Backend Kraken (opcjonalny, historyczne dokumenty / maszynopis)

Kraken — system OCR/HTR zoptymalizowany pod dokumenty historyczne i maszynopisy. Używa trainable baseline segmentation (sieć neuronowa wykrywająca linie-bazy) oraz modeli rozpoznawania .mlmodel (CTC).

Kiedy używać: maszynopisy, dokumenty historyczne, wyblakłe skany — gdzie OpenCV+TrOCR zawodzi przez słabą segmentację. Dla czystego druku TrOCR pozostaje lepszy.

Model domyślny: polish_nfd_9313.mlmodel z EHRI (93,1% accuracy na polskim maszynopisie).

pip install -e ".[kraken]"   # kraken>=5.0

ocr recognize dokument.png --backend kraken
python -m training.evaluate --data ./data/pl_lines_val --backend kraken

Lub w Pythonie:

from ocr import OcrEngine, OcrConfig

cfg = OcrConfig(
    recognizer_backend="kraken",
    kraken_model="PiotrSty/ehri-dataset::models/polish_nfd_9313.mlmodel",
    device="cuda",
)
with OcrEngine(cfg) as engine:
    result = engine.recognize("maszynopis.tif")
    print(result.text)

Benchmark: Kraken vs OpenCV+TrOCR na polskim maszynopisie EHRI

Pełny benchmark: training/kaggle_kraken_benchmark.ipynb (Kaggle GPU T4). Zbiór: 15 polskich stron EHRI (468 linii GT z ALTO XML).

Backend	Segmentacja	CER	WER	Linie wykryte
OpenCV+TrOCR run5	OpenCV	82,42%	94,35%	179/468 (38%)
Kraken e2e	Kraken	14,25%	48,49%	467/468 (100%)
Kraken + GT (ALTO)	GT baselines	10,67%	32,93%	468/468 (100%)
Kraken e2e + deskew	Kraken	14,71%	48,89%	467/468 (100%)
Kraken + GT + binarization	GT baselines	20,26%	65,16%	468/468 (100%)

Wnioski:

Kraken jest 5,8× lepszy od OpenCV+TrOCR na maszynopisie (CER 14% vs 82%).
OpenCV gubi 62% linii na maszynopisie — segmentacja to główna blokada.
Kraken wykrywa 100% linii — segmentacja baseline działa na maszynopisie.
Binarization szkodzi — model trenowany na grayscale (CER 14% → 20%).
Deskew nie pomaga — strony EHRI są już wyrównane.
GT segmentacja poprawia CER z 14% do 11% — wytrenowanie modelu segmentacji na polskich danych mogłoby poprawić e2e.

Różnica 14% vs 7% EHRI: możliwe przyczyny to legacy polygon extractor (model nie trenowany z nową metodą), różnica wersji Kraken, oraz brak dedykowanego modelu segmentacji dla polskiego maszynopisu.

Testy

pytest

Struktura

ocr/        # biblioteka (config, preprocess, detector, recognizer, pipeline, lang, cli)
training/   # fine-tuning polskiego TrOCR (GPU)
tests/      # testy jednostkowe (nie wymagają modeli ML)

Ograniczenia / roadmapa

Fine-tune PL wymaga danych + GPU (patrz training/). Alternatywa bez treningu: korekta tekstu przez Fabryka API (Bielik) — włącz --correct.
Routing języka: bez force_language linie startują modelem EN, a wykryte jako PL są re-rozpoznawane modelem PL (drugi przebieg, gdy model istnieje). Gdy modelu PL brak — zostaje wynik EN (diakrytyki naprawia korekta Bielik).
Brak obsługi układów wielokolumnowych / tabel (sortowanie czytania uproszczone).
Detektor OpenCV (fallback) jest prostszy od CRAFT — dobry do dokumentów/skanów, słabszy do tekstu w naturze i złożonych tła. Na maszynopisach zawodzi (wykrywa 38% linii) — użyj backendu Kraken (--backend kraken).
Alternatywa bez treningu: PaddleOCR-VL + LoRA RysOCR (lepsza polska diakrytyka od ręki).

Pilot rzeczywistych skanów: wyniki i odtworzenie.

Zwykły druk i vision API: wyniki oraz przygotowany test.