Welcome to iquaflow’s documentation!

iquaflow is an image quality framework that aims at providing a set of tools to assess image quality.

There are several aproaches to acomplish the objective. One can measure quality directly by applying metrics on the images that compose a dataset. These metrics can be based on similarity (by comparing against a groundtruth) or they can also be “blind” ( such as measuring blur, noise, sharpness…). The user can add custom metrics that can be easily integrated in iquaflow.

Furthermore, iquaflow allows to measure quality by using the performance of AI models trained on the images as a proxy. This also helps to easily make studies of performance degradation on several modifications of the original dataset with images (such as compression modifications). All this is wrapped in mlflow: an interactive tool used to visualize and summarize the results. A study like that is named a “use case” and there is a cookiecutter to falicitate the code generation for each new study.

The source code and issue tracker are hosted on GitHub, and all contributions and feedback are more than welcome.

Installation

You can install iquaflow using pip:

pip install iquaflow

Alternatively you can use docker. The Dockerfile and a whole template for a use case study repository is available as a cookiecutter in here.

iquaflow is a Python library, and therefore should work on Linux, OS X and Windows provided that you can install its dependencies. If you find any problem, please open an issue and we will take care of it.

Warning

It is recommended that you never ever use sudo with pip because you might seriously break your system. Use venv, Pipenv, pyenv or conda to create an isolated development environment instead.

Indices and tables