Metadata-Version: 2.1
Name: NiaAutoARM
Version: 0.1.1
Summary: Automated generation and evaluation of Association Rule Mining pipelines
Home-page: https://github.com/firefly-cpp/NiaAutoARM
Keywords: association rule mining,computational intelligence,data mining,datasets,optimization
Author: Uroš Mlakar
Author-email: uros.mlakar@um.si
Requires-Python: >=3.9,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: niaarm (>=0.3.12,<0.4.0)
Requires-Dist: niapy (>=2.0.5,<3.0.0)
Requires-Dist: pandas (>=2.1.1,<3.0.0)
Project-URL: Repository, https://github.com/firefly-cpp/NiaAutoARM
Description-Content-Type: text/markdown

<p align="center">
  <img alt="logo" width="500" src=".github/images/NiaAutoARM.png">
</p>

# NiaAutoARM

A novel AutoML method for automatically constructing the full association rule mining pipelines based on stochastic population-based metaheuristics.

## About

The numerical association rule mining paradigm that includes concurrent dealing with numerical and categorical attributes is beneficial for discovering associations from datasets that consist of both features. The process is not considered as easy since it incorporates several components that form an entire pipeline, i.e., preprocessing, algorithm selection, hyperparameter optimization, and the definition of metrics that evaluate the quality of the association rule. NiaAutoARM software aims to automatize this process and reduce the need for the user's effort to discover association rules.

## How it works?

See the following [preprint](https://arxiv.org/pdf/2501.00138) for more information.

## Installation 📦

### pip

Install NiaARM with pip:

```sh
pip install niaautoarm
```
## Usage 🚀

## 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)

## References
[1] Ž. 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.

[2] L. Pečnik, Fister, I., Fister, I. Jr. [NiaAML2: An Improved AutoML Using Nature-Inspired Algorithms](https://doi.org/10.1007/978-3-030-78811-7_23). In International Conference on Swarm Intelligence (pp. 243-252). Springer, Cham, 2021.

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

## Disclaimer
This framework is provided as-is, and there are no guarantees that it fits your purposes or that it is bug-free. Use it at your own risk!

