RuleKit

Rule-based models are often used for data analysis as they combine interpretability with predictive power. We present RuleKit, a versatile tool for rule learning. Based on a sequential covering induction algorithm, it is suitable for classification, regression, and survival problems. The presence of user-guided induction mode facilitates verifying hypotheses concerning data dependencies which are expected or of interest. The powerful and flexible experimental environment allows straightforward investigation of different induction schemes. The analysis can be performed in batch mode, through RapidMiner plugin, as well as R package and Python packages. A documented Java API is also provided for convenience.

RuleKit provides latest versions of our algorithms (some of them were initially published as independent packages and integrated later):

LR-Rules (Wróbel et al, 2017) - survival rules induction,
GuideR (Sikora et al, 2019) - user-guided induction.
RuleKit-CS (Gudyś et al, 2022) - contrast set mining.

Getting started

In the following subsections we provide a brief introduction on how to install and use RuleKit batch interface, RapidMiner plugin, and R package. The software requires Java Development Kit in version 8 (version 1.8.0 tested) to work properly. In Windows one can download the installer from Oracle webpage. In Linux, a system package manager should be used instead. For instance, in Ubuntu 16.04 execute the following command:

sudo apt-get install default-jdk

Batch interface

In order to use batch mode, please download rulekit-<version>-all.jar file from the releases folder. Alternatively, one can build the package from the sources by running the following commands in the adaa.analytics.rules directory of this repository. Windows:

gradlew -b build.gradle rjar

Linux:

./gradlew -b build.gradle rjar

The JAR file will be placed in adaa.analytics.rules/build/libs subdirectory. Once the package has been downloaded/built, the analysis can be performed. The example batch experiment concerns the problem of classifying whether a person making a purchase will be a future customer. The corresponding dataset is named deals and is split into train and test parts (download). To run the experiment, copy RuleKit JAR file into ./examples folder of the repository and execute:

java -jar rulekit-<version>-all.jar minimal-deals.xml

Ignore the SLF4J warning reported on the console - it does not affect the procedure. The results of the analysis will be located in ./examples/results-minimal/deals/ folder. Note, that the repository already contains reference results - they will be overwritten. See this Wiki section for detailed information on how to configure batch analyses in RuleKit.

RapidMiner plugin

In order to use RuleKit RapidMiner plugin, download rulekit-<version>-rmbundle.zip file from the releases folder. The archive contains RapidMiner 9.3 bundled with the plugin. The bundle can be also built from the sources by running the following commands in the adaa.analytics.rules directory. Windows:

gradlew -b build.gradle rmbundle

Linux:

./gradlew -b build.gradle rmbundle

The output archive will be stored in adaa.analytics.rules/build/distributions. After unpacking ZIP file, please execute RapidMiner-Studio.bat (Windows) or RapidMiner-Studio.sh (Linux) script. Note, that the archive built under Windows may not work on Linux due to different new line characters in the shell script. The opposite situation is not the problem, though. In the releases we provide the archive that works under both systems.

In the following subsection we show an example regression analysis with a use of the plugin. The investigated dataset is named methane and concerns the problem of predicting methane concentration in a coal mine. The set is split into separate testing and training parts distributed in ARFF format (download). For demonstration needs, a smaller version of these datasets suffixed with -minimal have been provided.

To perform the analysis under RapidMiner, import ./examples/preparation.rmp process (File → Import Process...) and execute it (Play button). Its role is to add metadata to the sets and store them in the RM format (RapidMiner does not support metadata for ARFF files). After loading sets with Read ARFF, the Set Role operator is used for setting MM116_pred as the label attribute (in the survival analysis, a survival_time role has to be additionally assigned to some other attribute). Then, the sets are saved in RapidMiner repository under locations Local Repository/methane-train-minimal and Local Repository/methane-test-minimal with Store operators.

As the next step, please import ./examples/regression.rmp process. After executing it, datasets are loaded from the RM repository with Retrieve operators. Then, the training set is provided as an input for RuleKit Generator. The model generated by RuleKit Generator is then applied on unseen data (Apply Model operator). The performance of the prediction is assesed using RuleKit Evaluator operator. Performance metrices as well as generated model are passed as process outputs.

See this Wiki section for detailed information how to configure RuleKit RapidMiner plugin.

R package

RuleKit is compatible with R 3.4.x or later. In Linux, curl, ssl, and xml system packages are additionally required for RuleKit building. For instance, under Ubuntu 18.04, execute in terminal:

sudo apt-get install libcurl4-gnutls-dev
sudo apt-get install libssl-dev
sudo apt-get install libxml2-dev

In other distributions, package names may differ slightly. To build RuleKit, please download the rulekit-<version>-all.jar file from the releases folder and copy it to the ./r-package/inst/java/ directory of the repository. Then, open ./r-package/rulekit.Rproj project under RStudio environment and install all required dependencies:

install.packages(c('RWeka','XML','caret','rprojroot','devtools'))

Then, build the package with Install and Restart button (the appropiate version of RTools will be downloaded automatically, if it is not present at the target platform). RuleKit will be installed under default R package directory.

Below we present a survival analysis of BMT-Ch dataset with RuleKit R package. The set concerns the problem of analyzing factors contributing to the patients’ survival following bone marrow transplants. In order to perform the experiment, please run ./examples/survival.R script in R. As a result, a rule model is trained and survival function estimates for the entire dataset and for the rules are plotted.

This Wiki section contains detailed information on using RuleKit R package.

Python package

Rulekit Python package can be found here

Documentation

The detailed RuleKit documentation can be found on Wiki pages which cover the following topics:

JavaDoc for the project is available here.

Datasets

The repository contains the datasets used in the GuideR study. We also provide the latest UCI revision of the Bone marrow transplant: children dataset. We recommend using this dataset at it contains lots of improvements compared to the previous release (e.g., textual encoding of attribute values).