Merge pull request #54 from zStupan/main

Add visualization example

Author: zStupan

.github/images/hill_slopes.png

@@ -138,18 +138,22 @@ problem.rules.to_csv('output.csv')
 
 ### Visualization
 
-The framework currently supports the hill slopes visualization method presented in [4].
+The framework currently supports the hill slopes visualization method presented in [4]. More visualization methods are planned
+to be implemented in future releases.
 
 ```python
 from matplotlib import pyplot as plt
+from niaarm import Dataset, RuleList, get_rules
 from niaarm.visualize import hill_slopes
 
-# load data...
-# mine rules...
-
-hill_slopes(rule, dataset.transactions)
+dataset = Dataset('datasets/Abalone.csv')
+metrics = ('support', 'confidence')
+rules, _ = get_rules(dataset, 'DifferentialEvolution', metrics, max_evals=1000, seed=1234)
+some_rule = rules[150]
+hill_slopes(some_rule, dataset.transactions)
 plt.show()
 ```
+
 <p>
     <img alt="logo" src="https://raw.githubusercontent.com/firefly-cpp/NiaARM/main/.github/images/hill_slopes.png">
 </p>

README.md

@@ -193,6 +193,30 @@ The same example as above, using :class:`~niaarm.mine.get_rules`:
     Run Time: 6.9498 seconds
     Rules exported to output.csv
 
+Visualization
+~~~~~~~~~~~~~
+
+The :mod:`~niaarm.visualize` module provides functions for plotting association rules.
+The only visualization method currently implemented is the :func:`~niaarm.visualize.hill_slopes` method,
+presented in `this paper <https://link.springer.com/chapter/10.1007/978-3-030-62362-3_10>`_.
+
+.. code:: python
+
+    from matplotlib import pyplot as plt
+    from niaarm import Dataset, RuleList, get_rules
+    from niaarm.visualize import hill_slopes
+
+    dataset = Dataset('datasets/Abalone.csv')
+    metrics = ('support', 'confidence')
+    rules, _ = get_rules(dataset, 'DifferentialEvolution', metrics, max_evals=1000, seed=1234)
+    some_rule = rules[150]
+    hill_slopes(some_rule, dataset.transactions)
+    plt.show()
+
+**Output:**
+
+.. image:: _static/hill_slopes.png
+
 Interest Measures
 -----------------
 

docs/_static/hill_slopes.png

@@ -0,0 +1,11 @@
+from matplotlib import pyplot as plt
+from niaarm import Dataset, RuleList, get_rules
+from niaarm.visualize import hill_slopes
+
+dataset = Dataset('datasets/Abalone.csv')
+metrics = ('support', 'confidence')
+rules, _ = get_rules(dataset, 'DifferentialEvolution', metrics, max_evals=1000, seed=1234)
+some_rule = rules[150]
+print(some_rule)
+fig, ax = hill_slopes(some_rule, dataset.transactions)
+plt.show()