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:

$ pip install corelay

Contents

• Getting started
  • Install
  • Basic Usage
  • Examples
• API Reference
  • corelay.base
  • corelay.io
  • corelay.pipeline
  • corelay.plugboard
  • corelay.processor
  • corelay.tracker
  • corelay.utils
• Bibliography

Indices and tables

• Index

• Module Index

• Search Page

Citing

If you find CoRelAy useful, why not cite our paper [Anders et al., 2021]:

@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},
}