Skip to content

ajkdrag/ocrtoolkit

Repository files navigation

GitHub-Pages deployment status PyPI - Version

ocrtoolkit

Versatile Python package for seamlessly integrating and experimenting with various OCR and Object Detection frameworks.

Quickstart

ocrtoolkit is available on PyPI and can be installed with pip. Supports integrations with:

$ pip install ocrtoolkit

After installing ocrtoolkit you can use it like any other Python module.

Here is a simple example:

from ocrtoolkit.models import UL_YOLOV8
from ocrtoolkit.datasets import FileDS
from ocrtoolkit.core import detect

ds = FileDS("some_images_dir")
mini_ds = ds.sample()
model = UL_YOLOV8()

l_results = detect(model, mini_ds, stream=False)

Documentation

The API Reference provides API-level documentation

Notebooks

Refer notebooks for examples on how to use the modules.