Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,27 @@

# Rulekit


This package is python wrapper for [RuleKit](https://github.com/adaa-polsl/RuleKit) library - a versatile tool for rule learning.

Based on a sequential covering induction algorithm, it is suitable for classification, regression, and survival problems.

## Installation

> **NOTE**:
This package is a wrapper for Java library, and requires Java Development Kit version 8 or later to be installed on the computer. Both Open JDK and Oracle implementations are supported.
##

```bash
pip install rulekit
```

> **NOTE**:
This package is a wrapper for Java library, and requires Java Development Kit version 8 or later to be installed on the computer. Both Open JDK and Oracle implementations are supported.

If you don’t have JDK installed on your computer you can quickly set it up using install-jdk package.
```
pip install install-jdk
```
```python
import jdk
jdk.install('11', jre=True)
```

## Running tests

Expand Down
4 changes: 2 additions & 2 deletions docs/HOW_TO_DEPLOY.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ In root repository directory:
```
rm -r ./dist
python setup.py sdist
python -m twine check dist/*
python -m twine upload dist/*
python -m twine check ./dist/*
python -m twine upload ./dist/*
```
> For the last command use `__token__` as username and your token value as password when prompted.
2 changes: 1 addition & 1 deletion docs/badges/coverage-badge.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/badges/flake8-badge.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/badges/test-badge.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading