Skip to content

Commit dcf94ce

Browse files
committed
Update README.md
1 parent bb7fd06 commit dcf94ce

File tree

8 files changed

+25
-1
lines changed

8 files changed

+25
-1
lines changed
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

.github/images/hill_slopes.png

187 KB
Loading
File renamed without changes.

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<p align="center">
2-
<img alt="logo" width="300" src="https://raw.githubusercontent.com/firefly-cpp/NiaARM/main/.github/logo/logo.png">
2+
<img alt="logo" width="300" src="https://raw.githubusercontent.com/firefly-cpp/NiaARM/main/.github/images/logo.png">
33
</p>
44

55
---
@@ -28,6 +28,7 @@ The current version includes (but is not limited to) the following functions:
2828
- searching for association rules,
2929
- providing output of mined association rules,
3030
- generating statistics about mined association rules.
31+
- visualization of association rules
3132

3233
## Installation
3334

@@ -135,6 +136,25 @@ problem.rules.sort()
135136
problem.rules.to_csv('output.csv')
136137
```
137138

139+
### Visualization
140+
141+
The framework currently supports the hill slopes visualization method presented in [4].
142+
143+
```python
144+
from matplotlib import pyplot as plt
145+
from niaarm.visualize import hill_slopes
146+
147+
# load data...
148+
# mine rules...
149+
150+
hill_slopes(rule, dataset.transactions)
151+
plt.show()
152+
```
153+
<p>
154+
<img alt="logo" width="300" src="https://raw.githubusercontent.com/firefly-cpp/NiaARM/main/.github/images/hill_slopes.png">
155+
</p>
156+
157+
138158
For a full list of examples see the [examples folder](https://github.com/firefly-cpp/NiaARM/tree/main/examples)
139159
in the GitHub repository.
140160

@@ -190,6 +210,10 @@ Ideas are based on the following research papers:
190210

191211
[3] I. Fister Jr., I. Fister [A brief overview of swarm intelligence-based algorithms for numerical association rule mining](https://arxiv.org/abs/2010.15524). arXiv preprint arXiv:2010.15524 (2020).
192212

213+
[4] Fister, I. et al. (2020). Visualization of Numerical Association Rules by Hill Slopes.
214+
In: Analide, C., Novais, P., Camacho, D., Yin, H. (eds) Intelligent Data Engineering and Automated Learning – IDEAL 2020.
215+
IDEAL 2020. Lecture Notes in Computer Science(), vol 12489. Springer, Cham. https://doi.org/10.1007/978-3-030-62362-3_10
216+
193217
## License
194218

195219
This package is distributed under the MIT License. This license can be found online at <http://www.opensource.org/licenses/MIT>.

0 commit comments

Comments
 (0)