Skip to content

Commit f46ea16

Browse files
committed
rename interest measures to interestingness measures
1 parent 0efd71a commit f46ea16

File tree

5 files changed

+12
-13
lines changed

5 files changed

+12
-13
lines changed

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -218,11 +218,10 @@ problem.rules.sort()
218218
problem.rules.to_csv('output.csv')
219219
```
220220

221-
#### Interest measures
221+
#### Interestingness measures
222222

223-
The framework implements several popular interest measures, which can be used to compute the fitness function value of rules
224-
and for assessing the quality of the mined rules. A full list of the implemented interest measures along with their descriptions
225-
and equations can be found [here](interest_measures.md).
223+
The framework implements several popular interestingness measures, which can be used to compute the fitness function value of rules
224+
and for assessing the quality of the mined rules. A full list of the implemented interestingness measures along with their definitions can be found [here](interestingness_measures.md).
226225

227226
### Visualization
228227

docs/getting_started.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ objective, unconstrained maximization problem (more details on this approach can
108108
`here <https://link.springer.com/chapter/10.1007/978-3-030-68154-8_19>`__ and
109109
`here <http://www.iztok-jr-fister.eu/static/publications/231.pdf>`__).
110110
To summarize, for each solution vector a :class:`~niaarm.rule.Rule` is built,
111-
and it's fitness is computed as a weighted sum of selected interest measures (metrics).
111+
and it's fitness is computed as a weighted sum of selected interestingness measures (metrics).
112112
The rule is then appended to a list of rules, which can be accessed through the NiaARM class.
113113

114114
The :class:`~niaarm.niaarm.NiaARM` class takes the dataset's
@@ -317,10 +317,10 @@ added to the :mod:`niaarm.mine` module.
317317
Run time: 13.37s
318318
Rules exported to output.csv
319319
320-
Interest Measures
320+
Interestingness measures
321321
-----------------
322322

323-
The framework currently implements the following interest measures (metrics):
323+
The framework currently implements the following interestingness measures (metrics):
324324

325325
- Support
326326
- Confidence
@@ -336,7 +336,7 @@ The framework currently implements the following interest measures (metrics):
336336
- Yule's Q [#fn]_
337337
- Zhang's Metric [#fn]_
338338

339-
More information about these interest measures can be found in the API reference
339+
More information about these interestingness measures can be found in the API reference
340340
of the :class:`~niaarm.rule.Rule` class.
341341

342342
.. rubric:: Footnotes
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Interest Measures
1+
# Interestingness measures
22

33
## Support
44

paper/paper.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,19 +53,19 @@ analyzed statistically, or visualized using the visualization methods implemente
5353
Numerical Association Rule Mining plays a vital role in the data revolution era [@telikani_survey_2020]. Several research
5454
papers that present NARM methods exist, but universal software where all primary tasks of NARM, i.e., preprocessing, searching
5555
for association rules, and visualization, is lacking. The NiaARM framework provides users with methods that allow them to
56-
preprocess their data, implement several interest measures, and powerful visualization techniques. In a nutshell, the benefits
56+
preprocess their data, implement several interestingness measures, and powerful visualization techniques. In a nutshell, the benefits
5757
of the NiaARM framework are:
5858

5959
1. A simple way to mine association rules on numerical, categorical, or mixed attribute-type datasets.
6060

6161
2. Combined with the NiaPy library, it allows testing out the proposed approach using arbitrary nature-inspired algorithms.
6262

63-
3. A vast collection of implemented popular interest measures to measure the mined rules' quality.
63+
3. A vast collection of implemented popular interestingness measures to measure the mined rules' quality.
6464

6565
4. Powerful visualization methods.
6666

6767
5. A simple command-line interface for easier handling with the proposed tool.
6868

69-
To the authors' knowledge, NiaARM is one of only three publicly available software solutions that implement any form of numerical association rule mining, the other two being KEEL [@alcala2009keel] and uARMSolver [@fister_uarmsolver_2020]. KEEL is a software tool used to assess evolutionary algorithms for machine learning problems of various kinds such as regression, classification, unsupervised learning, etc. It's a GUI application written in Java primarily intended for research and educational purposes. Although its scope is much wider it also includes some popular algorithms for numerical association rule mining including GAR, GENAR and MODENAR. The uARMSolver framework, written in C++, also implements the ARM-DE algorithm. Comparatively, NiaARM offers better ease of use, the ability to use arbitrary nature-inspired algorithms from the NiaPy framework (uARMSolver only implements DE and PSO), and the ability to optimize using more interest measures.
69+
To the authors' knowledge, NiaARM is one of only three publicly available software solutions that implement any form of numerical association rule mining, the other two being KEEL [@alcala2009keel] and uARMSolver [@fister_uarmsolver_2020]. KEEL is a software tool used to assess evolutionary algorithms for machine learning problems of various kinds such as regression, classification, unsupervised learning, etc. It's a GUI application written in Java primarily intended for research and educational purposes. Although its scope is much wider it also includes some popular algorithms for numerical association rule mining including GAR, GENAR and MODENAR. The uARMSolver framework, written in C++, also implements the ARM-DE algorithm. Comparatively, NiaARM offers better ease of use, the ability to use arbitrary nature-inspired algorithms from the NiaPy framework (uARMSolver only implements DE and PSO), and the ability to optimize using more interestingness measures.
7070

7171
# References

src/niaarm/rule.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ class Rule:
1313
transactions (pandas.DataFrame | None): Transactional database.
1414
1515
Attributes:
16-
cls.metrics (tuple[str]): List of all available interest measures.
16+
cls.metrics (tuple[str]): List of all available interestingness measures.
1717
support: Support is defined on an itemset as the proportion of transactions
1818
that contain the attribute :math:`X`.
1919

0 commit comments

Comments
 (0)