Skip to content

Commit 4ccb8be

Browse files
committed
Update README (add badges, edit description of framework)
1 parent 50f67d1 commit 4ccb8be

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,29 @@
44

55
---
66

7-
# NiaARM
7+
# NiaARM - Framework for Numerical Association Rule Mining
8+
9+
---
10+
[![PyPI Version](https://img.shields.io/pypi/v/niaarm.svg)](https://pypi.python.org/pypi/niaarm)
11+
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/niaarm.svg)
12+
![PyPI - Downloads](https://img.shields.io/pypi/dm/niaarm.svg)
13+
[![GitHub license](https://img.shields.io/github/license/firefly-cpp/niaarm.svg)](https://github.com/firefly-cpp/NiaARM/blob/main/LICENSE)
14+
![GitHub commit activity](https://img.shields.io/github/commit-activity/w/firefly-cpp/niaarm.svg)
15+
[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/firefly-cpp/niaarm.svg)](http://isitmaintained.com/project/firefly-cpp/niaarm "Average time to resolve an issue")
16+
17+
## General outline of framework
818
NiaARM is a framework for Association Rule Mining based on nature-inspired algorithms for optimization. The framework is fully written in Python and runs on all platforms.
919
NaARM allows users to automatically preprocess the data in a transaction database, to search for association rules and provide pretty output of rules found. This framework also supports numerical and real-valued types of attributes besides the categorical ones. Mining the association rules is defined as an optimization and solved using the nature-inspired algorithms that comes from the related framework called [NiaPy](https://github.com/NiaOrg/NiaPy).
1020

21+
## Detailed insights
22+
Current version witholds (but is not limited to) following functions:
23+
24+
- loading dataset in CSV format,
25+
- preprocessing of data,
26+
- searching for association rules,
27+
- providing output of mined association rules,
28+
- generating statistics about mined association rules
29+
1130
## Installation
1231

1332
### pip3
@@ -24,7 +43,7 @@ For a list of examples see the [examples folder]((examples/).
2443

2544
## Reference Papers:
2645

27-
Ideas in the following papers are composed in a simple framework.
46+
Ideas are based on the following research papers:
2847

2948
[1] I. Fister Jr., A. Iglesias, A. Gálvez, J. Del Ser, E. Osaba, I Fister. [Differential evolution for association rule mining using categorical and numerical attributes](http://www.iztok-jr-fister.eu/static/publications/231.pdf) In: Intelligent data engineering and automated learning - IDEAL 2018, pp. 79-88, 2018.
3049

0 commit comments

Comments
 (0)