Merge branch 'firefly-cpp:main' into feature/scatter-plot-grouped-matrix-plot-viz

Author: BukovnikMiha

.all-contributorsrc

@@ -0,0 +1,81 @@
+{
+  "files": [
+    "README.md"
+  ],
+  "imageSize": 100,
+  "commit": false,
+  "commitType": "docs",
+  "commitConvention": "angular",
+  "contributors": [
+    {
+      "login": "zStupan",
+      "name": "zStupan",
+      "avatar_url": "https://avatars.githubusercontent.com/u/48752988?v=4",
+      "profile": "https://github.com/zStupan",
+      "contributions": [
+        "code",
+        "bug",
+        "doc",
+        "content",
+        "ideas",
+        "example"
+      ]
+    },
+    {
+      "login": "firefly-cpp",
+      "name": "Iztok Fister Jr.",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1633361?v=4",
+      "profile": "http://www.iztok.xyz",
+      "contributions": [
+        "code",
+        "bug",
+        "mentoring",
+        "maintenance",
+        "ideas"
+      ]
+    },
+    {
+      "login": "erkankarabulut",
+      "name": "Erkan Karabulut",
+      "avatar_url": "https://avatars.githubusercontent.com/u/15374776?v=4",
+      "profile": "https://erkankarabulut.github.io",
+      "contributions": [
+        "code",
+        "bug"
+      ]
+    },
+    {
+      "login": "lahovniktadej",
+      "name": "Tadej Lahovnik",
+      "avatar_url": "https://avatars.githubusercontent.com/u/57890734?v=4",
+      "profile": "https://github.com/lahovniktadej",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "musicinmybrain",
+      "name": "Ben Beasley",
+      "avatar_url": "https://avatars.githubusercontent.com/u/6898909?v=4",
+      "profile": "https://github.com/musicinmybrain",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "rhododendrom",
+      "name": "Dusan Fister",
+      "avatar_url": "https://avatars.githubusercontent.com/u/3198785?v=4",
+      "profile": "http://www.dusanfister.com",
+      "contributions": [
+        "design"
+      ]
+    }
+  ],
+  "contributorsPerLine": 7,
+  "skipCi": true,
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "projectName": "NiaARM",
+  "projectOwner": "firefly-cpp"
+}

CHANGELOG.md

@@ -1,5 +1,67 @@
 # Changelog
 
