|
16 | 16 | [](https://www.gnu.org/licenses/gpl-3.0) |
17 | 17 |
|
18 | 18 |
|
19 | | -GrafoRVFL is an open-source library in Python that employs gradient-free optimization (GA, PSO, WOA, TLO, DE, ...) to |
20 | | -optimize Random Vector Functional Link Networks. It is entirely implemented based on Numpy and fully compatible |
21 | | -with the interfaces of the Scikit-Learn library. With GrafoRVFL, you can fine-tune the hyper-parameters of network in the network using gradient-free optimizers. |
| 19 | +## 📑 Overview |
22 | 20 |
|
| 21 | +**GrafoRVFL** is an open-source Python library designed to optimize Random Vector Functional Link (RVFL) networks using |
| 22 | +various **gradient-free metaheuristic algorithms** such as GA, PSO, WOA, TLO, DE, etc. It is fully implemented in |
| 23 | +**NumPy** and seamlessly integrates with the **Scikit-Learn** interface, making it easy to plug into standard |
| 24 | +ML workflows. GrafoRVFL enables hyperparameter tuning for RVFL networks without relying on gradient-based methods. |
23 | 25 |
|
24 | | -* **Free software:** GNU General Public License (GPL) V3 license |
25 | | -* **Documentation:** https://graforvfl.readthedocs.io |
26 | | -* **Provided Estimator**: `RvflRegressor`, `RvflClassifier`, `GfoRvflCV`, `GfoRvflTuner`, `GfoRvflComparator` |
27 | | -* **Python versions:** >= 3.8.x |
28 | | -* **Dependencies:** numpy, scipy, scikit-learn, pandas, mealpy, permetrics, matplotlib |
29 | 26 |
|
| 27 | +## ✨ Features |
30 | 28 |
|
31 | | -# Citation Request |
| 29 | +- ✅ Free software under **GNU GPL v3** |
| 30 | +- 📘 Full documentation: [https://graforvfl.readthedocs.io](https://graforvfl.readthedocs.io) |
| 31 | +- 🧠 Estimators: |
| 32 | + - `RvflRegressor` |
| 33 | + - `RvflClassifier` |
| 34 | + - `GfoRvflCV` |
| 35 | + - `GfoRvflTuner` |
| 36 | + - `GfoRvflComparator` |
| 37 | +- 🐍 Python compatibility: `>= 3.8` |
| 38 | +- 🧩 Dependencies: |
| 39 | + - `numpy`, `scipy`, `scikit-learn`, `pandas`, `mealpy`, `permetrics`, `matplotlib` |
32 | 40 |
|
33 | | -* Learn more about Random Vector Functional Link from [this paper](https://doi.org/10.1016/j.ins.2015.09.025) |
34 | | - |
35 | | -* Learn more about on how to use Gradient Free Optimization to fine-tune the hyper-parameter of RVFL networks from |
36 | | -[this paper](https://doi.org/10.1016/j.neucom.2018.07.080) |
37 | 41 |
|
| 42 | +## 📖 Citation Request |
38 | 43 |
|
39 | 44 | Please include these citations if you plan to use this library: |
40 | 45 |
|
41 | 46 | ```bibtex |
42 | | -
|
43 | 47 | @software{nguyen_van_thieu_2023_10258280, |
44 | 48 | author = {Nguyen Van Thieu}, |
45 | 49 | title = {GrafoRVFL: A Gradient-Free Optimization Framework for Boosting Random Vector Functional Link Network}, |
@@ -77,29 +81,33 @@ Please include these citations if you plan to use this library: |
77 | 81 | organization={IEEE}, |
78 | 82 | doi={10.1109/SOCA.2018.00014} |
79 | 83 | } |
80 | | -
|
81 | 84 | ``` |
82 | 85 |
|
83 | | -# Installation |
| 86 | +* Learn more about Random Vector Functional Link from [this paper](https://doi.org/10.1016/j.ins.2015.09.025) |
84 | 87 |
|
85 | | -* Install the [current PyPI release](https://pypi.python.org/pypi/graforvfl): |
86 | | -```sh |
| 88 | +* Learn more about on how to use Gradient Free Optimization to fine-tune the hyper-parameter of RVFL networks from |
| 89 | +[this paper](https://doi.org/10.1016/j.neucom.2018.07.080) |
| 90 | + |
| 91 | + |
| 92 | +## 🔧 Installation |
| 93 | + |
| 94 | +Install the latest version from PyPI: |
| 95 | + |
| 96 | +```bash |
87 | 97 | $ pip install graforvfl |
88 | 98 | ``` |
89 | 99 |
|
90 | | -After installation, you can check the installed version by: |
| 100 | +Verify installation: |
91 | 101 |
|
92 | | -```sh |
| 102 | +```bash |
93 | 103 | $ python |
94 | 104 | >>> import graforvfl |
95 | 105 | >>> graforvfl.__version__ |
96 | 106 | ``` |
97 | 107 |
|
98 | | -# Example |
| 108 | +## 🧪 Example Usage |
99 | 109 |
|
100 | 110 | Below is a simple example code of how to use Gradient Free Optimization to tune hyper-parameter of RVFL network. |
101 | | -The more complicated cases in the folder: [examples](/examples). You can also read the [documentation](https://graforvfl.readthedocs.io/) |
102 | | -for more detailed installation instructions, explanations, and examples. |
103 | 111 |
|
104 | 112 | ```python |
105 | 113 | from sklearn.datasets import load_breast_cancer |
@@ -144,14 +152,18 @@ print(model.best_estimator) |
144 | 152 | print(model.best_estimator.scores(data.X_test, data.y_test, list_metrics=("PS", "RS", "NPV", "F1S", "F2S"))) |
145 | 153 | ``` |
146 | 154 |
|
147 | | -# Official channels |
| 155 | +👉 The more complicated cases in the folder: [examples](/examples). You can also read the [documentation](https://graforvfl.readthedocs.io/) |
| 156 | +for more detailed installation instructions, explanations, and examples. |
| 157 | + |
| 158 | + |
| 159 | +## 📎 Official channels |
148 | 160 |
|
149 | | -* [Official source code repository](https://github.com/thieu1995/GrafoRVFL) |
150 | | -* [Official document](https://graforvfl.readthedocs.io/) |
151 | | -* [Download releases](https://pypi.org/project/graforvfl/) |
152 | | -* [Issue tracker](https://github.com/thieu1995/GrafoRVFL/issues) |
153 | | -* [Notable changes log](/ChangeLog.md) |
154 | | -* [Official discussion group](https://t.me/+fRVCJGuGJg1mNDg1) |
| 161 | +* 🔗 [Official source code repository](https://github.com/thieu1995/GrafoRVFL) |
| 162 | +* 📘 [Official document](https://graforvfl.readthedocs.io/) |
| 163 | +* 📦 [Download releases](https://pypi.org/project/graforvfl/) |
| 164 | +* 🐞 [Issue tracker](https://github.com/thieu1995/GrafoRVFL/issues) |
| 165 | +* 📝 [Notable changes log](/ChangeLog.md) |
| 166 | +* 💬 [Official discussion group](https://t.me/+fRVCJGuGJg1mNDg1) |
155 | 167 |
|
156 | 168 | --- |
157 | 169 |
|
|
0 commit comments