Metadata-Version: 2.1
Name: attribench
Version: 0.1.3
Summary: A benchmark for feature attribution techniques
Author-email: Arne Gevaert <arne.gevaert@ugent.be>, Axel-Jan Rousseau <axeljan.rousseau@uhasselt.be>
License: MIT License
        
        Copyright (c) [year] [fullname]
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: Homepage, https://github.com/arnegevaert/benchmark
Project-URL: Documentation, http://attribench.readthedocs.io/
Keywords: attributions,benchmark,explanation,machine learning
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: torch <2,>=1.5.0
Requires-Dist: torchvision >=0.14.0
Requires-Dist: krippendorff >=0.5.0
Requires-Dist: opencv-python >=4.7.0.0
Requires-Dist: scikit-learn >=1.2.0
Requires-Dist: scikit-image >=0.19.0
Requires-Dist: seaborn >=0.12.0
Requires-Dist: h5py
Requires-Dist: tqdm
Requires-Dist: pyyaml
Provides-Extra: dev
Requires-Dist: bumpver ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
Requires-Dist: numpydoc ; extra == 'docs'
Requires-Dist: sphinx-autodoc-typehints ; extra == 'docs'
Requires-Dist: nbsphinx ; extra == 'docs'
Requires-Dist: ipython ; extra == 'docs'
Requires-Dist: jupyter ; extra == 'docs'
Requires-Dist: ipywidgets ; extra == 'docs'

AttriBench: Metrics for Feature Attribution Techniques
======================================================
**AttriBench** is a `Pytorch <https://pytorch.org/>`_-based implementation of
several metrics for the evaluation of feature attribution maps and methods.
AttriBench provides a functional and an object-oriented API for the computation
of these metrics, along with a set of utility functions for the necessary
preparations (e.g. computing attribution maps) as well as for the visualization
of the results.

The **functional API** is generally easier to use, and can be used to get
started quickly if the scale of the evaluation is not too large. The
**object-oriented API** is more flexible and can use multiple GPUs for
evaluation of large datasets.

For more information, see the `documentation <https://attribench.readthedocs.io/>`_.

Installation
------------
AttriBench can be installed from PyPI using pip:

.. code-block:: bash
    
    pip install attribench
