Skip to content

Latest commit

 

History

History
76 lines (53 loc) · 2.7 KB

index.rst

File metadata and controls

76 lines (53 loc) · 2.7 KB

Colour - Checker Detection

A Python package implementing various colour checker detection algorithms and related utilities.

It is open source and freely available under the BSD-3-Clause terms.

https://raw.githubusercontent.com/colour-science/colour-checker-detection/master/docs/_static/ColourCheckerDetection_001.png

1   Features

The following colour checker detection algorithms are implemented:

  • Segmentation
  • Machine learning inference via Ultralytics YOLOv8
    • The model is published on HuggingFace, and was trained on a purposely constructed dataset.
    • The model has only been trained on ColorChecker Classic 24 images and will not work with ColorChecker Nano or ColorChecker SG images.
    • Inference is performed by a script licensed under the terms of the GNU Affero General Public License v3.0 as it uses the Ultralytics YOLOv8 API which is incompatible with the BSD-3-Clause.

1.1   Examples

Various usage examples are available from the examples directory.

2   User Guide

.. toctree::
    :maxdepth: 2

    user-guide

3   API Reference

.. toctree::
    :maxdepth: 2

    reference

4   Code of Conduct

The Code of Conduct, adapted from the Contributor Covenant 1.4, is available on the Code of Conduct page.

5   Contact & Social

The Colour Developers can be reached via different means:

6   About

Colour - Checker Detection by Colour Developers
Copyright 2018 Colour Developers – colour-developers@colour-science.org
This software is released under terms of BSD-3-Clause: https://opensource.org/licenses/BSD-3-Clause