Skip to content

Commit 998178d

Browse files
committed
Update docs
1 parent ff0f396 commit 998178d

File tree

2 files changed

+13
-4
lines changed

2 files changed

+13
-4
lines changed

README.md

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

55
---
66

7-
# NiaARM - Framework for Numerical Association Rule Mining
7+
# NiaARM - NiaARM is a minimalistic framework for numerical association rule mining.
88

99
---
1010
[![PyPI Version](https://img.shields.io/pypi/v/niaarm.svg)](https://pypi.python.org/pypi/niaarm)
@@ -24,7 +24,7 @@ The current version witholds (but is not limited to) the following functions:
2424
- preprocessing of data,
2525
- searching for association rules,
2626
- providing output of mined association rules,
27-
- generating statistics about mined association rules
27+
- generating statistics about mined association rules.
2828

2929
## Installation
3030

docs/index.rst

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,20 @@ NiaARM is a minimalistic framework for numerical association rule mining.
1212
General outline of the framework
1313
---------------------------------
1414

15-
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. 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.
15+
NiaARM is a framework for Association Rule Mining based on nature-inspired algorithms for optimization. The framework is written fully in Python and runs on all platforms. NiaARM allows users to preprocess the data in a transaction database automatically, to search for association rules and provide a pretty output of the 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 problem, and solved using the nature-inspired algorithms that come from the related framework called NiaPy.
1616

17-
Detailed features
17+
Detailed insights
1818
-----------------------
1919

20+
The current version witholds (but is not limited to) the following functions:
21+
22+
- loading datasets in CSV format,
23+
- preprocessing of data,
24+
- searching for association rules,
25+
- providing output of mined association rules,
26+
- generating statistics about mined association rules.
27+
28+
2029
Documentation
2130
=============
2231

0 commit comments

Comments
 (0)