eye-annotation-tool 1.0.1

A tool for annotating pupil and iris in eye images

EyE Annotation Tool

EyE Annotation Tool is a tool for annotating pupil, iris and eyelid in eye images. It provides a user-friendly interface for manual annotation and supports AI-assisted detection.

Features

• Load and navigate through multiple eye images
• Manual annotation of pupil, iris, eyelid, and glints
• AI-assisted detection of pupil, iris, eyelid, and glints
• Undo functionality for annotations
• Save and load annotations
• Extensible plugin system for custom detectors

Installation

pip install eye_annotation_tool

For the latest development version:

pip install git+https://github.com/mh-salari/eye_annotation_tool.git

Using uv

If you prefer uv:

git clone https://github.com/mh-salari/eye_annotation_tool.git
cd eye_annotation_tool
uv sync

Apple Silicon (M1/M2/M3) Note: The pupil-detectors dependency only provides pre-built wheels for x86_64. On Apple Silicon Macs, you need to use an x86_64 Python via Rosetta 2:

uv python install cpython-3.11-macos-x86_64
uv python pin cpython-3.11-macos-x86_64
uv sync

Usage

eye_annotation_tool

Or with uv:

uv run eye_annotation_tool

Or run it as a module:

python -m eye_annotation_tool

Adding Custom Plugins

EyE Annotation Tool supports custom plugins for pupil, iris and eyelid detection. To add a new plugin:

1. Create a new Python file in the appropriate plugin directory.
2. Define your detector class in this file.
3. Ensure your detector follows the required interface.

For a detailed guide on creating plugins, see the Plugin Development Guide in the ai directory.

Citing

If you use this software, please cite it using the following BibTeX entry:

@software{salari2025eye,
  author    = {Salari, Mohammadhossein},
  title     = {{EyE Annotation Tool}},
  year      = {2026},
  url       = {https://github.com/mh-salari/eye_annotation_tool},
  doi       = {10.5281/zenodo.18723470},
  license   = {MIT}
}

You can also click the "Cite this repository" button on the GitHub page for more citation formats.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

This project has received funding from the European Union's Horizon Europe research and innovation funding program under grant agreement No 101072410, Eyes4ICU project.