README KReator v1.3
===================

In order to quickly benefit from KReator's functionalities please follow
the following first steps:

1.) KReator is a plugin-based toolbox. When you first start KReator you
should immediately add plugins for the frameworks you want to use. On
the homepage of KReator you find a collection of plugins currently
supported. In order to add a plugin in KReator go to "Preferences" and
then "Plugins". Note that you have to add at least one plugin in order
to benefit from KReator's functionalities.

2.) For the MLN-plugin to be usable you have to give KReator a link to
the Alchemy binaries. Download the executables for Alchemy from the
KReator homepage (there are compiled binaries for Windows, Linux, and
Mac OS X) and go to "Preferences"->"Markov Logic Networks"->"Alchemy"
(the path that has to be specified has to be the folder in which the
Alchemy binaries "infer", "learnstruct", "learnwts" lie).

3.) In order to get familiar with KReator you should have a look at the
"getting started" project: go to "Help"->"Getting Started". This project
contains some knowledge bases for different frameworks, some scripts
(written in JavaScript and which contain sequences of "query" commands
to the knowledge bases, and some sample files (that can be used to learn
new knowledge bases or as evidence for queries).


Here are some more hints that may be helpful:

- You can issue commands by either using the graphical user interface
(GUI) or the command line interface (CLI). The CLI uses a JavaScript-based
language and you can type "help" to get a list of available commands.

- There are three basic things you can do with KReator: query a knowledge
base (ask for the probability of some formula, given a set of other formulas),
learn a knowledge base (use a sample collection to learn both structure and
parameters for a knowledge base in some target framework), and generate
data (generate exemplary data from a knowledge base)

- Using scripts you can issue complex series of commands to multiple knowledge
bases. There are some exemplary scripts present in the "getting started" project
(just right-click the script in the project tree and select "run").

For a deeper introduction to KReator we refer to the papers on KReator
available at the kreator.cs.tu-dortmund.de. If you have any questions or
problems don't hesitate to contact us (see homepage for contact details).