Colour - Checker Detection
==========================
.. start-badges
|actions| |coveralls| |codacy| |version|
.. |actions| image:: https://img.shields.io/github/actions/workflow/status/colour-science/colour-checker-detection/.github/workflows/continuous-integration-quality-unit-tests.yml?branch=develop&style=flat-square
:target: https://github.com/colour-science/colour-checker-detection/actions
:alt: Develop Build Status
.. |coveralls| image:: http://img.shields.io/coveralls/colour-science/colour-checker-detection/develop.svg?style=flat-square
:target: https://coveralls.io/r/colour-science/colour-checker-detection
:alt: Coverage Status
.. |codacy| image:: https://img.shields.io/codacy/grade/c543bc30229347cdaea00aadd3f79499/develop.svg?style=flat-square
:target: https://app.codacy.com/gh/colour-science/colour-checker-detection
:alt: Code Grade
.. |version| image:: https://img.shields.io/pypi/v/colour-checker-detection.svg?style=flat-square
:target: https://pypi.org/project/colour-checker-detection
:alt: Package Version
.. end-badges
A `Python <https://www.python.org>`__ package implementing various colour
checker detection algorithms and related utilities.
It is open source and freely available under the
`BSD-3-Clause <https://opensource.org/licenses/BSD-3-Clause>`__ terms.
.. image:: https://raw.githubusercontent.com/colour-science/colour-checker-detection/master/docs/_static/ColourCheckerDetection_001.png
.. contents:: **Table of Contents**
:backlinks: none
:depth: 2
.. sectnum::
Features
--------
The following colour checker detection algorithms are implemented:
- Segmentation
- Machine learning inference via `Ultralytics YOLOv8 <https://github.com/ultralytics/ultralytics>`__
- The model is published on `HuggingFace <https://huggingface.co/colour-science/colour-checker-detection-models>`__,
and was trained on a purposely constructed `dataset <https://huggingface.co/datasets/colour-science/colour-checker-detection-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*.
Examples
^^^^^^^^
Various usage examples are available from the
`examples directory <https://github.com/colour-science/colour-checker-detection/tree/master/colour_checker_detection/examples>`__.
User Guide
----------
Installation
^^^^^^^^^^^^
Because of their size, the resources dependencies needed to run the various
examples and unit tests are not provided within the Pypi package. They are
separately available as
`Git Submodules <https://git-scm.com/book/en/v2/Git-Tools-Submodules>`__
when cloning the
`repository <https://github.com/colour-science/colour-checker-detection>`__.
Primary Dependencies
~~~~~~~~~~~~~~~~~~~~
**Colour - Checker Detection** requires various dependencies in order to run:
- `python >= 3.10, < 3.14 <https://www.python.org/download/releases>`__
- `colour-science >= 4.5 <https://pypi.org/project/colour-science>`__
- `imageio >= 2, < 3 <https://imageio.github.io>`__
- `numpy >= 1.24, < 3 <https://pypi.org/project/numpy>`__
- `opencv-python >= 4, < 5 <https://pypi.org/project/opencv-python>`__
- `scipy >= 1.10, < 2 <https://pypi.org/project/scipy>`__
Secondary Dependencies
~~~~~~~~~~~~~~~~~~~~~~
- `click >= 8, < 9 <https://pypi.org/project/click>`__
- `ultralytics >= 8, < 9 <https://pypi.org/project/ultralytics>`__
Pypi
~~~~
Once the dependencies are satisfied, **Colour - Checker Detection** can be installed from
the `Python Package Index <http://pypi.python.org/pypi/colour-checker-detection>`__ by
issuing this command in a shell::
pip install --user colour-checker-detection
The overall development dependencies are installed as follows::
pip install --user 'colour-checker-detection[development]'
Contributing
^^^^^^^^^^^^
If you would like to contribute to `Colour - Checker Detection <https://github.com/colour-science/colour-checker-detection>`__,
please refer to the following `Contributing <https://www.colour-science.org/contributing>`__
guide for `Colour <https://github.com/colour-science/colour>`__.
Bibliography
^^^^^^^^^^^^
The bibliography is available in the repository in
`BibTeX <https://github.com/colour-science/colour-checker-detection/blob/develop/BIBLIOGRAPHY.bib>`__
format.
API Reference
-------------
The main technical reference `Colour - Checker Detection <https://github.com/colour-science/colour-checker-detection>`__
is the `API Reference <https://colour-checker-detection.readthedocs.io/en/latest/reference.html>`__.
Code of Conduct
---------------
The *Code of Conduct*, adapted from the `Contributor Covenant 1.4 <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>`__,
is available on the `Code of Conduct <https://www.colour-science.org/code-of-conduct>`__ page.
Contact & Social
----------------
The *Colour Developers* can be reached via different means:
- `Email <mailto:colour-developers@colour-science.org>`__
- `Facebook <https://www.facebook.com/python.colour.science>`__
- `Github Discussions <https://github.com/colour-science/colour-checker-detection/discussions>`__
- `Gitter <https://gitter.im/colour-science/colour>`__
- `Twitter <https://twitter.com/colour_science>`__
About
-----
| **Colour - Checker Detection** by Colour Developers
| Copyright 2018 Colour Developers – `colour-developers@colour-science.org <colour-developers@colour-science.org>`__
| This software is released under terms of BSD-3-Clause: https://opensource.org/licenses/BSD-3-Clause
| `https://github.com/colour-science/colour-checker-detection <https://github.com/colour-science/colour-checker-detection>`__
Raw data
{
"_id": null,
"home_page": null,
"name": "colour-checker-detection",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.14,>=3.10",
"maintainer_email": "Colour Developers <colour-developers@colour-science.org>",
"keywords": "color, color-checker, color-science, color-space, color-spaces, colorspace, colorspaces, colour, colour-checker, colour-science, colour-space, colour-spaces, colourspace, colourspaces, python, segmentation",
"author": null,
"author_email": "Colour Developers <colour-developers@colour-science.org>",
"download_url": "https://files.pythonhosted.org/packages/b4/58/907891c6d8f26ed54a297297d63268485aa611e57a3ca06777680355dec7/colour_checker_detection-0.2.1.tar.gz",
"platform": null,
"description": "Colour - Checker Detection\n==========================\n\n.. start-badges\n\n|actions| |coveralls| |codacy| |version|\n\n.. |actions| image:: https://img.shields.io/github/actions/workflow/status/colour-science/colour-checker-detection/.github/workflows/continuous-integration-quality-unit-tests.yml?branch=develop&style=flat-square\n :target: https://github.com/colour-science/colour-checker-detection/actions\n :alt: Develop Build Status\n.. |coveralls| image:: http://img.shields.io/coveralls/colour-science/colour-checker-detection/develop.svg?style=flat-square\n :target: https://coveralls.io/r/colour-science/colour-checker-detection\n :alt: Coverage Status\n.. |codacy| image:: https://img.shields.io/codacy/grade/c543bc30229347cdaea00aadd3f79499/develop.svg?style=flat-square\n :target: https://app.codacy.com/gh/colour-science/colour-checker-detection\n :alt: Code Grade\n.. |version| image:: https://img.shields.io/pypi/v/colour-checker-detection.svg?style=flat-square\n :target: https://pypi.org/project/colour-checker-detection\n :alt: Package Version\n\n.. end-badges\n\nA `Python <https://www.python.org>`__ package implementing various colour\nchecker detection algorithms and related utilities.\n\nIt is open source and freely available under the\n`BSD-3-Clause <https://opensource.org/licenses/BSD-3-Clause>`__ terms.\n\n.. image:: https://raw.githubusercontent.com/colour-science/colour-checker-detection/master/docs/_static/ColourCheckerDetection_001.png\n\n.. contents:: **Table of Contents**\n :backlinks: none\n :depth: 2\n\n.. sectnum::\n\nFeatures\n--------\n\nThe following colour checker detection algorithms are implemented:\n\n- Segmentation\n- Machine learning inference via `Ultralytics YOLOv8 <https://github.com/ultralytics/ultralytics>`__\n\n - The model is published on `HuggingFace <https://huggingface.co/colour-science/colour-checker-detection-models>`__,\n and was trained on a purposely constructed `dataset <https://huggingface.co/datasets/colour-science/colour-checker-detection-dataset>`__.\n - The model has only been trained on *ColorChecker Classic 24* images and\n will not work with *ColorChecker Nano* or *ColorChecker SG* images.\n - Inference is performed by a script licensed under the terms of the\n *GNU Affero General Public License v3.0* as it uses the\n *Ultralytics YOLOv8* API which is incompatible with the\n *BSD-3-Clause*.\n\nExamples\n^^^^^^^^\n\nVarious usage examples are available from the\n`examples directory <https://github.com/colour-science/colour-checker-detection/tree/master/colour_checker_detection/examples>`__.\n\nUser Guide\n----------\n\nInstallation\n^^^^^^^^^^^^\n\nBecause of their size, the resources dependencies needed to run the various\nexamples and unit tests are not provided within the Pypi package. They are\nseparately available as\n`Git Submodules <https://git-scm.com/book/en/v2/Git-Tools-Submodules>`__\nwhen cloning the\n`repository <https://github.com/colour-science/colour-checker-detection>`__.\n\nPrimary Dependencies\n~~~~~~~~~~~~~~~~~~~~\n\n**Colour - Checker Detection** requires various dependencies in order to run:\n\n- `python >= 3.10, < 3.14 <https://www.python.org/download/releases>`__\n- `colour-science >= 4.5 <https://pypi.org/project/colour-science>`__\n- `imageio >= 2, < 3 <https://imageio.github.io>`__\n- `numpy >= 1.24, < 3 <https://pypi.org/project/numpy>`__\n- `opencv-python >= 4, < 5 <https://pypi.org/project/opencv-python>`__\n- `scipy >= 1.10, < 2 <https://pypi.org/project/scipy>`__\n\nSecondary Dependencies\n~~~~~~~~~~~~~~~~~~~~~~\n\n- `click >= 8, < 9 <https://pypi.org/project/click>`__\n- `ultralytics >= 8, < 9 <https://pypi.org/project/ultralytics>`__\n\nPypi\n~~~~\n\nOnce the dependencies are satisfied, **Colour - Checker Detection** can be installed from\nthe `Python Package Index <http://pypi.python.org/pypi/colour-checker-detection>`__ by\nissuing this command in a shell::\n\n pip install --user colour-checker-detection\n\nThe overall development dependencies are installed as follows::\n\n pip install --user 'colour-checker-detection[development]'\n\nContributing\n^^^^^^^^^^^^\n\nIf you would like to contribute to `Colour - Checker Detection <https://github.com/colour-science/colour-checker-detection>`__,\nplease refer to the following `Contributing <https://www.colour-science.org/contributing>`__\nguide for `Colour <https://github.com/colour-science/colour>`__.\n\nBibliography\n^^^^^^^^^^^^\n\nThe bibliography is available in the repository in\n`BibTeX <https://github.com/colour-science/colour-checker-detection/blob/develop/BIBLIOGRAPHY.bib>`__\nformat.\n\nAPI Reference\n-------------\n\nThe main technical reference `Colour - Checker Detection <https://github.com/colour-science/colour-checker-detection>`__\nis the `API Reference <https://colour-checker-detection.readthedocs.io/en/latest/reference.html>`__.\n\nCode of Conduct\n---------------\n\nThe *Code of Conduct*, adapted from the `Contributor Covenant 1.4 <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>`__,\nis available on the `Code of Conduct <https://www.colour-science.org/code-of-conduct>`__ page.\n\nContact & Social\n----------------\n\nThe *Colour Developers* can be reached via different means:\n\n- `Email <mailto:colour-developers@colour-science.org>`__\n- `Facebook <https://www.facebook.com/python.colour.science>`__\n- `Github Discussions <https://github.com/colour-science/colour-checker-detection/discussions>`__\n- `Gitter <https://gitter.im/colour-science/colour>`__\n- `Twitter <https://twitter.com/colour_science>`__\n\nAbout\n-----\n\n| **Colour - Checker Detection** by Colour Developers\n| Copyright 2018 Colour Developers \u2013 `colour-developers@colour-science.org <colour-developers@colour-science.org>`__\n| This software is released under terms of BSD-3-Clause: https://opensource.org/licenses/BSD-3-Clause\n| `https://github.com/colour-science/colour-checker-detection <https://github.com/colour-science/colour-checker-detection>`__\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Colour checker detection with Python",
"version": "0.2.1",
"project_urls": {
"Changelog": "https://github.com/colour-science/colour-checker-detection/releases",
"Documentation": "https://colour-checker-detection.readthedocs.org",
"Homepage": "https://www.colour-science.org",
"Issues": "https://github.com/colour-science/colour-checker-detection/issues",
"Repository": "https://github.com/colour-science/colour-checker-detection"
},
"split_keywords": [
"color",
" color-checker",
" color-science",
" color-space",
" color-spaces",
" colorspace",
" colorspaces",
" colour",
" colour-checker",
" colour-science",
" colour-space",
" colour-spaces",
" colourspace",
" colourspaces",
" python",
" segmentation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "53a9fe544b28661a5168afac46120e81182395b49b186b83f58529549a0d62ee",
"md5": "fc6a25bd772abaec8058ac3b1fa13b84",
"sha256": "bc1b5397de6d683337c2cbe5677bed99f24f29093cc9cfbb699a51f01cb86ab7"
},
"downloads": -1,
"filename": "colour_checker_detection-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fc6a25bd772abaec8058ac3b1fa13b84",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.14,>=3.10",
"size": 32455939,
"upload_time": "2024-10-12T23:18:35",
"upload_time_iso_8601": "2024-10-12T23:18:35.149557Z",
"url": "https://files.pythonhosted.org/packages/53/a9/fe544b28661a5168afac46120e81182395b49b186b83f58529549a0d62ee/colour_checker_detection-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b458907891c6d8f26ed54a297297d63268485aa611e57a3ca06777680355dec7",
"md5": "d72fa1af766be49b9bfaf8e0324d497a",
"sha256": "68dd0d48aa0f4355ecd0640eee52d3b53c90b24a7d966f422f5513de1bc39e83"
},
"downloads": -1,
"filename": "colour_checker_detection-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "d72fa1af766be49b9bfaf8e0324d497a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.14,>=3.10",
"size": 40392753,
"upload_time": "2024-10-12T23:18:08",
"upload_time_iso_8601": "2024-10-12T23:18:08.007975Z",
"url": "https://files.pythonhosted.org/packages/b4/58/907891c6d8f26ed54a297297d63268485aa611e57a3ca06777680355dec7/colour_checker_detection-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-12 23:18:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "colour-science",
"github_project": "colour-checker-detection",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "colour-checker-detection"
}
JSON