+## [0.3.9](https://github.com/firefly-cpp/NiaARM/tree/0.3.9) (2024-04-12)
+
+[Full Changelog](https://github.com/firefly-cpp/NiaARM/compare/0.3.8...0.3.9)
+
+**Fixed bugs:**
+
+- Bug Report: RuntimeWarning: invalid value encountered in scalar divide [\#112](https://github.com/firefly-cpp/NiaARM/issues/112)
+
+**Merged pull requests:**
+
+- Bump idna from 3.4 to 3.7 in /docs [\#126](https://github.com/firefly-cpp/NiaARM/pull/126) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump idna from 3.4 to 3.7 [\#125](https://github.com/firefly-cpp/NiaARM/pull/125) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump pillow from 10.2.0 to 10.3.0 in /docs [\#124](https://github.com/firefly-cpp/NiaARM/pull/124) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump pillow from 10.2.0 to 10.3.0 [\#123](https://github.com/firefly-cpp/NiaARM/pull/123) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Dependency version [\#122](https://github.com/firefly-cpp/NiaARM/pull/122) ([lahovniktadej](https://github.com/lahovniktadej))
+- docs: add rhododendrom as a contributor for design [\#120](https://github.com/firefly-cpp/NiaARM/pull/120) ([allcontributors[bot]](https://github.com/apps/allcontributors))
+- docs: add musicinmybrain as a contributor for doc [\#119](https://github.com/firefly-cpp/NiaARM/pull/119) ([allcontributors[bot]](https://github.com/apps/allcontributors))
+- docs: add lahovniktadej as a contributor for doc [\#118](https://github.com/firefly-cpp/NiaARM/pull/118) ([allcontributors[bot]](https://github.com/apps/allcontributors))
+- docs: add erkankarabulut as a contributor for code, and bug [\#117](https://github.com/firefly-cpp/NiaARM/pull/117) ([allcontributors[bot]](https://github.com/apps/allcontributors))
+- docs: add firefly-cpp as a contributor for code, bug, and 3 more [\#116](https://github.com/firefly-cpp/NiaARM/pull/116) ([allcontributors[bot]](https://github.com/apps/allcontributors))
+- docs: add zStupan as a contributor for code, bug, and 4 more [\#115](https://github.com/firefly-cpp/NiaARM/pull/115) ([allcontributors[bot]](https://github.com/apps/allcontributors))
+- Add Leverage Rule Quality Criterion [\#114](https://github.com/firefly-cpp/NiaARM/pull/114) ([erkankarabulut](https://github.com/erkankarabulut))
+
+## [0.3.8](https://github.com/firefly-cpp/NiaARM/tree/0.3.8) (2024-03-13)
+
+[Full Changelog](https://github.com/firefly-cpp/NiaARM/compare/0.3.7...0.3.8)
+
+**Merged pull requests:**
+
+- Fix division by zero error during acc calculation [\#113](https://github.com/firefly-cpp/NiaARM/pull/113) ([erkankarabulut](https://github.com/erkankarabulut))
+
+## [0.3.7](https://github.com/firefly-cpp/NiaARM/tree/0.3.7) (2024-02-10)
+
+[Full Changelog](https://github.com/firefly-cpp/NiaARM/compare/0.3.6...0.3.7)
+
+**Implemented enhancements:**
+
+- Do not save "similar rules" [\#103](https://github.com/firefly-cpp/NiaARM/issues/103)
+
+**Closed issues:**
+
+- Large datasets [\#93](https://github.com/firefly-cpp/NiaARM/issues/93)
+
+**Merged pull requests:**
+
+- Do not save similar rules [\#109](https://github.com/firefly-cpp/NiaARM/pull/109) ([zStupan](https://github.com/zStupan))
+- Bump jinja2 from 3.1.2 to 3.1.3 [\#108](https://github.com/firefly-cpp/NiaARM/pull/108) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Bump pillow from 10.1.0 to 10.2.0 [\#107](https://github.com/firefly-cpp/NiaARM/pull/107) ([dependabot[bot]](https://github.com/apps/dependabot))
+- README enhancement [\#106](https://github.com/firefly-cpp/NiaARM/pull/106) ([lahovniktadej](https://github.com/lahovniktadej))
+
+## [0.3.6](https://github.com/firefly-cpp/NiaARM/tree/0.3.6) (2024-01-26)
+
+[Full Changelog](https://github.com/firefly-cpp/NiaARM/compare/0.3.5...0.3.6)
+
+**Closed issues:**
+
+- Zhang's metric [\#104](https://github.com/firefly-cpp/NiaARM/issues/104)
+
+**Merged pull requests:**
+
+- Implemented Zhang's Metric [\#105](https://github.com/firefly-cpp/NiaARM/pull/105) ([zStupan](https://github.com/zStupan))
+
 ## [0.3.5](https://github.com/firefly-cpp/NiaARM/tree/0.3.5) (2023-11-01)
 
 [Full Changelog](https://github.com/firefly-cpp/NiaARM/compare/0.3.4...0.3.5)

CONTRIBUTING.md

@@ -35,21 +35,25 @@ All the project's dependencies should be installed and the project ready for fur
 
 | Package | Version | Platform |
 |---------|:-------:|:--------:|
-| niapy   | ^2.0.1  |   All    |
-| pandas  | ^1.3.5  |   All    |
-| numpy   | ^1.21.5 |   All    |
+| niapy   | ^2.0.5  |   All    |
+| numpy   | ^1.26.1 |   All    |
+| pandas  | ^2.1.1  |   All    |
+| nltk    | ^3.8.1  |   All    |
+| tomli   | ^2.0.1  |   All    |
 
 #### Development dependencies
 
-| Package | Version | Platform |
-|---------|:-------:|:--------:|
-| pytest  | ^7.0.1  |   Any    |
+| Package          | Version | Platform |
+|------------------|:-------:|:--------:|
+| pytest           | ^7.4.2  |   Any    |
+| pytest-cov       | ^4.1.0  |   Any    |
+| pytest.randomly  | ^3.15.0 |   Any    |
 
 #### Extras
 
 | Package              | Version | Platform |
 |----------------------|:-------:|:--------:|
-| sphinx               | ^4.4.0  |   Any    |
+| sphinx               | ^7.2.6  |   Any    |
 | sphinx-rtd-theme     | ^1.0.0  |   Any    |
 | sphinxcontrib-bibtex | ^2.4.1  |   Any    |
 

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021-2023 Žiga Stupan and Iztok Fister Jr.
+Copyright (c) 2021-2024 Žiga Stupan and Iztok Fister Jr.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -2,11 +2,8 @@
   <img alt="logo" width="300" src="https://raw.githubusercontent.com/firefly-cpp/NiaARM/main/.github/images/logo.png">
 </p>
 
----
-
 # NiaARM - A minimalistic framework for Numerical Association Rule Mining
 
----
 [![PyPI Version](https://img.shields.io/pypi/v/niaarm.svg)](https://pypi.python.org/pypi/niaarm)
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/niaarm.svg)
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/niaarm.svg)
@@ -18,25 +15,26 @@
 [![AUR package](https://img.shields.io/aur/version/python-niaarm?color=blue&label=Arch%20Linux&logo=arch-linux)](https://aur.archlinux.org/packages/python-niaarm)
 [![Packaging status](https://repology.org/badge/tiny-repos/python:niaarm.svg)](https://repology.org/project/python:niaarm/versions)
 [![DOI](https://joss.theoj.org/papers/10.21105/joss.04448/status.svg)](https://doi.org/10.21105/joss.04448)
+[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
 
-
-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 integral 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](https://github.com/NiaOrg/NiaPy).
-
-* **Documentation:** https://niaarm.readthedocs.io/en/latest/
+* **Documentation:** https://niaarm.readthedocs.io/en/latest
 * **Tested OS:** Windows, Ubuntu, Fedora, Alpine, Arch, macOS. **However, that does not mean it does not work on others**
 
-## Detailed insights
+## About 📋
+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 integral 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](https://github.com/NiaOrg/NiaPy). 🔗
+
+## Detailed insights 🔍 
 The current version includes (but is not limited to) the following functions:
 
-- loading datasets in CSV format,
-- preprocessing of data,
-- searching for association rules,
-- providing output of mined association rules,
-- generating statistics about mined association rules,
-- visualization of association rules,
-- association rule text mining (experimental).
+- loading datasets in CSV format 📁
+- preprocessing of data 🧹
+- searching for association rules 🔎
+- providing output of mined association rules 📋
+- generating statistics about mined association rules 📊
+- visualization of association rules 📈
+- association rule text mining (experimental) 📄
 
-## Installation
+## Installation 📦
 
 ### pip
 
@@ -70,7 +68,7 @@ To install NiaARM on NixOS, please use:
 nix-env -iA nixos.python311Packages.niaarm
 ```
 
-## Usage
+## Usage 🚀
 
 ### Loading data
 
@@ -89,7 +87,7 @@ data = Dataset(df)
 print(data) # printing the dataset will generate a feature report
 ```
 
-#### Option 2: From CSV file directly
+#### Option 2: Directly from a CSV file
 
 ```python
 from niaarm import Dataset
@@ -279,7 +277,7 @@ options:
 ```
 Note: The CLI script can also run as a python module (`python -m niaarm ...`)
 
-## Reference Papers:
+## Reference Papers 📚
 
 Ideas are based on the following research papers:
 
@@ -299,6 +297,12 @@ Ideas are based on the following research papers:
 
 [6] I. Fister, I. Fister Jr., D. Novak and D. Verber, [Data squashing as preprocessing in association rule mining](https://iztok-jr-fister.eu/static/publications/300.pdf), 2022 IEEE Symposium Series on Computational Intelligence (SSCI), Singapore, Singapore, 2022, pp. 1720-1725, doi: [10.1109/SSCI51031.2022.10022240](https://doi.org/10.1109/SSCI51031.2022.10022240).
 
+## See also
+
+[1] [NiaARM.jl: Numerical Association Rule Mining in Julia](https://github.com/firefly-cpp/NiaARM.jl)
+
+[2] [arm-preprocessing: Implementation of several preprocessing techniques for Association Rule Mining (ARM)](https://github.com/firefly-cpp/arm-preprocessing)
+
 ## License
 
 This package is distributed under the MIT License. This license can be found online at <http://www.opensource.org/licenses/MIT>.
@@ -310,3 +314,30 @@ This framework is provided as-is, and there are no guarantees that it fits your
 ## Cite us
 
 Stupan, Ž., & Fister Jr., I. (2022). [NiaARM: A minimalistic framework for Numerical Association Rule Mining](https://www.theoj.org/joss-papers/joss.04448/10.21105.joss.04448.pdf). Journal of Open Source Software, 7(77), 4448.
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/zStupan"><img src="https://avatars.githubusercontent.com/u/48752988?v=4?s=100" width="100px;" alt="zStupan"/><br /><sub><b>zStupan</b></sub></a><br /><a href="https://github.com/firefly-cpp/NiaARM/commits?author=zStupan" title="Code">💻</a> <a href="https://github.com/firefly-cpp/NiaARM/issues?q=author%3AzStupan" title="Bug reports">🐛</a> <a href="https://github.com/firefly-cpp/NiaARM/commits?author=zStupan" title="Documentation">📖</a> <a href="#content-zStupan" title="Content">🖋</a> <a href="#ideas-zStupan" title="Ideas, Planning, & Feedback">🤔</a> <a href="#example-zStupan" title="Examples">💡</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://www.iztok.xyz"><img src="https://avatars.githubusercontent.com/u/1633361?v=4?s=100" width="100px;" alt="Iztok Fister Jr."/><br /><sub><b>Iztok Fister Jr.</b></sub></a><br /><a href="https://github.com/firefly-cpp/NiaARM/commits?author=firefly-cpp" title="Code">💻</a> <a href="https://github.com/firefly-cpp/NiaARM/issues?q=author%3Afirefly-cpp" title="Bug reports">🐛</a> <a href="#mentoring-firefly-cpp" title="Mentoring">🧑‍🏫</a> <a href="#maintenance-firefly-cpp" title="Maintenance">🚧</a> <a href="#ideas-firefly-cpp" title="Ideas, Planning, & Feedback">🤔</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://erkankarabulut.github.io"><img src="https://avatars.githubusercontent.com/u/15374776?v=4?s=100" width="100px;" alt="Erkan Karabulut"/><br /><sub><b>Erkan Karabulut</b></sub></a><br /><a href="https://github.com/firefly-cpp/NiaARM/commits?author=erkankarabulut" title="Code">💻</a> <a href="https://github.com/firefly-cpp/NiaARM/issues?q=author%3Aerkankarabulut" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/lahovniktadej"><img src="https://avatars.githubusercontent.com/u/57890734?v=4?s=100" width="100px;" alt="Tadej Lahovnik"/><br /><sub><b>Tadej Lahovnik</b></sub></a><br /><a href="https://github.com/firefly-cpp/NiaARM/commits?author=lahovniktadej" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/musicinmybrain"><img src="https://avatars.githubusercontent.com/u/6898909?v=4?s=100" width="100px;" alt="Ben Beasley"/><br /><sub><b>Ben Beasley</b></sub></a><br /><a href="https://github.com/firefly-cpp/NiaARM/commits?author=musicinmybrain" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://www.dusanfister.com"><img src="https://avatars.githubusercontent.com/u/3198785?v=4?s=100" width="100px;" alt="Dusan Fister"/><br /><sub><b>Dusan Fister</b></sub></a><br /><a href="#design-rhododendrom" title="Design">🎨</a></td>
+    </tr>
+  </tbody>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

docs/conf.py

@@ -18,11 +18,11 @@
 # -- Project information -----------------------------------------------------
 
 project = "NiaARM"
-copyright = "2022-2023, Žiga Stupan, Iztok Fister Jr."
+copyright = "2022-2024, Žiga Stupan, Iztok Fister Jr."
 author = "Žiga Stupan, Iztok Fister Jr."
 
 # The full version, including alpha/beta/rc tags
-release = "0.3.5"
+release = "0.3.9"
 
 
 # -- General configuration ---------------------------------------------------

docs/getting_started.rst

@@ -334,6 +334,7 @@ The framework currently implements the following interest measures (metrics):
 - Comprehensibility
 - Netconf [#fn]_
 - Yule's Q [#fn]_
+- Zhang's Metric [#fn]_
 
 More information about these interest measures can be found in the API reference
 of the :class:`~niaarm.rule.Rule` class.

docs/installation.rst

@@ -34,12 +34,14 @@ Dependencies
 +================+==============+============+
 | niapy          | ^2.0.5       | All        |
 +----------------+--------------+------------+
-| pandas         | ^2.1.1       | All        |
-+----------------+--------------+------------+
 | numpy          | ^1.26.1      | All        |
 +----------------+--------------+------------+
+| pandas         | ^2.1.1       | All        |
++----------------+--------------+------------+
 | nltk           | ^3.8.1       | All        |
 +----------------+--------------+------------+
+| tomli          | ^2.0.1       | All        |
++----------------+--------------+------------+
 
 Development Dependencies
 ~~~~~~~~~~~~~~~~~~~~~~~~
@@ -58,9 +60,9 @@ Test Dependencies
 +====================+===========+============+
 | pytest             | ^7.4.2    | Any        |
 +--------------------+-----------+------------+
-| pytest-cov         | ^7.4.2    | Any        |
+| pytest-cov         | ^4.1.0    | Any        |
 +--------------------+-----------+------------+
-| pytest-randomly    | ^7.4.2    | Any        |
+| pytest-randomly    | ^3.15.0   | Any        |
 +--------------------+-----------+------------+
 
 Documentation dependencies