image-quality


Nameimage-quality JSON
Version 1.2.6 PyPI version JSON
download
home_pagehttps://github.com/ocampor/image-quality
SummaryImage quality is an open source software library for Automatic Image Quality Assessment (IQA).
upload_time2020-11-21 20:01:06
maintainer
docs_urlNone
authorRicardo Ocampo
requires_python>=3.6
licenseApache 2.0
keywords image quality reference reference-less
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. -*- mode: rst -*-

|Travis|_ |PyPi|_

.. |Travis| image:: https://travis-ci.com/ocampor/image-quality.svg?branch=master
.. _Travis: https://travis-ci.com/ocampor/image-quality

.. |PyPi| image:: https://img.shields.io/pypi/dm/image-quality?color=blue   :alt: PyPI - Downloads
.. _PyPi: https://pypi.org/project/image-quality/

Image Quality
=============

Description
-----------

Image quality is an open source software library for Automatic Image
Quality Assessment (IQA).

Dependencies
------------

-  Python 3.8
-  (Development) Docker

Installation
------------

The package is public and is hosted in PyPi repository. To install it in
your machine run

::

   pip install image-quality

Example
-------

After installing ``image-quality`` package, you can test that it was
successfully installed running the following commands in a python
terminal.

::

   >>> import imquality.brisque as brisque
   >>> import PIL.Image

   >>> path = 'path/to/image'
   >>> img = PIL.Image.open(path)
   >>> brisque.score(img)
   4.9541572815704455


Development
-----------

In case of adding a new tensorflow dataset or modifying the location of a zip file, it is
necessary to update the url checksums. You can find the instructions in the following
`tensorflow documentation <https://www.tensorflow.org/datasets/add_dataset#1_adjust_the_checksums_directory>`_.

The steps to create the url checksums are the following:

1. Take the file with the dataset configuration (e.g. live_iqa.py) an place it in the ``tensorflow_datasets``
folder. The folder is commonly placed in ``${HOME}/.local/lib/python3.8/site-packages`` if you
install the python packages using the ``user`` flag.

2. Modify the ``__init__.py`` of the ``tensorflow_datasets`` to import your new dataset.
For example ``from .image.live_iqa import LiveIQA`` at the top of the file.

3. In your terminal run the commands:
::

   touch url_checksums/live_iqa.txt
   python -m tensorflow_datasets.scripts.download_and_prepare  \
      --register_checksums  \
      --datasets=live_iqa

4. The file ``live_iqa.txt`` is going to contain the checksum. Now you can copy and paste it to your
project's ``url_checksums`` folder.

Sponsor
-------

.. image:: https://github.com/antonreshetov/mysigmail/raw/master/jetbrains.svg?sanitize=true
   :target: <https://www.jetbrains.com/?from=mysigmail>_

Maintainer
----------

