Skip to content

UCL-ARC/ner-ocr

Repository files navigation

NER OCR

pre-commit Tests status Linting status Documentation status License

A pipeline for NER using OCR

This project is developed in collaboration with the Centre for Advanced Research Computing, University College London.

About

Project Team

Mack Nixon ([email protected])

Research Software Engineering Contact

Centre for Advanced Research Computing, University College London ([email protected])

Getting Started

Prerequisites

ner-ocr requires Python 3.13–3.11.

Installation

Installing uv

uv is used for Python dependency management and managing virtual environments. You can install uv either using pipx or the uv installer script:

curl -LsSf https://astral.sh/uv/install.sh | sh

Installing Dependencies

Once uv is installed, install dependencies:

uv sync

Activate your Python environment

source .venv/bin/activate

Installing pre-commit hooks

Install pre-commit locally (in your activated venv) to aid code consistency (if you're looking to contribute).

pre-commit install

Roadmap

  • Initial Research
  • Minimum viable product <-- You are Here
  • Alpha Release
  • Feature-Complete Release

About

A pipeline for extracting entities from documents

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published