Skip to content

Commit

Permalink
Some unnecessary stuff removed. Documentation update.
Browse files Browse the repository at this point in the history
  • Loading branch information
@agudys
agudys authored Jan 12, 2024
1 parent eba946c commit 7a7dd0a
Show file tree
Hide file tree
Showing 7 changed files with 77 additions and 788 deletions.
66 changes: 33 additions & 33 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The JAR file will be placed in *adaa.analytics.rules/build/libs* subdirectory. O
```
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](../../wiki/1-Batch-interface) for detailed information on how to configure batch analyses in RuleKit.
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](https://github.com/adaa-polsl/RuleKit/wiki/1-Batch-interface) for detailed information on how to configure batch analyses in RuleKit.

## RapidMiner plugin

Expand All @@ -55,7 +55,7 @@ To perform the analysis under RapidMiner, import [./examples/preparation.rmp](/e

As the next step, please import [./examples/regression.rmp](./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](../../wiki/2-RapidMiner-plugin) for detailed information how to configure RuleKit RapidMiner plugin.
See [this Wiki section](https://github.com/adaa-polsl/RuleKit/wiki/2-RapidMiner-plugin) for detailed information how to configure RuleKit RapidMiner plugin.

## R package

Expand All @@ -74,44 +74,44 @@ Then, build the package with *Install and Restart* button (the appropiate versio

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](./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](../../wiki/3-R-package) contains detailed information on using RuleKit R package.
[This Wiki section](https://github.com/adaa-polsl/RuleKit/wiki/3-R-package) contains detailed information on using RuleKit R package.

## Python package

Rulekit Python package can be found [here](https://github.com/adaa-polsl/RuleKit-python)

# Documentation

The detailed RuleKit documentation can be found on [Wiki pages](../../wiki) which cover the following topics:

1. [Batch interface](../../wiki/1-Batch-interface)
1. [General information](../../wiki/1-Batch-interface#11-general-information)
2. [Parameter set definition](../../wiki/1-Batch-interface#12-parameter-set-definition)
3. [Dataset definition](../../wiki/1-Batch-interface#13-dataset-definition)
4. [Example](../../wiki/1-Batch-interface#14-example)
2. [RapidMiner plugin](../../wiki/2-RapidMiner-plugin)
1. [Installation](../../wiki/2-RapidMiner-plugin#21-installation)
2. [Usage](../../wiki/2-RapidMiner-plugin#22-usage)
3. [Example](../../wiki/2-RapidMiner-plugin#23-example)
3. [R package](../../wiki/3-R-package)
1. [Installation](../../wiki/3-R-package#31-installation)
2. [Usage](../../wiki/3-R-package#32-usage)
3. [Example](../../wiki/3-R-package#33-example)
4. [Quality and evaluation](../../wiki/4-Quality-and-evaluation)
1. [Rule quality](../../wiki/4-Quality-and-evaluation#41-rule-quality)
2. [Model characteristics](../../wiki/4-Quality-and-evaluation#42-model-characteristics)
2. [Performance metrices](../../wiki/4-Quality-and-evaluation#43-performance-metrices)
5. [Output files](../../wiki/5-Output-files)
1. [Training report](../../wiki/5-Output-files#51-training-report)
2. [Prediction performance report](../../wiki/5-Output-files#52-prediction-performance-report)
6. [User-guided induction](../../wiki/6-User-guided-induction)
1. [Defining user's knowledge](../../wiki/6-User-guided-induction#61-defining-users-knowledge)
2. [Examples from GuideR paper](../../wiki/6-User-guided-induction#62-examples-from-guider-paper)
7. [Library API](../../wiki/7-Library-API)
1. [Running an experiment](../../wiki/7-Library-API#71-running-an-experiment)
2. [Developing a new algorithm](../../wiki/7-Library-API#72-developing-a-new-algorithm)
8. [Empirical results](../../wiki/8-Empirical-results)
9. [Contrast set mining](../../wiki/9-Contrast-set-mining)
The detailed RuleKit documentation can be found on [Wiki pages](https://github.com/adaa-polsl/RuleKit/wiki) which cover the following topics:

1. [Batch interface](https://github.com/adaa-polsl/RuleKit/wiki/1-Batch-interface)
1. [General information](https://github.com/adaa-polsl/RuleKit/wiki/1-Batch-interface#11-general-information)
2. [Parameter set definition](https://github.com/adaa-polsl/RuleKit/wiki/1-Batch-interface#12-parameter-set-definition)
3. [Dataset definition](https://github.com/adaa-polsl/RuleKit/wiki/1-Batch-interface#13-dataset-definition)
4. [Example](https://github.com/adaa-polsl/RuleKit/wiki/1-Batch-interface#14-example)
2. [RapidMiner plugin](https://github.com/adaa-polsl/RuleKit/wiki/2-RapidMiner-plugin)
1. [Installation](https://github.com/adaa-polsl/RuleKit/wiki/2-RapidMiner-plugin#21-installation)
2. [Usage](https://github.com/adaa-polsl/RuleKit/wiki/2-RapidMiner-plugin#22-usage)
3. [Example](https://github.com/adaa-polsl/RuleKit/wiki/2-RapidMiner-plugin#23-example)
3. [R package](https://github.com/adaa-polsl/RuleKit/wiki/3-R-package)
1. [Installation](https://github.com/adaa-polsl/RuleKit/wiki/3-R-package#31-installation)
2. [Usage](https://github.com/adaa-polsl/RuleKit/wiki/3-R-package#32-usage)
3. [Example](https://github.com/adaa-polsl/RuleKit/wiki/3-R-package#33-example)
4. [Quality and evaluation](https://github.com/adaa-polsl/RuleKit/wiki/4-Quality-and-evaluation)
1. [Rule quality](https://github.com/adaa-polsl/RuleKit/wiki/4-Quality-and-evaluation#41-rule-quality)
2. [Model characteristics](https://github.com/adaa-polsl/RuleKit/wiki/4-Quality-and-evaluation#42-model-characteristics)
2. [Performance metrices](https://github.com/adaa-polsl/RuleKit/wiki/4-Quality-and-evaluation#43-performance-metrices)
5. [Output files](https://github.com/adaa-polsl/RuleKit/wiki/5-Output-files)
1. [Training report](https://github.com/adaa-polsl/RuleKit/wiki/5-Output-files#51-training-report)
2. [Prediction performance report](https://github.com/adaa-polsl/RuleKit/wiki/5-Output-files#52-prediction-performance-report)
6. [User-guided induction](https://github.com/adaa-polsl/RuleKit/wiki/6-User-guided-induction)
1. [Defining user's knowledge](https://github.com/adaa-polsl/RuleKit/wiki/6-User-guided-induction#61-defining-users-knowledge)
2. [Examples from GuideR paper](https://github.com/adaa-polsl/RuleKit/wiki/6-User-guided-induction#62-examples-from-guider-paper)
7. [Library API](https://github.com/adaa-polsl/RuleKit/wiki/7-Library-API)
1. [Running an experiment](https://github.com/adaa-polsl/RuleKit/wiki/7-Library-API#71-running-an-experiment)
2. [Developing a new algorithm](https://github.com/adaa-polsl/RuleKit/wiki/7-Library-API#72-developing-a-new-algorithm)
8. [Empirical results](https://github.com/adaa-polsl/RuleKit/wiki/8-Empirical-results)
9. [Contrast set mining](https://github.com/adaa-polsl/RuleKit/wiki/9-Contrast-set-mining)

JavaDoc for the project is available [here](https://adaa-polsl.github.io/RuleKit/).

Expand Down
2 changes: 1 addition & 1 deletion adaa.analytics.rules/build.gradle
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ codeQuality {
}

sourceCompatibility = 1.8
version = '1.7.0'
version = '1.7.1'


jar {
Expand Down
196 changes: 0 additions & 196 deletions adaa.analytics.rules/src/main/java/adaa/analytics/rules/consoles/RSupportedConsole.java
View file

This file was deleted.

Loading

0 comments on commit 7a7dd0a

Please sign in to comment.