- `Ricardo Ocampo <https://ocampor.com>`_



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ocampor/image-quality",
    "name": "image-quality",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "image,quality,reference,reference-less",
    "author": "Ricardo Ocampo",
    "author_email": "me@ocampor.ai",
    "download_url": "https://files.pythonhosted.org/packages/4a/c9/6e3ae49a7602d5c5e735c67fa6b0e622bb51d5823e87dfeefe885f73fa21/image-quality-1.2.6.tar.gz",
    "platform": "",
    "description": ".. -*- mode: rst -*-\n\n|Travis|_ |PyPi|_\n\n.. |Travis| image:: https://travis-ci.com/ocampor/image-quality.svg?branch=master\n.. _Travis: https://travis-ci.com/ocampor/image-quality\n\n.. |PyPi| image:: https://img.shields.io/pypi/dm/image-quality?color=blue   :alt: PyPI - Downloads\n.. _PyPi: https://pypi.org/project/image-quality/\n\nImage Quality\n=============\n\nDescription\n-----------\n\nImage quality is an open source software library for Automatic Image\nQuality Assessment (IQA).\n\nDependencies\n------------\n\n-  Python 3.8\n-  (Development) Docker\n\nInstallation\n------------\n\nThe package is public and is hosted in PyPi repository. To install it in\nyour machine run\n\n::\n\n   pip install image-quality\n\nExample\n-------\n\nAfter installing ``image-quality`` package, you can test that it was\nsuccessfully installed running the following commands in a python\nterminal.\n\n::\n\n   >>> import imquality.brisque as brisque\n   >>> import PIL.Image\n\n   >>> path = 'path/to/image'\n   >>> img = PIL.Image.open(path)\n   >>> brisque.score(img)\n   4.9541572815704455\n\n\nDevelopment\n-----------\n\nIn case of adding a new tensorflow dataset or modifying the location of a zip file, it is\nnecessary to update the url checksums. You can find the instructions in the following\n`tensorflow documentation <https://www.tensorflow.org/datasets/add_dataset#1_adjust_the_checksums_directory>`_.\n\nThe steps to create the url checksums are the following:\n\n1. Take the file with the dataset configuration (e.g. live_iqa.py) an place it in the ``tensorflow_datasets``\nfolder. The folder is commonly placed in ``${HOME}/.local/lib/python3.8/site-packages`` if you\ninstall the python packages using the ``user`` flag.\n\n2. Modify the ``__init__.py`` of the ``tensorflow_datasets`` to import your new dataset.\nFor example ``from .image.live_iqa import LiveIQA`` at the top of the file.\n\n3. In your terminal run the commands:\n::\n\n   touch url_checksums/live_iqa.txt\n   python -m tensorflow_datasets.scripts.download_and_prepare  \\\n      --register_checksums  \\\n      --datasets=live_iqa\n\n4. The file ``live_iqa.txt`` is going to contain the checksum. Now you can copy and paste it to your\nproject's ``url_checksums`` folder.\n\nSponsor\n-------\n\n.. image:: https://github.com/antonreshetov/mysigmail/raw/master/jetbrains.svg?sanitize=true\n   :target: <https://www.jetbrains.com/?from=mysigmail>_\n\nMaintainer\n----------\n\n- `Ricardo Ocampo <https://ocampor.com>`_\n\n\n",
    "bugtrack_url": null,
    "license": "Apache 2.0",
    "summary": "Image quality is an open source software library for Automatic Image Quality Assessment (IQA).",
    "version": "1.2.6",
    "split_keywords": [
        "image",
        "quality",
        "reference",
        "reference-less"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "475f2ff97d8dfddad5549ba0e9125c90",
                "sha256": "bef7b87b2f59b5abedbfa0c47308d6679aab764ba162d709f9ab4fbf38a0f924"
            },
            "downloads": -1,
            "filename": "image_quality-1.2.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "475f2ff97d8dfddad5549ba0e9125c90",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 146570,
            "upload_time": "2020-11-21T20:01:04",
            "upload_time_iso_8601": "2020-11-21T20:01:04.896269Z",
            "url": "https://files.pythonhosted.org/packages/08/0d/9fb007d9925dddf8f3a1fd1268f6cf44f1127059a0528ffc74539a92a1b8/image_quality-1.2.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "6c1a29af1dab5d187f633ac6ec0349cb",
                "sha256": "ffe6cd73947486e827a0b14225d74ea13e1004495c5f41a50d07eb8800b4e4b2"
            },
            "downloads": -1,
            "filename": "image-quality-1.2.6.tar.gz",
            "has_sig": false,
            "md5_digest": "6c1a29af1dab5d187f633ac6ec0349cb",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 141542,
            "upload_time": "2020-11-21T20:01:06",
            "upload_time_iso_8601": "2020-11-21T20:01:06.395852Z",
            "url": "https://files.pythonhosted.org/packages/4a/c9/6e3ae49a7602d5c5e735c67fa6b0e622bb51d5823e87dfeefe885f73fa21/image-quality-1.2.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2020-11-21 20:01:06",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "ocampor",
    "error": "Could not fetch GitHub repository",
    "lcname": "image-quality"
}
        
Elapsed time: 0.22488s