Metadata-Version: 2.1
Name: evorbf
Version: 2.0.0
Summary: EvoRBF: A Nature-inspired Algorithmic Framework for Evolving Radial Basis Function Networks
Home-page: https://github.com/thieu1995/evorbf
Author: Thieu
Author-email: nguyenthieu2102@gmail.com
License: GPLv3
Project-URL: Documentation, https://evorbf.readthedocs.io/
Project-URL: Source Code, https://github.com/thieu1995/evorbf
Project-URL: Bug Tracker, https://github.com/thieu1995/evorbf/issues
Project-URL: Change Log, https://github.com/thieu1995/evorbf/blob/master/ChangeLog.md
Project-URL: Forum, https://t.me/+fRVCJGuGJg1mNDg1
Description: 
        <p align="center">
        <img style="max-width:100%;" src="https://thieu1995.github.io/post/2023-08/evorbf1.png" alt="EvoRBF"/>
        </p>
        
        ---
        
        
        [![GitHub release](https://img.shields.io/badge/release-2.0.0-yellow.svg)](https://github.com/thieu1995/evorbf/releases)
        [![Wheel](https://img.shields.io/pypi/wheel/gensim.svg)](https://pypi.python.org/pypi/evorbf) 
        [![PyPI version](https://badge.fury.io/py/evorbf.svg)](https://badge.fury.io/py/evorbf)
        ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/evorbf.svg)
        ![PyPI - Status](https://img.shields.io/pypi/status/evorbf.svg)
        ![PyPI - Downloads](https://img.shields.io/pypi/dm/evorbf.svg)
        [![Downloads](https://static.pepy.tech/badge/evorbf)](https://pepy.tech/project/evorbf)
        [![Tests & Publishes to PyPI](https://github.com/thieu1995/evorbf/actions/workflows/publish-package.yaml/badge.svg)](https://github.com/thieu1995/evorbf/actions/workflows/publish-package.yaml)
        ![GitHub Release Date](https://img.shields.io/github/release-date/thieu1995/evorbf.svg)
        [![Documentation Status](https://readthedocs.org/projects/evorbf/badge/?version=latest)](https://evorbf.readthedocs.io/en/latest/?badge=latest)
        [![Chat](https://img.shields.io/badge/Chat-on%20Telegram-blue)](https://t.me/+fRVCJGuGJg1mNDg1)
        ![GitHub contributors](https://img.shields.io/github/contributors/thieu1995/evorbf.svg)
        [![GitTutorial](https://img.shields.io/badge/PR-Welcome-%23FF8300.svg?)](https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project)
        [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.11136007.svg)](https://doi.org/10.5281/zenodo.11136007)
        [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
        
        | **EvoRBF**                           | **Evolving Radial Basis Function Network**             |
        |--------------------------------------|--------------------------------------------------------|
        | **Free software**                    | GNU General Public License (GPL) V3 license            |
        | **Traditional RBF models**           | `RbfRegressor`, `RbfClassifier`                        |
        | **Advanced RBF models**              | `AdvancedRbfRegressor`, `AdvancedRbfClassifier`        | 
        | **Nature-inspired RBF models**       | `NiaRbfRegressor`, `NiaRbfClassifier`                  |
        | **Tuner for traditional RBF models** | `NiaRbfTuner`                                          | 
        | **Provided total ML models**         | \> 400 Models                                          |
        | **Supported total metrics**          | \>= 67 (47 regressions and 20 classifications)         |
        | **Supported loss functions**         | \>= 61 (45 regressions and 16 classifications)         |
        | **Documentation**                    | https://evorbf.readthedocs.io                          | 
        | **Python versions**                  | \>= 3.8.x                                              |  
        | **Dependencies**                     | numpy, scipy, scikit-learn, pandas, mealpy, permetrics |
        
        
        # Citation Request 
        
        ```bibtex
        @software{thieu_2024_11136008,
          author       = {Nguyen Van Thieu},
          title        = {EvoRBF: A Nature-inspired Algorithmic Framework for Evolving Radial Basis Function Networks},
          month        = may,
          year         = 2024,
          publisher    = {Zenodo},
          doi          = {10.5281/zenodo.11136007},
          url          = {https://doi.org/10.5281/zenodo.11136007}
        }
        
        @article{van2023mealpy,
          title={MEALPY: An open-source library for latest meta-heuristic algorithms in Python},
          author={Van Thieu, Nguyen and Mirjalili, Seyedali},
          journal={Journal of Systems Architecture},
          year={2023},
          publisher={Elsevier},
          doi={10.1016/j.sysarc.2023.102871}
        }
        ```
        
        
        # Theory
        
        **EvoRBF** is mind-blowing framework for Radial Basis Function (RBF) networks.
        We explain several keys components and provide several types of RBF networks that you will never see in other places.
        
        You can read several papers by using Google Scholar search. There are many ways we can use Nature-inspired Algorithms 
        to optimize Radial Basis Function network, for example, you can read [this paper](https://doi.org/10.1016/B978-0-443-18764-3.00015-1).
        Here we will walk through some basic concepts and parameters that matter to this network.
        
        
        ## Structure
        
        1. RBF has input, single-hidden, and output layer.
        2. RBF is considered has only hidden-output weights. The output layer is linear combination.
        3. The output of hidden layer is calculate by radial function (e.g, Gaussian function, Thin spline,...)
        
        
        ## Training algorithm
        
        ### Traditional RBF models
        
        In case of traditional RBF model. There are a few parameters need to identify to get the best model.
        ```code
        1. The number of hidden nodes in hidden layer
        2. The centers and widths (sigmas) of Gaussian function
        3. The output weights
        4. The regularization factor (lambda) L2
        ```
        
        To train their parameters, 
        ```code
        1. Using hyper-parameter tuning model such as GridSearchCV or RandomizedSearchCV to get the best hidden nodes
        2. The centers can be calculated by Random or KMeans or unsupervised learning algorithms
        3. The widths (sigmas) can be computed by hyper-parameter tuning process.
           + Width can be a single value that represent all hidden nodes has the same curve of Gaussian function
           + Width can be multiple values that each hidden node has a different value.
        4. The output weights can be calculated by Moore-Penrose inverse (Matrix multiplication). Do not use Gradient Descent.
        5. When setting regularization L2. lambda can be computed by hyper-parameter tuning process.
        ```
        
        Example,
        ```python
        from evorbf import RbfRegressor, RbfClassifier
        
        model = RbfClassifier(size_hidden=10, center_finder="kmeans", sigmas=2.0, reg_lambda=0.1, seed=None)
        model = RbfRegressor(size_hidden=4, center_finder="random", sigmas=(1.5, 2, 2, 2.5), reg_lambda=0, seed=42)
        
        model.fit(X=X_train, y=y_train)
        y_pred = model.predict(X_test)
        y_pred_prob = model.predict_proba(X_test)
        ```
        
        
        ### Advanced RBF models
        
        In case of advanced RBF model. User can have so many different options.
        ```code
        1. Choice different RBF kernel function such as Multiquadric (MQ), Inverse Multiquadric (IMQ), Thin Plate Spline (TPS), Exponential, Power,...
        2. Choice different unsupervised learning algorithms to calculate the centers, and may be the number of hidden nodes.
           + For example, KMeans, or random algorithms, you need to set up the number of hidden nodes.
           + But, for MeanShift or DBSCAN algorithms, you don't need to set that value. They can automatically identify the number of cluters (number of hidden nodes).
        3. This version may have the bias in output layer. 
        ```
        
        Examples,
        ```python
        from evorbf import AdvancedRbfClassifier, AdvancedRbfRegressor
        
        model = AdvancedRbfClassifier(center_finder="random", finder_params={"n_centers": 15},
                         rbf_kernel="gaussian", kernel_params={"sigma": 1.5},
                         reg_lambda=0.1, has_bias=True, seed=42)
        
        model = AdvancedRbfClassifier(center_finder="random", finder_params=None,        # Default n_centers = 10
                         rbf_kernel="gaussian", kernel_params=None,                     # Default sigma = 1.0
                         reg_lambda=0.1, has_bias=False, seed=42)
        
        model = AdvancedRbfClassifier(center_finder="kmeans", finder_params={"n_centers": 20},
                         rbf_kernel="multiquadric", kernel_params=None,
                         reg_lambda=0.1, has_bias=False, seed=42)
        
        model = AdvancedRbfClassifier(center_finder="meanshift", finder_params={"bandwidth": 0.6},      # Give us 28 hidden nodes
                         rbf_kernel="inverse_multiquadric", kernel_params={"sigma": 1.5},
                         reg_lambda=0.5, has_bias=True, seed=42)
        
        model = AdvancedRbfClassifier(center_finder="dbscan", finder_params={"eps": 0.2},      # Give us 42 hidden nodes
                         rbf_kernel="multiquadric", kernel_params={"sigma": 1.5},
                         reg_lambda=0.5, has_bias=True, seed=42)
        
        model = AdvancedRbfClassifier(center_finder="dbscan", finder_params={"eps": 0.175},      # Give us 16 hidden nodes
                         rbf_kernel="multiquadric", kernel_params={"sigma": 1.5},
                         reg_lambda=None, has_bias=False, seed=42)
        
        model.fit(X=X_train, y=y_train)
        y_pred = model.predict(X_test)
        y_pred_prob = model.predict_proba(X_test)
        ```
        
        ### Nature-inspired Algorithm-based RBF models
        
        This is the main purpose of this library. In this type of models,
        
        ```code
        1. We use Nature-inspired Algorithm (NIA) to train widths (sigmas) value for each hidden node.
        2. If you set up the Regularization technique, then NIA is automatically calculated the lambda factor
        ```
        
        Examples,
        ```python
        from evorbf import NiaRbfRegressor, NiaRbfClassifier
        
        model = NiaRbfClassifier(size_hidden=25, center_finder="kmeans", 
                                 regularization=False, obj_name="F1S",
                                 optim="OriginalWOA", 
                                 optim_paras={"epoch": 50, "pop_size": 20}, 
                                 verbose=True, seed=42)
        
        model = NiaRbfRegressor(size_hidden=10, center_finder="random", 
                                 regularization=True, obj_name="AS",
                                 optim="BaseGA", 
                                 optim_paras={"epoch": 50, "pop_size": 20}, 
                                 verbose=True, seed=42)
        
        model.fit(X=X_train, y=y_train)
        y_pred = model.predict(X_test)
        y_pred_prob = model.predict_proba(X_test)
        ```
        
        ### Nature-inspired Algorithm-based hyperparameter RBF tuning model
        
        In this case, user can use NIA to tune hyper-parameters of traditional RBF models.
        
        ```python
        from evorbf import NiaRbfTuner, IntegerVar, StringVar, FloatVar
        
        # Design the boundary (for hyper-parameters)
        my_bounds = [
            IntegerVar(lb=5, ub=21, name="size_hidden"),
            StringVar(valid_sets=("kmeans", "random"), name="center_finder"),
            FloatVar(lb=(0.01,), ub=(3.0,), name="sigmas"),
            FloatVar(lb=(0, ), ub=(1.0, ), name="reg_lambda"),
        ]
        
        model = NiaRbfTuner(problem_type="classification", bounds=my_bounds, cv=3, scoring="AS",
                            optim="OriginalWOA", optim_paras={"epoch": 10, "pop_size": 20}, 
                            verbose=True, seed=42)
        ```
        
        ### My notes
        
        1. RBF needs to train the centers, and widths of Gaussian activation function. (This is 1st phase)
        2. RBF usually use KMeans to find centers ==> Increase the complexity and time.
           + In that case, user need to define widths ==> Can use 1 single width or each hidden with different width.
           + Or RBF use random to find centers ==> Not good to split samples to different clusters.
        3. RBF needs to train the output weights. (This is 2nd phase)
        4. RBF do not use Gradient descent to calculate output weights, it used Moore–Penrose inverse (matrix multiplication, least square method) ==> so it is faster than MLP network.
        5. Moore-Penrose inverse can find the exact solution ==> So we don't have to use Gradient Descent or Approximation algorithm here.
        6. In case of overfitting, what can we do with this network ==> We add L2 regularization method.
        7. If you have large-scale dataset ==> Set more hidden nodes ==> Then increase the L2 regularization parameter.
        
        ```code
        1. RbfRegressor, RbfClassifier: You need to set up 4 types of hyper-parameters.
        2. AdvancedRbfRegressor, AdvancedRbfClassifier: You need to set up 6 types of hyper-parameters. 
           But you have many option to choice, and you can design your own RBF models, a new one that nobody has used it before.
           For example, RBF that has bias in output layer or RBF that use DBSCAN and Exponential kernel function. 
        3. NiaRbfRegressor, NiaRbfClassifier: You need to set up the hidden size. However, these are best classes in this library.
           + The sigmas are automatically calculated for each hidden nodes.
           + The reguarlization factor is also automatically tuned to fine the best one.
        4. NiaRbfTuner. This class also extremely useful for traditional RBF models, it can tune hidden size, however, 
           there is only 1 sigma value will be presented all hidden nodes.
        ```
        
        
        # Usage
        
        * Install the [current PyPI release](https://pypi.python.org/pypi/evorbf):
        ```sh 
        $ pip install evorbf
        ```
        
        After installation, you can check EvoRBF version:
        
        ```sh
        $ python
        >>> import evorbf
        >>> evorbf.__version__
        ```
        
        We have provided above several ways to import and call the proposed classes. If you need more details how to 
        use each of them, please check out the folder [examples](/examples). In this short demonstration, we will use 
        Whale Optimization Algorithm to optimize the `sigmas` (in non-linear Gaussian kernel) and `reg_lambda` of 
        L2 regularization in RBF network (WOA-RBF model) for Diabetes prediction problem.
        
        ```python
        import numpy as np
        from evorbf import Data, NiaRbfRegressor
        from sklearn.datasets import load_diabetes
        
        ## Load data object
        # total samples = 442, total features = 10
        X, y = load_diabetes(return_X_y=True)
        data = Data(X, y)
        
        ## Split train and test
        data.split_train_test(test_size=0.2, random_state=2)
        print(data.X_train.shape, data.X_test.shape)
        
        ## Scaling dataset
        data.X_train, scaler_X = data.scale(data.X_train, scaling_methods=("standard"))
        data.X_test = scaler_X.transform(data.X_test)
        
        data.y_train, scaler_y = data.scale(data.y_train, scaling_methods=("standard", ))
        data.y_test = scaler_y.transform(np.reshape(data.y_test, (-1, 1)))
        
        ## Create model
        opt_paras = {"name": "WOA", "epoch": 50, "pop_size": 20}
        model = NiaRbfRegressor(size_hidden=25,             # Set up big enough hidden size 
                                center_finder="kmeans",     # Use KMeans to find the centers
                                regularization=True,        # Use L2 regularization 
                                obj_name="MSE",             # Mean squared error as fitness function for NIAs
                                optim="OriginalWOA",        # Use Whale Optimization
                                optim_paras={"epoch": 50, "pop_size": 20},  # Set up parameter for Whale Optimization
                                verbose=True, seed=42)
        
        ## Train the model
        model.fit(data.X_train, data.y_train)
        
        ## Test the model
        y_pred = model.predict(data.X_test)
        
        print(model.optimizer.g_best.solution)
        ## Calculate some metrics
        print(model.score(X=data.X_test, y=data.y_test))
        print(model.scores(X=data.X_test, y=data.y_test, list_metrics=["R2", "R", "KGE", "MAPE"]))
        print(model.evaluate(y_true=data.y_test, y_pred=y_pred, list_metrics=["MSE", "RMSE", "R2S", "NSE", "KGE", "MAPE"]))
        ```
        
        Please go check out the [examples](/examples) folder. You'll be surprised by what this library can do for your problem.
        You can also read the [documentation](https://evorbf.readthedocs.io/) for more detailed installation 
        instructions, explanations, and examples.
        
        
        ### Official Links (Get support for questions and answers)
        
        * [Official source code repository](https://github.com/thieu1995/evorbf)
        * [Official document](https://evorbf.readthedocs.io/)
        * [Download releases](https://pypi.org/project/evorbf/) 
        * [Issue tracker](https://github.com/thieu1995/evorbf/issues) 
        * [Notable changes log](/ChangeLog.md)
        * [Official discussion group](https://t.me/+fRVCJGuGJg1mNDg1)
        
        ---
        
        Developed by: [Thieu](mailto:nguyenthieu2102@gmail.com?Subject=EvoRBF_QUESTIONS) @ 2024
        
Keywords: radial basis function,machine learning,artificial intelligence, deep learning,neural networks,single hidden layer network,metaheuristic-based RBFrandom projection,kernel methods,feature extraction,classification,regression,supervised learning,optimization algorithms,Kernel RBF,Cross-validationGenetic algorithm (GA),Particle swarm optimization (PSO),Ant colony optimization (ACO),Differential evolution (DE),Simulated annealing,Grey wolf optimizer (GWO),Whale Optimization Algorithm (WOA),confusion matrix,recall,precision,accuracy,K-Nearest Neighbors,random forest,support vector machine,scikit-learn models,estimator,Robust machine learning,shallow neural network,nature-inspired RBF,RBF network,Convergence analysis,Search space exploration,Local search,Computational intelligence,Robust optimization,Performance analysis,Intelligent optimization,Simulations
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: System :: Benchmark
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Provides-Extra: dev
