Package: virelay
ViRelAy – Visualizing Relevance AnalysisViRelAyis a visualization tool for the analysis of data as generated byCoRelAy. It runs a small website to view and interact with data representations using clusterings and (t-SNE-)embeddings, the corresponding source data and an auxiliary per-sample representation (i.e., the attribution). With this, ViRelAy attempts to simplify the analysis of classifiers and their underlying datasets. Currently, only image data is supported, and the auxiliary representation is expected to be an attribution with the same shape as the input.For more information about ViRelAy, in-depth getting started guides, and API documentation, please refer to thedocumentation.If you find ViRelAy useful for your research, why not cite our relatedpaper:@article{anders2021software,author={Anders, Christopher J. andNeumann, David andSamek, Wojciech andMüller, Klaus-Robert andLapuschkin, 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},}FeaturesVisually inspect analyses generated using CoRelAyOpen multiple projects side-by-sideCollaborate using export, import, and share functionalityEasily find outlier classification strategies by visualizing classifications using different clustering methodsUnderstand the classification strategies of your model by viewing attribution data as heatmapsEasily run ViRelAy locally or on a serverGetting StartedTo get started, you first have to install ViRelAy on your system. The easiest way to install ViRelAy is to use the package available on PyPI, which can be easily installed using your favorite package manager, e.g.,pip:$pipinstallvirelayViRelAy uses a custom file format, which usually comprises a project file inYAMLformat, a dataset either inHDF5format or in a directory structure, one or more attribution databases in HDF5 format, and one or more analyses databases for various analyses methods in HDF5 format. For more information on the project file format, please refer to theproject file format documentationand for more information on the formats for the dataset, attribution, and analyses databases, see thedatabase specifications.ViRelAy projects can be generated usingCoRelAy, but if you want to get a fast first glimpse at ViRelAy, you can also create a randomly generatedexample project.When you have a project ready, you can open it in ViRelAy like so using the following command. Please note that starting ViRelAy using the command line interface, will start a rather slow development server. For improved load times or when running ViRelAy on a server, please run it using the WSGI HTTP serverGunicorn.$python-mvirelay<project-file>[<project-file>...]This will start the server athttp://localhost:8080and automatically open your default browser. Optionally, you can specify an alternative host and port using the--hostand--portcommand line arguments. For more in-depth instructions, please refer to ourgetting started guide.ContributingIf you would like to contribute, there are multiple ways you can help out. If you find a bug or have a feature request, please feel free to open an issue on GitHub. If you want to contribute code, please fork the repository and use a feature branch. Pull requests are always welcome. Before forking, please open an issue where you describe what you want to do. This helps to align your ideas with ours and may prevent you from doing work, that we are already planning on doing. If you have contributed to the project, please add yourself to thecontributors list.To help speed up the merging of your pull request, please comment and document your code extensively, try to emulate the coding style of the project, and update the documentation if necessary. For more information on how to contribute, please refer to thedeveloper documentation.LicenseViRelAy is licensed under the GNU AFFERO GENERAL PUBLIC LICENSE VERSION 3 OR LATER. For more information see thecopyingand thelicensefiles. For licenses of bundled third party software packages please refer to the3rd party license list.