Skip to content

firefly-cpp/NiaAML-GUI

Repository files navigation

NiaAML-GUI

PyPI Version PyPI - Python Version PyPI - Downloads Packaging status Fedora package GitHub license GitHub Actions

GitHub commit activity Average time to resolve an issue Percentage of issues still open GitHub contributors

📦 Installation🚀 Usage📓 Example📝 References📄 Cite us

A graphical user interface for building and running machine learning pipelines using the NiaAML framework. This GUI now supports block-based pipeline composition, drag-and-drop components, visual connections, and CSV editing.

  • Free software: MIT license
  • Python versions: 3.10.x, 3.11.x, 3.12.x, 3.13.x

📦 Installation

To install NiaAML-GUI with pip, use:

pip install niaaml_gui

After successful installation, run main.py:

python main.py

Fedora Linux

To install NiaAML-GUI on Fedora, use:

$ dnf install NiaAML-GUI

Alpine Linux

To install NiaAML-GUI on Alpine Linux, enable Community repository and use:

$ apk add niaaml-gui 

🚀 Usage

NiaAML GUI application allows you to use the main features of the NiaAML framework. There are two views in the application. In the first one, you can prepare an environment for a pipeline optimization process. The purpose of the second one is to allow you to use an existing pipeline from a file. The application currently supports data input in the form of CSV files.

Pipeline Canvas View

Below is a screenshot of the first view with labeled components and you can find a description for each component under the screenshot.

NiaAML GUI First View

Component Description
1 Tabbed view for choosing components to be added to the canvas. Components can be dragged and dropped onto the canvas to visually build the pipeline.
2 The canvas area where blocks (components) are placed and connected. Users can construct the pipeline visually by drawing arrows between valid components.
3 "Select CSV File" block. Input dataset selection. Includes a file browser, CSV header checkbox, and an edit button to view/modify the CSV content.

NiaAML GUI Edit Dataset View

4 "Categorical Encoder" block. Allows selection of encoding method for categorical features. Dropdown populated dynamically.
5 "Missing Imputer" block. Allows selection of imputation method to handle missing values.
6 "Feature Selection" block. Multi-selection dialog allows the user to choose one or more feature selection algorithms.
7 "Feature Transform" block. Multi-selection dialog allows choosing one or more feature transformation algorithms.
8 "Classifier" block. Multi-selection dialog for selecting one or more classification models.
9 "Optimization Algorithm (Selection)" block. Dropdown for choosing the optimization algorithm used in component selection.
10 "Optimization Algorithm (Tuning)" block. Dropdown for choosing the algorithm used for hyperparameter tuning.
11 "Population Size (Components Selection)" block. Numeric input for specifying the population size during component selection.
12 "Population Size (Parameter Tuning)" block. Numeric input for specifying the population size for hyperparameter tuning.
13 "Number of Evaluations (Component Selection)" block. Sets the number of allowed evaluations during selection.
14 "Number of Evaluations (Parameter Tuning)" block. Sets the number of evaluations for hyperparameter tuning.
15 "Fitness Function" block. Dropdown for selecting the fitness function used during evaluation of each candidate pipeline.
16 "Pipeline Output Folder" block. Defines the target folder where output files (pipeline, logs, results) are saved.
17 Arrow connections between blocks. Only valid connections are allowed. When drawing, green/red highlights show whether the target is acceptable.
18 Validation system. Before running optimization, the system checks whether all required components are present and properly configured.

Optimization

Below you can see screenshots of views during and after the optimization has finished.

NiaAML GUI Optimization Running

NiaAML GUI Optimization Finished

📓 Example

Let's say we want to find an optimal classification pipeline for the Example dataset. You can see the optimization setup in the screenshot below.

NiaAML GUI Optimization Setup

We hit the Start optimization button and wait... You can see the output in the screenshot below.

NiaAML GUI Optimization Output

There are also 2 new files in the selected destination directory.

NiaAML GUI Output Files

Now we can use the exported pipeline file for further classification on the unseen data.

NiaAML GUI Run Pipeline

📝 References

[1] Dua, D. and Graff, C. (2019). UCI Machine Learning Repository. Irvine, CA: University of California, School of Information and Computer Science.

📄 Cite us

L. Pečnik, I. Fister Jr. "NiaAML: AutoML framework based on stochastic population-based nature-inspired algorithms." Journal of Open Source Software 6.61 (2021): 2949.

About

GUI for NiaAML Python package.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Contributors 6

Languages