=====================
CoRelAy Documentation
=====================

CoRelAy is a tool to compose small-scale (single-machine) analysis pipelines. It
was created to swiftly implement pipelines to generate analysis data which can
then be visualized using ViRelAy.

CoRelAy is available on PyPI and can be installed with:

.. code-block:: console

   $ pip install corelay

Contents
--------

.. toctree::
    :maxdepth: 2

    getting-started
    reference/index
    bibliography

Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


Citing
------

If you find CoRelAy useful, why not cite our paper :cite:p:`anders2021software`:

.. code-block:: bibtex

    @article{anders2021software,
          author  = {Anders, Christopher J. and
                     Neumann, David and
                     Samek, Wojciech and
                     Müller, Klaus-Robert and
                     Lapuschkin, Sebastian},
          title   = {Software for Dataset-wide XAI: From Local Explanations to Global Insights with {Zennit}, {CoRelAy}, and {ViRelAy}},
          journal = {CoRR},
          volume  = {abs/2106.13200},
          year    = {2021},
    }