Quick Start Guide

James bond example

We suggest to start with the James Bond example to get a better understanding of how to annotate your logic program and use the CLI.

Annotating the logic program

Asplain comes with a range of predefined tags that can be used for annotating. These tags are necessary to customize the explanation.

You can start with the basic tags by adding @removable and @addable tags to your logic program.

% @removable
atom_removable.
% @addable
atom_addable.

Tags

The complete list of tags and their usage can be found in the Tagging section.

Command line interface

After properly annotating your logic program you can proceed to call asplain over the CLI.

asplain <YOUR-PROGRAM> 1 --open

If you want to also generate a natural languge explanation:

asplain <YOUR-PROGRAM> 1 --open --llm=<LLM-TAG>

User interface

If you want to open the interactive explanation web interface using clinguin run:

clinguin client-server --domain-files <YOUR-PROGRAM> --ui-files src/asplain/encodings/ui.lp --custom-classes src/asplain/ui --backend ASPlainBackend

Command line

More details about the command line usage can be found in the CLI