Sinapsis EasyOCR

EasyOCR-based Optical Character Recognition (OCR) for images

🐍 Installation • 🚀 Features • 📚 Usage example • 🌐 Webapp • 📙 Documentation • 🔍 License

Sinapsis EasyOCR provides a powerful and flexible implementation for extracting text from images using the EasyOCR engine. It enables users to easily configure and run OCR tasks with minimal setup.

🐍 Installation

Install using your package manager of choice. We encourage the use of uv

Example with uv:

  uv pip install sinapsis-easyocr --extra-index-url https://pypi.sinapsis.tech

or with raw pip:

  pip install sinapsis-easyocr --extra-index-url https://pypi.sinapsis.tech

[!IMPORTANT] Templates may require extra dependencies. For development, we recommend installing the package with all the optional dependencies:

with uv:

  uv pip install sinapsis-easyocr[all] --extra-index-url https://pypi.sinapsis.tech

or with raw pip:

  pip install sinapsis-easyocr[all] --extra-index-url https://pypi.sinapsis.tech

[!TIP] Use CLI command sinapsis info --all-template-names to show a list with all the available Template names installed with Sinapsis OCR.

[!TIP] Use CLI command sinapsis info --example-template-config EasyOCR to produce an example Agent config for the EasyOCR template.

🚀 Features

Templates Supported

This module includes a template tailored for the EasyOCR engine:

• EasyOCR: Extracts text from images using EasyOCR, along with their bounding boxes and confidence scores.

📚 Usage example

agent:
  name: easyocr_inference
  description: agent to run inference with EasyOCR, performs on images read, recognition and save

templates:
- template_name: InputTemplate
  class_name: InputTemplate
  attributes: {}

- template_name: FolderImageDatasetCV2
  class_name: FolderImageDatasetCV2
  template_input: InputTemplate
  attributes:
    data_dir: dataset/input

- template_name: EasyOCR
  class_name: EasyOCR
  template_input: FolderImageDatasetCV2
  attributes: {}

- template_name: BBoxDrawer
  class_name: BBoxDrawer
  template_input: EasyOCR
  attributes:
    draw_confidence: True
    draw_extra_labels: True

- template_name: ImageSaver
  class_name: ImageSaver
  template_input: BBoxDrawer
  attributes:
    save_dir: output
    root_dir: dataset

To run, simply use:

sinapsis run name_of_the_config.yml

🌐 Webapp

The webapp provides a simple interface to extract text from images using EasyOCR. Upload your image, and the app will process it and display the detected text with bounding boxes.

[!IMPORTANT] To run the app you first need to clone the sinapsis-ocr repository:

git clone https://github.com/Sinapsis-ai/sinapsis-ocr.git
cd sinapsis-ocr

[!NOTE] If you'd like to enable external app sharing in Gradio, export GRADIO_SHARE_APP=True

[!TIP] By default, the webapp uses EasyOCR. No additional configuration is needed.

docker compose -f docker/compose.yaml build

docker compose -f docker/compose_app.yaml up

docker logs -f sinapsis-ocr-app

Running on local URL:  http://127.0.0.1:7860

docker compose -f docker/compose_app.yaml down

uv sync --frozen

uv pip install sinapsis-easyocr[all] --extra-index-url https://pypi.sinapsis.tech

uv run webapps/gradio_ocr.py

Running on local URL:  http://127.0.0.1:7860

📙 Documentation

Documentation for this and other sinapsis packages is available on the sinapsis website

Tutorials for different projects within sinapsis are available at sinapsis tutorials page

🔍 License

This project is licensed under the AGPLv3 license, which encourages open collaboration and sharing. For more details, please refer to the LICENSE file.

For commercial use, please refer to our official Sinapsis website for information on obtaining a commercial license.