Metadata-Version: 2.1
Name: evalutils
Version: 0.1.12
Summary: evalutils helps challenge administrators easily create evaluation containers for grand-challenge.org.
Home-page: https://github.com/comic/evalutils
Author: James Meakin
Author-email: jamesmeakin@gmail.com
License: MIT license
Keywords: evalutils
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Requires-Python: >=3.6.0
Requires-Dist: pandas
Requires-Dist: imageio
Requires-Dist: SimpleITK
Requires-Dist: cookiecutter
Requires-Dist: click
Requires-Dist: scipy
Requires-Dist: scikit-learn

=========
evalutils
=========

.. image:: https://badge.fury.io/py/evalutils.svg
    :target: https://badge.fury.io/py/evalutils

.. image:: https://travis-ci.org/comic/evalutils.svg?branch=master
    :target: https://travis-ci.org/comic/evalutils

.. image:: https://api.codeclimate.com/v1/badges/5c3b7f45f6a476d0f21e/maintainability
   :target: https://codeclimate.com/github/comic/evalutils/maintainability
   :alt: Maintainability

.. image:: https://api.codeclimate.com/v1/badges/5c3b7f45f6a476d0f21e/test_coverage
   :target: https://codeclimate.com/github/comic/evalutils/test_coverage
   :alt: Test Coverage

.. image:: https://readthedocs.org/projects/evalutils/badge/?version=latest
        :target: https://evalutils.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status

.. image:: https://pyup.io/repos/github/comic/evalutils/shield.svg
     :target: https://pyup.io/repos/github/comic/evalutils/
     :alt: Updates


evalutils helps challenge administrators easily create evaluation containers for grand-challenge.org.

* Free software: MIT license
* Documentation: https://evalutils.readthedocs.io.

Features
--------

* Generation your challenge evaluation project boilerplate using Cookiecutter_
* Scripts to build, test and export your generated docker container for grand-challenge.org
* Loading of CSV, ITK and Pillow compatible prediction files
* Validation of submitted predictions
* Interface to SciKit-Learn metrics and Pandas aggregations
* Bounding box annotations with Intersection Over Union calculations


Getting Started
---------------

evalutils_ requires Python 3.6, and can be installed from `pip`. Please
see the `Getting Started`_ documentation for more details.


Credits
-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
.. _evalutils: https://github.com/comic/evalutils
.. _`Getting Started`: https://evalutils.readthedocs.io/en/latest/usage.html


=======
History
=======

0.1.12 (2018-05-16)
-------------------

* Fixed a bug where the number of `false_negatives` could be less than 0.

0.1.11 (2018-05-15)
-------------------

* **Breaking change:** Renamed ``Evaluation`` to ``ClassificationEvaluation``
* Adds support for ``DetectionEvaluation``

0.1.10 (2018-04-19)
-------------------

* Simplifies the example template

0.1.9 (2018-04-19)
------------------

* **Breaking change:** Renamed ``bb2`` to ``other`` in ``BoundingBox()``
* ``ground_truth_path`` is no longer a required argument

0.1.8 (2018-04-18)
------------------

* Fixes template folder in distribution

0.1.7 (2018-04-18)
------------------

* Adds cookiecutter templating for generating new projects
* Adds equality check for ``BoundingBox``

0.1.6 (2018-03-30)
------------------

* Improves pandas csv handling

0.1.5 (2018-03-30)
------------------

* Corrects loading of some CSV files
* Adds logging and more tests
* Adds referencing to ``_ground_truth`` and ``_prediction`` in joined pandas tables


0.1.3 (2018-03-29)
------------------

* Adds basic implementation with
    * Full Evaluation workflow
    * CSV, SimpleITK, and ImageIO loaders
    * BoundingBox annotations with intersection, union and intersection over union metrics
    * Unique File Indices, Unique Image, Expected Column Names and Number of cases validators


0.1.0 (2018-03-22)
------------------

* First release on PyPI.


