Documention
We really should do some docu.
Very Important:
-
update README.md
For Developer:
-
general architectural overview -
description of the evaluation machinery -
how to use the flagger
(purpose, how, limitations) -
how to add new flagger
(location, interface) -
how to add test functions (location, interface)
For User:
-
Quick start tutorial -
Description of the test specification syntax -
Description of the available tests and routines: -
routine signatures, (need a new sync with actual names) -
routine descriptions, (need a new sync with actual names)
-
-
Separate description of the concepts of: -
(De-) Harmonization -
Execution via cmd-line/in-script -
Implementation of own functions -
Using a custom flagging scheme -
Training and use of ML-models
-
Public documentation (for example on Read the Docs) would be a plus