docreader-ocr 0.2.4__tar.gz → 0.2.5__tar.gz

docreader_ocr-0.2.5/PKG-INFO

@@ -0,0 +1,69 @@
+Metadata-Version: 2.4
+Name: docreader-ocr
+Version: 0.2.5
+Summary: Document OCR pipeline: classify → detect fields → recognize text
+Project-URL: Homepage, https://github.com/mishanyacorleone/docreader
+Project-URL: Repository, https://github.com/mishanyacorleone/docreader
+Project-URL: Issues, https://github.com/mishanyacorleone/docreader/issues
+Author-email: Mikhail Kardash <mishutqac@mail.ru>, Ruslan Abzelilov <ruslanr26@mail.ru>, Ekaterina Karmanova <monitor81@mail.ru>
+License: MIT
+License-File: LICENSE
+Keywords: document,ocr,recognition,yolo
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Image Recognition
+Requires-Python: >=3.9
+Requires-Dist: easyocr>=1.7
+Requires-Dist: numpy>=1.24
+Requires-Dist: opencv-python>=4.8
+Requires-Dist: rapidfuzz>=3.14.0
+Requires-Dist: requests>=2.28
+Requires-Dist: torch>=2.0
+Requires-Dist: torchvision>=0.15
+Requires-Dist: tqdm>=4.65
+Requires-Dist: ultralytics>=8.0
+Provides-Extra: dev
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# docreader-ocr
+
+Python-библиотека для автоматического распознавания российских документов.
+
+```python
+from docreader import DocReader
+
+result = DocReader().process("passport.jpg")
+print(result.documents[0].fields)
+# {"surname": "Иванов", "firstname": "Иван", "passport_num": "1234 567890", ...}
+```
+
+## Установка
+
+```bash
+pip install docreader-ocr
+```
+
+Модели скачиваются автоматически при первом запуске.
+
+## Поддерживаемые документы
+
+- Паспорт РФ
+- СНИЛС
+- Аттестат об образовании
+- Диплом о высшем образовании
+
+## Как работает
+
+Трёхэтапный конвейер: **классификатор** (YOLO OBB, accuracy 97.5%) определяет тип документа → **детектор зон** (YOLO OBB, mAP@50 = 90%) находит поля → **OCR** (EasyOCR, word accuracy 87.3%) распознаёт текст.
+
+Данные обрабатываются локально — никаких внешних серверов, полное соответствие 152-ФЗ.
+
+## Документация
+
+Полный README, примеры и API — на [GitHub](https://github.com/mishanyacorleone/docreader).

docreader_ocr-0.2.5/README.md

@@ -0,0 +1,292 @@
+# docreader-ocr
+
+[![PyPI version](https://img.shields.io/pypi/v/docreader-ocr.svg)](https://pypi.org/project/docreader-ocr/)
+[![Python](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
+[![GitHub stars](https://img.shields.io/github/stars/mishanyacorleone/docreader.svg)](https://github.com/mishanyacorleone/docreader/stargazers)
+
+Python-библиотека для автоматического распознавания российских документов. Сфотографировал — получил структурированные данные.
+
+```python
+from docreader import DocReader
+
+result = DocReader().process("passport.jpg")
+print(result.documents[0].fields)
+# {"surname": "Иванов", "firstname": "Иван", "passport_num": "1234 567890", ...}
+```
+
+---
+
+## Поддерживаемые документы
+
+| Документ | Распознаваемые поля |
+|----------|---------------------|
+| Паспорт РФ | surname, firstname, middlename, dateOfBirth, birthCity, sex, passport_num, issued_by, issued_date, issued_code |
+| СНИЛС | fio, snils, date_of_birth, sex, location, reg_date |
+| Аттестат | fio, lvl, number, issue_date, grad_year, school_name, gerb |
+| Диплом | fio, lvl, series_numbers, reg_num, issue_date, spec_name, university_name, gerb, stamp |
+
+---
+
+## Установка
+
+```bash
+pip install docreader-ocr
+```
+
+Модели скачиваются автоматически при первом запуске и кэшируются в `~/.cache/docreader/models/`.
+
+### Требования
+
+- Python 3.12+
+- PyTorch (CPU или CUDA)
+- ~200 МБ дискового пространства для моделей
+
+---
+
+## Быстрый старт
+
+### Базовое использование
+
+```python
+from docreader import DocReader
+
+reader = DocReader()
+result = reader.process("photo.jpg")
+
+for doc in result.documents:
+    print(f"Тип: {doc.doc_type}")
+    print(f"Поля: {doc.fields}")
+```
+
+### Пакетная обработка
+
+```python
+results = reader.process_batch(["doc1.jpg", "doc2.jpg", "doc3.jpg"])
+
+for page in results:
+    for doc in page.documents:
+        print(doc.fields)
+```
+
+### Использование numpy array
+
+```python
+import cv2
+from docreader import DocReader
+
+image = cv2.imread("passport.jpg")
+result = DocReader().process(image)
+```
+
+### Получение кропов зон
+
+```python
+result = DocReader().process("passport.jpg", return_crops=True)
+
+for doc in result.documents:
+    for zone in doc.zones:
+        print(f"{zone.name}: {zone.text}")
+        # zone.crop_image — numpy array с вырезанной зоной
+```
+
+### Использование GPU
+
+```python
+from docreader import DocReader
+from docreader.config import PipelineConfig
+
+config = PipelineConfig(device="cuda")
+reader = DocReader(config=config)
+```
+
+---
+
+## Архитектура
+
+Библиотека реализует трёхэтапный конвейер:
+
+```
+Фото → [Классификатор] → [Детектор зон] → [OCR] → Словарь полей
+         YOLO OBB          YOLO OBB          EasyOCR
+         97.5% acc         mAP@50=90%        CER=0.15
+```
+
+**Классификатор** — определяет тип документа и вырезает его из произвольной фотографии. Работает при любом освещении и ракурсе.
+
+**Детектор зон** — специализированная YOLO OBB модель для каждого типа документа. Находит поля с точностью mAP@50 = 90%.
+
+**OCR-движок** — EasyOCR с кастомным дообучением под русскоязычные документы. Структурированные поля (числа, даты, коды) — Exact Match 85–92%.
+
+### Resolver для аттестата/диплома
+
+Аттестат и диплом визуально идентичны, поэтому их различение вынесено в отдельный компонент — `LvlSubtypeResolver`. Он детектирует поле `lvl`, читает его через OCR и с помощью fuzzy matching определяет подтип документа.
+
+---
+
+## Метрики качества
+
+### Классификатор
+
+| Класс | Precision | Recall | F1 |
+|-------|-----------|--------|----|
+| passport | 0.968 | 1.000 | 0.984 |
+| snils | 1.000 | 0.903 | 0.949 |
+| attestat | 1.000 | 1.000 | 1.000 |
+| diplom | 1.000 | 1.000 | 1.000 |
+| **Общая точность** | | | **97.5%** |
+
+### Детектор зон
+
+| Метрика | Значение |
+|---------|----------|
+| mAP@50 | 90.0% |
+| Лучшая зона (gerb) | F1 = 99.1% |
+| Слабейшая зона (location) | F1 = 82.5% |
+
+### OCR
+
+| Метрика | Значение |
+|---------|----------|
+| CER средний | 0.146 |
+| WER средний | 0.276 |
+| Exact Match средний | 58.8% |
+| Exact Match (series_numbers) | 92.3% |
+| Exact Match (fio) | 88.4% |
+
+---
+
+## Кастомизация
+
+### Своя конфигурация
+
+```python
+from docreader import DocReader
+from docreader.config import PipelineConfig
+
+config = PipelineConfig(
+    device="cuda",
+    classifier_confidence=0.5,
+    detector_confidence=0.3,
+    enable_deskew=True,
+    return_crops=False,
+    skip_ocr_zones={"stamp", "gerb"},
+)
+reader = DocReader(config=config)
+```
+
+### Использование отдельных компонентов
+
+```python
+from docreader.factory import create_classifier, create_detector, create_ocr
+
+# Только классификатор
+clf = create_classifier()
+docs = clf.classify("photo.jpg")
+
+# Только детектор
+det = create_detector()
+zones = det.detect(image, doc_type="passport")
+
+# Только OCR
+ocr = create_ocr()
+result = ocr.recognize(crop_image)
+print(result.text, result.confidence)
+```
+
+### Подключение своего OCR-движка
+
+```python
+from docreader.ocr.base import BaseOcrEngine, OcrResult
+import numpy as np
+
+class MyOcrEngine(BaseOcrEngine):
+    def recognize(self, image: np.ndarray) -> OcrResult:
+        # ваша реализация
+        return OcrResult(text="...", confidence=0.95)
+
+reader = DocReader(ocr_engine=MyOcrEngine())
+```
+
+### Добавление нового типа документа
+
+```python
+from docreader.config import PipelineConfig
+
+config = PipelineConfig(
+    detector_weights={
+        "passport":  "passport.pt",
+        "snils":     "snils.pt",
+        "attestat":  "attestat.pt",
+        "diplom":    "diplom.pt",
+        "inn":       "/path/to/your/inn.pt",  # ваша модель
+    }
+)
+reader = DocReader(config=config)
+```
+
+---
+
+## Структура результата
+
+```python
+PageResult
+└── documents: list[DocumentResult]
+    ├── doc_type: str          # "passport", "snils", "attestat", "diplom"
+    ├── doc_confidence: float  # уверенность классификатора
+    ├── doc_bbox: list[float]  # координаты документа в исходном изображении
+    ├── doc_crop: np.ndarray   # вырезанный документ (если return_crops=True)
+    ├── fields: dict           # {zone_name: text} — удобный доступ к полям
+    ├── resolve_meta: dict     # диагностика resolver'а (для attestat/diplom)
+    └── zones: list[ZoneResult]
+        ├── name: str
+        ├── text: str
+        ├── confidence: float
+        ├── bbox: list[float]
+        └── crop_image: np.ndarray  # если return_crops=True
+```
+
+---
+
+## Управление моделями
+
+```python
+from docreader.hub import get_model_status, ensure_all_models
+
+# Статус всех моделей
+status = get_model_status()
+for name, info in status.items():
+    print(f"{name}: {'✓' if info['downloaded'] else '✗'} ({info['size_mb']} MB)")
+
+# Скачать все модели заранее
+ensure_all_models()
+
+# Кастомная директория кэша
+import os
+os.environ["DOCREADER_CACHE"] = "/path/to/custom/cache"
+```
+
+---
+
+## Почему библиотека, а не сервис
+
+**Данные остаются внутри.** Персональные данные не покидают инфраструктуру организации. Полное соответствие 152-ФЗ. Никаких внешних серверов.
+
+**Интеграция без переписывания.** Встраивается в любую существующую систему — 1С, CRM, ERP, мобильное приложение — двумя строками кода.
+
+**Полный контроль.** Новые типы документов подключаются через дообучение без участия вендора. IT-отдел контролирует всё: модели, данные, обновления.
+
+**Нет операционных затрат.** В отличие от облачных API — никакой абонентской платы и лимитов на количество запросов.
+
+---
+
+## Лицензия
+
+MIT License — см. [LICENSE](LICENSE).
+
+---
+
+## Ссылки
+
+- [PyPI](https://pypi.org/project/docreader-ocr/)
+- [GitHub](https://github.com/mishanyacorleone/docreader)

docreader_ocr-0.2.5/README_pypi.md

@@ -0,0 +1,36 @@
+# docreader-ocr
+
+Python-библиотека для автоматического распознавания российских документов.
+
+```python
+from docreader import DocReader
+
+result = DocReader().process("passport.jpg")
+print(result.documents[0].fields)
+# {"surname": "Иванов", "firstname": "Иван", "passport_num": "1234 567890", ...}
+```
+
+## Установка
+
+```bash
+pip install docreader-ocr
+```
+
+Модели скачиваются автоматически при первом запуске.
+
+## Поддерживаемые документы
+
+- Паспорт РФ
+- СНИЛС
+- Аттестат об образовании
+- Диплом о высшем образовании
+
+## Как работает
+
+Трёхэтапный конвейер: **классификатор** (YOLO OBB, accuracy 97.5%) определяет тип документа → **детектор зон** (YOLO OBB, mAP@50 = 90%) находит поля → **OCR** (EasyOCR, word accuracy 87.3%) распознаёт текст.
+
+Данные обрабатываются локально — никаких внешних серверов, полное соответствие 152-ФЗ.
+
+## Документация
+
+Полный README, примеры и API — на [GitHub](https://github.com/mishanyacorleone/docreader).

{docreader_ocr-0.2.4 → docreader_ocr-0.2.5}/pyproject.toml

@@ -4,9 +4,9 @@ build-backend = "hatchling.build"
 
 [project]
 name = "docreader-ocr"
-version = "0.2.4"
+version = "0.2.5"
 description = "Document OCR pipeline: classify → detect fields → recognize text"
-readme = "README.md"
+readme = "README_pypi.md"
 license = {text = "MIT"}
 requires-python = ">=3.9"
 authors = [

docreader_ocr-0.2.4/PKG-INFO

@@ -1,34 +0,0 @@
-Metadata-Version: 2.4
-Name: docreader-ocr
-Version: 0.2.4
-Summary: Document OCR pipeline: classify → detect fields → recognize text
-Project-URL: Homepage, https://github.com/mishanyacorleone/docreader
-Project-URL: Repository, https://github.com/mishanyacorleone/docreader
-Project-URL: Issues, https://github.com/mishanyacorleone/docreader/issues
-Author-email: Mikhail Kardash <mishutqac@mail.ru>, Ruslan Abzelilov <ruslanr26@mail.ru>, Ekaterina Karmanova <monitor81@mail.ru>
-License: MIT
-License-File: LICENSE
-Keywords: document,ocr,recognition,yolo
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Topic :: Scientific/Engineering :: Image Recognition
-Requires-Python: >=3.9
-Requires-Dist: easyocr>=1.7
-Requires-Dist: numpy>=1.24
-Requires-Dist: opencv-python>=4.8
-Requires-Dist: rapidfuzz>=3.14.0
-Requires-Dist: requests>=2.28
-Requires-Dist: torch>=2.0
-Requires-Dist: torchvision>=0.15
-Requires-Dist: tqdm>=4.65
-Requires-Dist: ultralytics>=8.0
-Provides-Extra: dev
-Requires-Dist: mypy; extra == 'dev'
-Requires-Dist: pytest-cov; extra == 'dev'
-Requires-Dist: pytest>=7.0; extra == 'dev'
-Requires-Dist: ruff; extra == 'dev'
-Description-Content-Type: text/markdown
-
-Заглушка

docreader_ocr-0.2.4/README.md

@@ -1 +0,0 @@
-Заглушка