{"id":15063977,"url":"https://github.com/firefly-cpp/niaaml-gui","last_synced_at":"2025-12-11T23:12:36.601Z","repository":{"id":45636256,"uuid":"317948207","full_name":"firefly-cpp/NiaAML-GUI","owner":"firefly-cpp","description":"GUI for NiaAML Python package.","archived":false,"fork":false,"pushed_at":"2025-01-28T10:57:51.000Z","size":867,"stargazers_count":6,"open_issues_count":0,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-05T10:16:56.996Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/firefly-cpp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-12-02T18:01:21.000Z","updated_at":"2025-01-28T10:57:54.000Z","dependencies_parsed_at":"2024-08-13T17:19:41.069Z","dependency_job_id":"72ce9b6b-3f90-4b80-b52e-c236e81a9840","html_url":"https://github.com/firefly-cpp/NiaAML-GUI","commit_stats":{"total_commits":46,"total_committers":4,"mean_commits":11.5,"dds":0.5,"last_synced_commit":"66ebe77749caae77e9d202aeca51b92d6e0f380f"},"previous_names":["firefly-cpp/niaaml-gui","lukapecnik/niaaml-gui"],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/firefly-cpp%2FNiaAML-GUI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/firefly-cpp%2FNiaAML-GUI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/firefly-cpp%2FNiaAML-GUI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/firefly-cpp%2FNiaAML-GUI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/firefly-cpp","download_url":"https://codeload.github.com/firefly-cpp/NiaAML-GUI/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248215192,"owners_count":21066619,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-09-25T00:09:36.740Z","updated_at":"2025-12-11T23:12:36.541Z","avatar_url":"https://github.com/firefly-cpp.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n    NiaAML-GUI\n\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://pypi.python.org/pypi/niaaml-gui\"\u003e\n        \u003cimg alt=\"PyPI Version\" src=\"https://img.shields.io/pypi/v/niaaml-gui.svg\"\u003e\n    \u003c/a\u003e\n    \u003cimg alt=\"PyPI - Python Version\" src=\"https://img.shields.io/pypi/pyversions/niaaml-gui.svg\"\u003e\n    \u003cimg alt=\"PyPI - Downloads\" src=\"https://img.shields.io/pypi/dm/niaaml-gui.svg\"\u003e\n        \u003ca href=\"https://repology.org/project/niaaml-gui/versions\"\u003e\n        \u003cimg alt=\"Packaging status\" src=\"https://repology.org/badge/tiny-repos/niaaml-gui.svg\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://src.fedoraproject.org/rpms/NiaAML-GUI\"\u003e\n        \u003cimg alt=\"Fedora package\" src=\"https://img.shields.io/fedora/v/NiaAML-GUI?color=blue\u0026label=Fedora%20Linux\u0026logo=fedora\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/flukapecnik/NiaAML-GUI/blob/master/LICENSE\"\u003e\n        \u003cimg alt=\"GitHub license\" src=\"https://img.shields.io/github/license/lukapecnik/NiaAML-GUI.svg\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/firefly-cpp/NiaAML-GUI/actions/workflows/test.yml\"\u003e\n        \u003cimg alt=\"GitHub Actions\" src=\"https://github.com/firefly-cpp/NiaAML-GUI/actions/workflows/test.yml/badge.svg\"\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003cimg alt=\"GitHub commit activity\" src=\"https://img.shields.io/github/commit-activity/w/lukapecnik/NiaAML-GUI.svg\"\u003e\n    \u003ca href='http://isitmaintained.com/project/lukapecnik/NiaAML-GUI \"Average time to resolve an issue\"'\u003e\n        \u003cimg alt=\"Average time to resolve an issue\" src=\"http://isitmaintained.com/badge/resolution/lukapecnik/NiaAML-GUI.svg\"\u003e\n    \u003c/a\u003e\n    \u003ca href='http://isitmaintained.com/project/lukapecnik/NiaAML-GUI \"Percentage of issues still open\"'\u003e\n        \u003cimg alt=\"Percentage of issues still open\" src=\"http://isitmaintained.com/badge/open/lukapecnik/NiaAML-GUI.svg\"\u003e\n    \u003c/a\u003e\n    \u003cimg alt=\"GitHub contributors\" src=\"https://img.shields.io/github/contributors/lukapecnik/NiaAML-GUI.svg\"\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"#-installation\"\u003e📦 Installation\u003c/a\u003e •\n    \u003ca href=\"#-usage\"\u003e🚀 Usage\u003c/a\u003e •\n    \u003ca href=\"#-example\"\u003e📓 Example\u003c/a\u003e •\n    \u003ca href=\"#-references\"\u003e📝 References\u003c/a\u003e •\n    \u003ca href=\"#-cite-us\"\u003e📄 Cite us\u003c/a\u003e\n\u003c/p\u003e\n\nThis is a basic graphical user interface intended for users of the [NiaAML](https://github.com/firefly-cpp/NiaAML) Python package.\n\n* **Free software:** MIT license\n* **Python versions:** 3.9.x, 3.10.x, 3.11.x, 3.12.x\n\n## 📦 Installation\n\nTo install `NiaAML-GUI` with pip, use:\n\n```sh\npip install niaaml_gui\n```\n\nAfter successful installation, run [main.py](niaaml_gui/main.py):\n\n```sh\npython main.py\n```\n\n### Fedora Linux\n\nTo install `NiaAML-GUI` on Fedora, use:\n\n```sh\n$ dnf install NiaAML-GUI\n```\n\n### Alpine Linux\n\nTo install `NiaAML-GUI` on Alpine Linux, enable Community repository and use:\n\n```sh\n$ apk add niaaml-gui\n```\n\n## 🚀 Usage\n\nNiaAML GUI application allows you to use the main features of the [NiaAML](https://github.com/firefly-cpp/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.**\n\n### Optimization View\n\nBelow is a screenshot of the first view with labeled components and you can find a description for each component under the screenshot.\n\n\u003cp align=\"center\"\u003e\u003cimg src=\".github/gui1.png\" alt=\"NiaAML GUI First View\" title=\"NiaAML GUI First View\"/\u003e\u003c/p\u003e\n\n| Component | Description |\n|:----------|:------------|\n| 1         | Tabbed view for choosing components for the optimization. Clicked components get transferred to their corresponding brackets (labels **5**, **6** and **7**). |\n| 2         | Input CSV dataset's file selection widget. After the dataset has been selected, you can also view and edit it using the edit button next to the `Select file` button. **Also make sure you check the `CSV has header` checkbox in case the selected CSV file has a header row.** Below you can see a screenshot of the CSV file's editing window. \u003cp align=\"center\"\u003e\u003cimg src=\".github/gui3.png\" alt=\"NiaAML GUI Edit Dataset View\" title=\"NiaAML GUI Edit Dataset View\"/\u003e\u003c/p\u003e |\n| 3         | Dropdown widget for categorical features' encoder selection. It will be ignored if the dataset contains no categorical features. |\n| 4         | Dropdown widget for missing data imputer selection. It will be ignored if the dataset contains no missing values. |\n| 5         | List of selected feature selection algorithms (optional). |\n| 6         | List of selected feature transform algorithms (optional). |\n| 7         | List of selected classifiers. |\n| 8         | Dropdown widget for the selection of components' selection optimization algorithm. |\n| 9         | Dropdown widget for the selection of hyperparameters' tuning optimization algorithm. Defaults to **8** if none is selected. |\n| 10        | Population size for the components' selection process. |\n| 11        | Population size for the hyperparameters' tuning process. |\n| 12        | Number of evaluations during the components' selection process. |\n| 13        | Number of evaluations during the hyperparameters' tuning process. |\n| 14        | Dropdown widget for the selection of a fitness function to use during the pipeline evaluation step. |\n| 15        | Destination of the optimization's result (pipeline and text file). |\n\n#### Optimization\n\nBelow you can see screenshots of views during and after the optimization has finished.\n\n\u003cp align=\"center\"\u003e\u003cimg src=\".github/gui2.png\" alt=\"NiaAML GUI Optimization Running\" title=\"NiaAML GUI Optimization Running\"/\u003e\u003c/p\u003e\n\u003cp align=\"center\"\u003e\u003cimg src=\".github/gui4.png\" alt=\"NiaAML GUI Optimization Finished\" title=\"NiaAML GUI Optimization Finished\"/\u003e\u003c/p\u003e\n\n### Usage View\n\nBelow is a screenshot of the second view with labeled components and you can find a description for each component under the screenshot.\n\n\u003cp align=\"center\"\u003e\u003cimg src=\".github/gui5.png\" alt=\"NiaAML GUI Second View\" title=\"NiaAML GUI Second View\"/\u003e\u003c/p\u003e\n\n| Component | Description |\n|:----------|:------------|\n| 1         | Pipeline file selection widget. |\n| 2         | Input CSV file selection widget. The file should contain the same headers (if any) as the dataset in the optimization process and there should be no classes (expected results) present. After the dataset has been selected, you can also view and edit it using the edit button next to the `Select file` button. **Also make sure you check the** `CSV has header` **checkbox in case the selected CSV file has a header row.** |\n\n#### Run\n\nYou get a similar output than in the optimization process, but this time there is an array of predicted values present.\n\n## 📓 Example\n\nLet's say we want to find an optimal classification pipeline for the [Ecoli dataset](https://archive.ics.uci.edu/ml/datasets/ecoli) [[1]](#1). You can see the optimization setup in the screenshot below.\n\n\u003cp align=\"center\"\u003e\u003cimg src=\".github/gui6.png\" alt=\"NiaAML GUI Optimization Setup\" title=\"NiaAML GUI Optimization Setup\"/\u003e\u003c/p\u003e\n\nWe hit the `Start optimization` button and wait... You can see the output in the screenshot below.\n\n\u003cp align=\"center\"\u003e\u003cimg src=\".github/gui7.png\" alt=\"NiaAML GUI Optimization Output\" title=\"NiaAML GUI Optimization Output\"/\u003e\u003c/p\u003e\n\nThere are also 2 new files in the selected destination directory.\n\n\u003cp align=\"center\"\u003e\u003cimg src=\".github/gui8.png\" alt=\"NiaAML GUI Output Files\" title=\"NiaAML GUI Output Files\"/\u003e\u003c/p\u003e\n\nNow we can use the exported pipeline file for further classification on the unseen data.\n\n\u003cp align=\"center\"\u003e\u003cimg src=\".github/gui9.png\" alt=\"NiaAML GUI Run Pipeline\" title=\"NiaAML GUI Run Pipeline\"/\u003e\u003c/p\u003e\n\nThe result for 5 individuals is shown on the screenshot below.\n\n\u003cp align=\"center\"\u003e\u003cimg src=\".github/gui10.png\" alt=\"NiaAML GUI Run Pipeline Result\" title=\"NiaAML GUI Run Pipeline Result\"/\u003e\u003c/p\u003e\n\n## 📝 References\n\n\u003ca id=\"1\"\u003e[1]\u003c/a\u003e Dua, D. and Graff, C. (2019). [UCI Machine Learning Repository](http://archive.ics.uci.edu/ml). Irvine, CA: University of California, School of Information and Computer Science.\n\n## 📄 Cite us\n\nL. Pečnik, I. Fister Jr. \"[NiaAML: AutoML framework based on stochastic population-based nature-inspired algorithms](https://joss.theoj.org/papers/10.21105/joss.02949).\" Journal of Open Source Software 6.61 (2021): 2949.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffirefly-cpp%2Fniaaml-gui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffirefly-cpp%2Fniaaml-gui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffirefly-cpp%2Fniaaml-gui/lists"}