.. ReVEL documentation master file, created by
   sphinx-quickstart on Tue Jul 12 12:42:13 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to ReVEL's documentation!
=================================

ReVEL(Robust Evaluation VEctorized Loca-linear-explanation) is a Python
library that provides series of tools for Explinable Artificial Intelligence(XAI) 
from the perspective of the audition of black-box. Specifically, it provides 
a framework for the generation and evaluation of Local Linear Explanations(LLEs).

This library develops the framework proposed on the paper `REVEL Framework to Measure Local Linear Explanations for Black-Box Models: Deep Learning Image Classification Case Study <https://doi.org/10.1155/2023/8068569>`_. If you use this library in your research, please cite the paper as follows:

.. code-block:: bibtex
   
   @article{sevillano2023revel,
   title={REVEL Framework to Measure Local Linear Explanations for Black-Box Models: Deep Learning Image Classification Case Study},
   author={Sevillano-Garc{\'\i}a, Iv{\'a}n and Luengo, Juli{\'a}n and Herrera, Francisco},
   journal={International Journal of Intelligent Systems},
   volume={2023},
   number={1},
   pages={8068569},
   year={2023},
   publisher={Wiley Online Library}
   }


.. toctree::
   :maxdepth: 2
   :caption: Contents
   :numbered:
   
   intro
   modules
   examples


.. bibliography::
   :cited: