caer


Namecaer JSON
Version 2.1.0 PyPI version JSON
download
home_pagehttps://github.com/jasmcaus/caer
SummaryA lightweight Computer Vision library for high-performance AI research - Modern Computer Vision on the Fly.
upload_time2025-08-07 19:29:32
maintainerJason
docs_urlNone
authorJason
requires_python>=3.6
licenseMIT License
keywords caer computer vision toolkit deep learning image processing video processing video stablization video streaming machine learning gpu artificial intelligence data science machine vision opencv multithreading ffmpeg
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <div align="center">
<!-- ![Caer Logo](https://github.com/jasmcaus/caer/blob/dev/docs/sphinx-theme/_static/thumbs/caer-logo-flat.png) -->
<img src="https://github.com/jasmcaus/caer/blob/dev/docs/sphinx-theme/_static/thumbs/caer-logo-flat.png" alt="Caer Logo" / >

---

[![Python](https://img.shields.io/pypi/pyversions/caer.svg)][py-versions]
[![PyPI](https://badge.fury.io/py/caer.svg)][pypi-latest-version]
[![Twitter](https://img.shields.io/twitter/follow/jasmcaus.svg?style=flatl&label=Follow&logo=twitter&logoColor=white&color=1da1f2)][twitter-badge]
[![Downloads](https://pepy.tech/badge/caer)][downloads]
[![ReadTheDocs](https://readthedocs.org/projects/caer/badge/?version=latest)][docs]
[![license](https://img.shields.io/github/license/jasmcaus/caer?label=license)][license]

</div>

# Caer - Modern Computer Vision on the Fly

Caer is a _lightweight, high-performance_ Vision library for high-performance AI research. We wrote this framework to simplify your approach towards Computer Vision by abstracting away unnecessary boilerplate code giving you the **flexibility** to quickly prototype deep learning models and research ideas. The end result is a library quite different in its design, that’s easy to understand, plays well with others, and is a lot of fun to use.

Our elegant, _type-checked_ API and design philosophy makes Caer ideal for students, researchers, hobbyists and even experts in the fields of Deep Learning and Computer Vision.

## Overview

Caer is a Python library that consists of the following components:

| Component                                                                                 | Description                                                                            |
| ----------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| [**caer**](https://github.com/jasmcaus/caer/)                                             | A lightweight GPU-accelerated Computer Vision library for high-performance AI research |
| [**caer.color**](https://github.com/jasmcaus/caer/tree/master/caer/color)                 | Colorspace operations                                                                  |
| [**caer.data**](https://github.com/jasmcaus/caer/tree/master/caer/data)                   | Standard high-quality test images and example data                                     |
| [**caer.path**](https://github.com/jasmcaus/caer/tree/master/caer/path)                   | OS-specific path manipulations                                                         |
| [**caer.preprocessing**](https://github.com/jasmcaus/caer/tree/master/caer/preprocessing) | Image preprocessing utilities.                                                         |
| [**caer.transforms**](https://github.com/jasmcaus/caer/tree/master/caer/transforms)       | Powerful image transformations and augmentations                                       |
| [**caer.video**](https://github.com/jasmcaus/caer/tree/master/caer/video)                 | Video processing utilities                                                             |

<!-- | [**caer.utils**](https://github.com/jasmcaus/caer/tree/master/caer/utils) | Generic utilities  | -->
<!-- | [**caer.filters**](https://github.com/jasmcaus/caer/tree/master/caer/filters) | Sharpening, edge finding, rank filters, thresholding, etc | -->

Usually, Caer is used either as:

-   a replacement for OpenCV to use the power of GPUs.
-   a Computer Vision research platform that provides maximum flexibility and speed.

# Installation

See the Caer **[Installation][install]** guide for detailed installation instructions (including building from source).

Currently, `caer` supports releases of Python 3.6 onwards; Python 2 is not supported (nor recommended).
To install the current release:

```shell
$ pip install --upgrade caer
```

# Getting Started

## Minimal Example

```python
import caer

# Load a standard 640x427 test image that ships out-of-the-box with caer
sunrise = caer.data.sunrise(rgb=True)

# Resize the image to 400x400 while MAINTAINING aspect ratio
resized = caer.resize(sunrise, target_size=(400,400), preserve_aspect_ratio=True)
```

<img src="examples/thumbs/resize-with-ratio.png" alt="caer.resize()" />

For more examples, see the [Caer demos](https://github.com/jasmcaus/caer/blob/master/examples/) or [Read the documentation](http://caer.rtfd.io)

# Resources

-   [**PyPi**](https://pypi.org/project/caer)
-   [**Documentation**](https://github.com/jasmcaus/caer/blob/master/docs/README.md)
-   [**Issue tracking**](https://github.com/jasmcaus/caer/issues)

# Contributing

We appreciate all contributions, feedback and issues. If you plan to contribute new features, utility functions, or extensions to the core, please go through our [Contribution Guidelines][contributing].

To contribute, start working through the `caer` codebase, read the [Documentation][docs], navigate to the [Issues][issues] tab and start looking through interesting issues.

Current contributors can be viewed either from the [Contributors][contributors] file or by using the `caer.__contributors__` command.

# Asking for help

If you have any questions, please:

1. [Read the docs](https://caer.rtfd.io/en/latest/).
2. [Look it up in our Github Discussions (or add a new question)](https://github.com/jasmcaus/caer/discussions).
3. [Search through the issues](https://github.com/jasmcaus/caer/issues).

# License

Caer is open-source and released under the [MIT License](LICENSE).

# BibTeX

If you want to cite the framework feel free to use this (but only if you loved it 😊):

```bibtex
@article{jasmcaus,
  title={Caer},
  author={Jason},
  journal={GitHub. Note: https://github.com/jasmcaus/caer},
  volume={2},
  year={2020-2025}
}
```

[contributing]: https://github.com/jasmcaus/caer/blob/master/.github/CONTRIBUTING.md
[docs]: https://caer.rtfd.io
[contributors]: https://github.com/jasmcaus/caer/blob/master/CONTRIBUTORS
[coc]: https://github.com/jasmcaus/caer/blob/master/CODE_OF_CONDUCT.md
[issues]: https://github.com/jasmcaus/caer/issues
[install]: https://github.com/jasmcaus/caer/blob/master/INSTALL.md
[demos]: https://github.com/jasmcaus/caer/blob/master/examples/
[twitter-badge]: https://twitter.com/jasmcaus
[downloads]: https://pepy.tech/project/caer
[py-versions]: https://pypi.org/project/caer/
[pypi-latest-version]: https://pypi.org/project/caer/
[license]: https://github.com/jasmcaus/caer/blob/master/LICENSE

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/jasmcaus/caer",
    "name": "caer",
    "maintainer": "Jason",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": "caer, computer vision, toolkit, deep learning, image processing, video processing, video stablization, video streaming, machine learning, gpu, artificial intelligence, data science, machine vision, opencv, multithreading, FFMpeg",
    "author": "Jason",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/70/10/4ea992094d2d08657152c675c23fa17cd0e05212efefa23c666a4e35af85/caer-2.1.0.tar.gz",
    "platform": "Any",
    "description": "<div align=\"center\">\n<!-- ![Caer Logo](https://github.com/jasmcaus/caer/blob/dev/docs/sphinx-theme/_static/thumbs/caer-logo-flat.png) -->\n<img src=\"https://github.com/jasmcaus/caer/blob/dev/docs/sphinx-theme/_static/thumbs/caer-logo-flat.png\" alt=\"Caer Logo\" / >\n\n---\n\n[![Python](https://img.shields.io/pypi/pyversions/caer.svg)][py-versions]\n[![PyPI](https://badge.fury.io/py/caer.svg)][pypi-latest-version]\n[![Twitter](https://img.shields.io/twitter/follow/jasmcaus.svg?style=flatl&label=Follow&logo=twitter&logoColor=white&color=1da1f2)][twitter-badge]\n[![Downloads](https://pepy.tech/badge/caer)][downloads]\n[![ReadTheDocs](https://readthedocs.org/projects/caer/badge/?version=latest)][docs]\n[![license](https://img.shields.io/github/license/jasmcaus/caer?label=license)][license]\n\n</div>\n\n# Caer - Modern Computer Vision on the Fly\n\nCaer is a _lightweight, high-performance_ Vision library for high-performance AI research. We wrote this framework to simplify your approach towards Computer Vision by abstracting away unnecessary boilerplate code giving you the **flexibility** to quickly prototype deep learning models and research ideas. The end result is a library quite different in its design, that\u2019s easy to understand, plays well with others, and is a lot of fun to use.\n\nOur elegant, _type-checked_ API and design philosophy makes Caer ideal for students, researchers, hobbyists and even experts in the fields of Deep Learning and Computer Vision.\n\n## Overview\n\nCaer is a Python library that consists of the following components:\n\n| Component                                                                                 | Description                                                                            |\n| ----------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |\n| [**caer**](https://github.com/jasmcaus/caer/)                                             | A lightweight GPU-accelerated Computer Vision library for high-performance AI research |\n| [**caer.color**](https://github.com/jasmcaus/caer/tree/master/caer/color)                 | Colorspace operations                                                                  |\n| [**caer.data**](https://github.com/jasmcaus/caer/tree/master/caer/data)                   | Standard high-quality test images and example data                                     |\n| [**caer.path**](https://github.com/jasmcaus/caer/tree/master/caer/path)                   | OS-specific path manipulations                                                         |\n| [**caer.preprocessing**](https://github.com/jasmcaus/caer/tree/master/caer/preprocessing) | Image preprocessing utilities.                                                         |\n| [**caer.transforms**](https://github.com/jasmcaus/caer/tree/master/caer/transforms)       | Powerful image transformations and augmentations                                       |\n| [**caer.video**](https://github.com/jasmcaus/caer/tree/master/caer/video)                 | Video processing utilities                                                             |\n\n<!-- | [**caer.utils**](https://github.com/jasmcaus/caer/tree/master/caer/utils) | Generic utilities  | -->\n<!-- | [**caer.filters**](https://github.com/jasmcaus/caer/tree/master/caer/filters) | Sharpening, edge finding, rank filters, thresholding, etc | -->\n\nUsually, Caer is used either as:\n\n-   a replacement for OpenCV to use the power of GPUs.\n-   a Computer Vision research platform that provides maximum flexibility and speed.\n\n# Installation\n\nSee the Caer **[Installation][install]** guide for detailed installation instructions (including building from source).\n\nCurrently, `caer` supports releases of Python 3.6 onwards; Python 2 is not supported (nor recommended).\nTo install the current release:\n\n```shell\n$ pip install --upgrade caer\n```\n\n# Getting Started\n\n## Minimal Example\n\n```python\nimport caer\n\n# Load a standard 640x427 test image that ships out-of-the-box with caer\nsunrise = caer.data.sunrise(rgb=True)\n\n# Resize the image to 400x400 while MAINTAINING aspect ratio\nresized = caer.resize(sunrise, target_size=(400,400), preserve_aspect_ratio=True)\n```\n\n<img src=\"examples/thumbs/resize-with-ratio.png\" alt=\"caer.resize()\" />\n\nFor more examples, see the [Caer demos](https://github.com/jasmcaus/caer/blob/master/examples/) or [Read the documentation](http://caer.rtfd.io)\n\n# Resources\n\n-   [**PyPi**](https://pypi.org/project/caer)\n-   [**Documentation**](https://github.com/jasmcaus/caer/blob/master/docs/README.md)\n-   [**Issue tracking**](https://github.com/jasmcaus/caer/issues)\n\n# Contributing\n\nWe appreciate all contributions, feedback and issues. If you plan to contribute new features, utility functions, or extensions to the core, please go through our [Contribution Guidelines][contributing].\n\nTo contribute, start working through the `caer` codebase, read the [Documentation][docs], navigate to the [Issues][issues] tab and start looking through interesting issues.\n\nCurrent contributors can be viewed either from the [Contributors][contributors] file or by using the `caer.__contributors__` command.\n\n# Asking for help\n\nIf you have any questions, please:\n\n1. [Read the docs](https://caer.rtfd.io/en/latest/).\n2. [Look it up in our Github Discussions (or add a new question)](https://github.com/jasmcaus/caer/discussions).\n3. [Search through the issues](https://github.com/jasmcaus/caer/issues).\n\n# License\n\nCaer is open-source and released under the [MIT License](LICENSE).\n\n# BibTeX\n\nIf you want to cite the framework feel free to use this (but only if you loved it \ud83d\ude0a):\n\n```bibtex\n@article{jasmcaus,\n  title={Caer},\n  author={Jason},\n  journal={GitHub. Note: https://github.com/jasmcaus/caer},\n  volume={2},\n  year={2020-2025}\n}\n```\n\n[contributing]: https://github.com/jasmcaus/caer/blob/master/.github/CONTRIBUTING.md\n[docs]: https://caer.rtfd.io\n[contributors]: https://github.com/jasmcaus/caer/blob/master/CONTRIBUTORS\n[coc]: https://github.com/jasmcaus/caer/blob/master/CODE_OF_CONDUCT.md\n[issues]: https://github.com/jasmcaus/caer/issues\n[install]: https://github.com/jasmcaus/caer/blob/master/INSTALL.md\n[demos]: https://github.com/jasmcaus/caer/blob/master/examples/\n[twitter-badge]: https://twitter.com/jasmcaus\n[downloads]: https://pepy.tech/project/caer\n[py-versions]: https://pypi.org/project/caer/\n[pypi-latest-version]: https://pypi.org/project/caer/\n[license]: https://github.com/jasmcaus/caer/blob/master/LICENSE\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "A lightweight Computer Vision library for high-performance AI research - Modern Computer Vision on the Fly.",
    "version": "2.1.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/jasmcaus/caer/issues",
        "Documentation": "https://caer.readthedocs.io/",
        "Download": "https://pypi.org/project/caer",
        "Funding": "https://www.paypal.me/jasmcaus",
        "Homepage": "https://github.com/jasmcaus/caer",
        "Source Code": "https://github.com/jasmcaus/caer"
    },
    "split_keywords": [
        "caer",
        " computer vision",
        " toolkit",
        " deep learning",
        " image processing",
        " video processing",
        " video stablization",
        " video streaming",
        " machine learning",
        " gpu",
        " artificial intelligence",
        " data science",
        " machine vision",
        " opencv",
        " multithreading",
        " ffmpeg"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3df89d00c46631585a3cb14077e453511ac71d99fa5c5d8767cc214f097e3c5d",
                "md5": "1bd6aeb1eb28225d482d9e5563611584",
                "sha256": "c58b52092894341e273718a19d211a4ba7a1a8ac18ab23efe57356b6afd60db9"
            },
            "downloads": -1,
            "filename": "caer-2.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1bd6aeb1eb28225d482d9e5563611584",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 320238,
            "upload_time": "2025-08-07T19:29:30",
            "upload_time_iso_8601": "2025-08-07T19:29:30.723229Z",
            "url": "https://files.pythonhosted.org/packages/3d/f8/9d00c46631585a3cb14077e453511ac71d99fa5c5d8767cc214f097e3c5d/caer-2.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "70104ea992094d2d08657152c675c23fa17cd0e05212efefa23c666a4e35af85",
                "md5": "b124c11a4dd8928dc174247d34a2d16d",
                "sha256": "33a5502b8db2ae0688fdad139bbea1afa6d4efe8adbea571876dd8c61560092c"
            },
            "downloads": -1,
            "filename": "caer-2.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "b124c11a4dd8928dc174247d34a2d16d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 307523,
            "upload_time": "2025-08-07T19:29:32",
            "upload_time_iso_8601": "2025-08-07T19:29:32.758007Z",
            "url": "https://files.pythonhosted.org/packages/70/10/4ea992094d2d08657152c675c23fa17cd0e05212efefa23c666a4e35af85/caer-2.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-07 19:29:32",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "jasmcaus",
    "github_project": "caer",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "caer"
}
        
Elapsed time: 1.24229s