aisp 0.1.34__py3-none-any.whl → 0.1.40__py3-none-any.whl

{aisp-0.1.34.dist-info → aisp-0.1.40.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aisp
-Version: 0.1.34
+Version: 0.1.40
 Summary: Package with techniques of artificial immune systems.
 Author-email: João Paulo da Silva Barros <jpsilvabarr@gmail.com>
 Maintainer-email: Alison Zille Lopes <alisonzille@gmail.com>
@@ -9,18 +9,21 @@ Project-URL: Homepage, https://ais-package.github.io/
 Project-URL: Documentation, https://ais-package.github.io/docs/intro
 Project-URL: Source Code, https://github.com/AIS-Package/aisp
 Project-URL: Tracker, https://github.com/AIS-Package/aisp/issues
-Keywords: Artificial Immune Systems,classification,Natural computing,machine learning,artificial intelligence
+Keywords: Artificial Immune Systems,classification,Natural computing,machine learning,artificial intelligence,AIS
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 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
-Requires-Python: >=3.8.10
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: numpy>=1.22.4
+Requires-Dist: numba>=0.59.0
 Requires-Dist: scipy>=1.8.1
 Requires-Dist: tqdm>=4.64.1
 Dynamic: license-file
@@ -39,7 +42,7 @@ Dynamic: license-file
 <div class='language-options'>
 
 * [English.](#english)
-* [Português.](#português)
+* [Português.](https://ais-package.github.io/pt-br/docs/intro)
 
 </div>
 
@@ -52,11 +55,6 @@ Dynamic: license-file
 ---
 
 <section id='english'>
-<div align = center> 
-
-## English
-
-</div>
 
 #### Summary:
 
@@ -91,7 +89,7 @@ Artificial Immune Systems (AIS) are inspired by the vertebrate immune system, cr
 
 #### **Installation**
 
-The module requires installation of [python 3.8.10](https://www.python.org/downloads/) or higher.
+The module requires installation of [python 3.10](https://www.python.org/downloads/) or higher.
 
 <section id='dependencies'>
 
@@ -104,6 +102,7 @@ The module requires installation of [python 3.8.10](https://www.python.org/downl
 |    numpy      |    ≥ 1.22.4   |
 |    scipy      |    ≥ 1.8.1    |
 |    tqdm       |    ≥ 4.64.1   |
+|    numba      |    ≥ 0.59.0   |
 
 </div>
 
@@ -144,104 +143,5 @@ Below are some examples that use a database for classification with the [Jupyter
 
 ---
 
-
-</section>
-</section>
-
----
-
-<section id='português'>
-<div align = center> 
-
-## Português
-
-</div>
-
-#### Sumário:
-
-> 1. [Introdução.](#introdução)
-> 2. [Instalação.](#instalação)
->    1. [Dependências](#dependências)
->    2. [Instalação do usuário](#instalação-do-usuário)
-> 3. [Exemplos.](#exemplos)
-
----
-<section id='introdução'>
-
-#### Introdução
-
-O **AISP** é um pacote python que implementa as técnicas dos sistemas imunológicos artificiais, distribuído sob a licença GNU Lesser General Public License v3.0 (LGPLv3).
-
-O pacote teve início no ano de **2022** como um pacote de pesquisa no instituto federal do norte de minas gerais - campus salinas (**IFNMG - Salinas**).
-
-Os sistemas imunológicos artificiais (SIA) inspiram-se no sistema imunológico dos vertebrados, criando metáforas que aplicam a capacidade de reconhecer e catalogar os patógenos, entre outras características desse sistema.
-
-##### Algoritmos implementados:
-
-> - [x] [**Seleção Negativa.**](https://ais-package.github.io/docs/aisp-techniques/Negative%20Selection/)
-> - [ ] *Algoritmos de Seleção Clonal.*
-> - [ ] *Células Dendríticas.*
-> - [ ] *Teoria da Rede Imune.*
-
-</section>
-
-<section id='introdução'>
-
-#### **Instalação**
-
-
-O módulo requer a instalação do [python 3.8.10](https://www.python.org/downloads/) ou superior.
-
-<section id='dependências'>
-
-##### **Dependências:**
-<div align = center> 
-
-|    Pacotes    |     Versão    |
-|:-------------:|:-------------:|
-|    numpy      |    ≥ 1.22.4   |
-|    scipy      |    ≥ 1.8.1    |
-|    tqdm       |    ≥ 4.64.1   |
-
-</div>
-</section>
-
-<section id='instalação-do-usuário'>
-
-##### **Instalação do usuário**
-
-A maneira mais simples de instalação do AISP é utilizando o ``pip``:
-
-```Bash
-pip install aisp
-```
-
-</section>
-
-</section>
-<section id='exemplos'>
-
-#### Exemplos:
-
----
-
-##### Exemplo utilizando a técnica de seleção negativa (**nsa**):
-
-No exemplo presente nesse [notebook](https://github.com/AIS-Package/aisp/blob/main/examples/RNSA/example_with_randomly_generated_dataset-pt.ipynb), gerando **500** amostras aleatórias dispostas em dois grupos um para cada classe.
-
-A seguir alguns exemplos que utiliza-se de base de dados para classificação com a ferramenta [Jupyter notebook](https://jupyter.org/).
-
-#### **Seleção Negativa:**
-
-+ **RNSA** Aplicação das tecnica de seleção negativa para classificação utilizando a base de dados de flores da família Iris e Old Faithful Geyser:
-    + [iris_dataBase_example](https://github.com/AIS-Package/aisp/blob/main/examples/RNSA/iris_dataBase_example_pt-br.ipynb)
-    + [geyser_dataBase_example](https://github.com/AIS-Package/aisp/blob/main/examples/RNSA/geyser_dataBase_example_pt-br.ipynb)
-
-+ **BNSA** 
-    + [mushrooms_dataBase_example](https://github.com/AIS-Package/aisp/blob/main/examples/BNSA/mushrooms_dataBase_example_en.ipynb)
-
-
----
-
 </section>
 </section>

aisp-0.1.40.dist-info/RECORD

@@ -0,0 +1,18 @@
+aisp/__init__.py,sha256=pKOdkhFxWup_lhQPofFTk4rpqd0_IlYygHnkBhE2g2w,111
+aisp/exceptions.py,sha256=ONiKCZrBhfUaMO1vYHnOr1_eL9PtVJ7b_HRroMbORpc,1405
+aisp/base/__init__.py,sha256=rpb9ADmBtNpRAEJw61c7CsbZhHA2vGQOvjFmpk7w39c,100
+aisp/base/_classifier.py,sha256=qv6TxzfnRwO7HvN7CA8PS1dueAnm-RifelRnCjrK9D0,3027
+aisp/nsa/__init__.py,sha256=3-fSIJCMB_jcLGTr6DcVkloRfWyQJ8-JzD0CLhvpvgc,411
+aisp/nsa/_base.py,sha256=cT404V5onduK19WW6ajxy_yUZha3Fk8KZJvJHt_UZBM,4250
+aisp/nsa/_negative_selection.py,sha256=0_VI3rAeVzPcSRwjMjqCq6RT-1_a_-HCFtIIJL6jpyc,29582
+aisp/nsa/_ns_core.py,sha256=VWt_L2ODXtngJ7BVmSVT7i7kK98axibOmCzbYCkjeqI,4934
+aisp/utils/__init__.py,sha256=-r--qdfTq4dVJU-VoJ7dvXTNS5_I1q1aGAQ02zNBOGw,217
+aisp/utils/_multiclass.py,sha256=t0RLIdUoUbvFL30a8XfO3BMXc8MimtLCHNbGCDL2BQk,1051
+aisp/utils/distance.py,sha256=SZTE5KEB7QX9vKoY9GfFOfFGbswVhQM6-9baLq4ZXns,6304
+aisp/utils/metrics.py,sha256=o6aD6qTLQtXhWNOMGjgweHMQ6SMQ2hh42NcSEmgY3RI,1292
+aisp/utils/sanitizers.py,sha256=7wJSo5ZkRX1g16C9sEN8TWQ5l9Gzfl0-8CgLULnPNlk,1873
+aisp-0.1.40.dist-info/licenses/LICENSE,sha256=fTqV5eBpeAZO0_jit8j4Ref9ikBSlHJ8xwj5TLg7gFk,7817
+aisp-0.1.40.dist-info/METADATA,sha256=em8eJAx3lr87ZZ1ajsoSkIj-itauLz25E1FKcdjf1QU,4818
+aisp-0.1.40.dist-info/WHEEL,sha256=GHB6lJx2juba1wDgXDNlMTyM13ckjBMKf-OnwgKOCtA,91
+aisp-0.1.40.dist-info/top_level.txt,sha256=Q5aJi_rAVT5UNS1As0ZafoyS5dwNibnoyOYV7RWUB9s,5
+aisp-0.1.40.dist-info/RECORD,,

{aisp-0.1.34.dist-info → aisp-0.1.40.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (78.1.0)
+Generator: setuptools (80.3.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

aisp/NSA/__init__.py

@@ -1,18 +0,0 @@
-"""Module (NSA) Negative Selection Algorithm
-
-NSAs simulate the maturation process of T-cells in the immune system, where these \
-cells learn to distinguish between self and non-self. Only T-cells capable \
-of recognizing non-self elements are preserved.
-
-----
-
-Os NSAs simulam o processo de maturação das células-T no sistema imunológico, onde \
-essas células aprendem a distinguir entre o próprio e não-próprio.
-Apenas as células-T capazes de reconhecer elementos não-próprios são preservadas.
-
-"""
-from ._negative_selection import BNSA, RNSA
-
-__author__ = "João Paulo da Silva Barros"
-__all__ = ["RNSA", "BNSA"]
-__version__ = "0.1.34"

aisp/NSA/_base.py

@@ -1,281 +0,0 @@
-from abc import abstractmethod
-
-import numpy as np
-import numpy.typing as npt
-from typing import Literal, Optional
-from scipy.spatial.distance import euclidean, cityblock, minkowski
-
-from ..utils.metrics import accuracy_score
-
-
-class Base:
-    """
-    The base class contains functions that are used by more than one class in the package, and \
-    therefore are considered essential for the overall functioning of the system.
-
-    ---
-
-    A classe base contém funções que são utilizadas por mais de uma classe do pacote, e por isso \
-    são consideradas essenciais para o funcionamento geral do sistema.
-    """
-
-    def __init__(self, metric: str = "euclidean", p: float = 2):
-        """
-        Parameters:
-        ---
-        * metric (``str``): Way to calculate the distance between the detector and the sample:
-
-                * ``'Euclidean'`` ➜ The calculation of the distance is given by the expression: \
-                    √( (x₁ – x₂)² + (y₁ – y₂)² + ... + (yn – yn)²).
-                * ``'minkowski'`` ➜ The calculation of the distance is given by the expression: \
-                    ( |X₁ – Y₁|p + |X₂ – Y₂|p + ... + |Xn – Yn|p) ¹/ₚ.
-                * ``'manhattan'`` ➜ The calculation of the distance is given by the expression: \
-                    ( |x₁ – x₂| + |y₁ – y₂| + ... + |yn – yn|) .
-
-
-        * p (``float``): This parameter stores the value of ``p`` used in the Minkowski distance.\
-            The default is ``2``, which represents normalized Euclidean distance. Different \
-            values of p lead to different variants of the Minkowski distance \
-            [learn more](https://docs.scipy.org/doc/scipy/reference/generated/scipy.spatial.distance.minkowski.html).
-
-        ---
-
-        Parameters:
-        ---
-        * metric (``str``): Forma para se calcular a distância entre o detector e a amostra: 
-
-                * ``'euclidiana'`` ➜ O cálculo da distância dá-se pela expressão: \
-                    √( (x₁ – x₂)² + (y₁ – y₂)² + ... + (yn – yn)²).
-                * ``'minkowski'``  ➜ O cálculo da distância dá-se pela expressão: \
-                    ( |X₁ – Y₁|p + |X₂ – Y₂|p + ... + |Xn – Yn|p).
-                * ``'manhattan'``  ➜ O cálculo da distância dá-se pela expressão: \
-                    ( |x₁ – x₂| + |y₁ – y₂| + ... + |yn – yn|).
-
-            Defaults to ``'euclidean'``.
-
-        * p (``float``): Este parâmetro armazena o valor de ``p`` utilizada na distância de Minkowski. \
-            O padrão é ``2``, o que significa distância euclidiana normalizada. Diferentes valores \
-            de p levam a diferentes variantes da distância de Minkowski \
-            [saiba mais](https://docs.scipy.org/doc/scipy/reference/generated/scipy.spatial.distance.minkowski.html).
-        """
-        if metric == "manhattan" or metric == "minkowski":
-            self.metric: str = metric
-        else:
-            self.metric: str = "euclidean"
-        self.p: float = p
-
-    def _distance(self, u: npt.NDArray, v: npt.NDArray):
-        """
-        Function to calculate the distance between two points by the chosen ``metric``.
-
-        Parameters:
-        ---
-            * u (``npt.NDArray``): Coordinates of the first point.
-            * v (``npt.NDArray``): Coordinates of the second point.
-
-        returns:
-        ---
-            * Distance (``double``) between the two points.
-
-        ---
-
-        Função para calcular a distância entre dois pontos pela ``metric`` escolhida.
-
-        Parameters:
-        ---
-            * u (``npt.NDArray``): Coordenadas do primeiro ponto.
-            * v (``npt.NDArray``): Coordenadas do segundo ponto.
-
-        Returns:
-        ---
-            * Distância (``double``) entre os dois pontos.
-        """
-        if self.metric == "manhattan":
-            return cityblock(u, v)
-        elif self.metric == "minkowski":
-            return minkowski(u, v, self.p)
-        else:
-            return euclidean(u, v)
-
-    @staticmethod
-    def _check_and_raise_exceptions_fit(
-            X: npt.NDArray = None,
-            y: npt.NDArray = None,
-            _class_: Literal["RNSA", "BNSA"] = "RNSA",
-    ):
-        """
-        Function responsible for verifying fit function parameters and throwing exceptions if the \
-        verification is not successful.
-
-        Parameters:
-        ---
-            * X (``npt.NDArray``): Training array, containing the samples and their characteristics, \
-                [``N samples`` (rows)][``N features`` (columns)].
-            * y (``npt.NDArray``): Array of target classes of ``X`` with [``N samples`` (lines)].
-            * _class_ (Literal[RNSA, BNSA], optional): Current class. Defaults to 'RNSA'.
-
-        Raises:
-        ---
-            * TypeError: If X or y are not ndarrays or have incompatible shapes.
-            * ValueError: If _class_ is BNSA and X contains values that are not composed only of 0 and 1.
-
-        ---
-
-        Função responsável por verificar os parâmetros da função fit e lançar exceções se a \
-        verificação não for bem-sucedida.
-
-        Parâmetros:
-        ---
-            * X (``npt.NDArray``): Array de treinamento, contendo as amostras e suas características, \
-                [``N samples`` (linhas)][``N features`` (colunas)].
-            * y (``npt.NDArray``): Array de classes alvo de ``X`` com [``N samples`` (linhas)].
-            * _class_ (Literal[RNSA, BNSA], opcional): Classe atual. O padrão é 'RNSA'.
-
-        Lança:
-        ---
-            * TypeError: Se X ou y não forem ndarrays ou tiverem formas incompatíveis.
-            * ValueError: Se _class_ for BNSA e X contiver valores que não sejam compostos apenas por 0 e 1.
-        """
-        if not isinstance(X, np.ndarray):
-            if isinstance(X, list):
-                X = np.array(X)
-            else:
-                raise TypeError("X is not an ndarray or list.")
-        elif not isinstance(y, np.ndarray):
-            if isinstance(y, list):
-                y = np.array(y)
-            else:
-                raise TypeError("y is not an ndarray or list.")
-        if X.shape[0] != y.shape[0]:
-            raise TypeError(
-                "X does not have the same amount of sample for the output classes in y."
-            )
-
-        if _class_ == "BNSA" and not np.isin(X, [0, 1]).all():
-            raise ValueError(
-                "The array X contains values that are not composed only of 0 and 1."
-            )
-
-    def score(self, X: npt.NDArray, y: list) -> float:
-        """
-        Score function calculates forecast accuracy.
-
-        Details:
-        ---
-        This function performs the prediction of X and checks how many elements are equal between \
-        vector y and y_predicted. This function was added for compatibility with some scikit-learn \
-        functions.
-
-        Parameters:
-        -----------
-
-        X: np.ndarray
-            Feature set with shape (n_samples, n_features).
-        y: np.ndarray
-            True values with shape (n_samples,).
-
-        Returns:
-        -------
-
-        accuracy: float
-            The accuracy of the model.
-
-        ---
-
-        Função score calcular a acurácia da previsão.
-
-        Details:
-        ---
-        Esta função realiza a previsão de X e verifica quantos elementos são iguais entre o vetor \
-        y e y_previsto. Essa função foi adicionada para oferecer compatibilidade com algumas funções \
-        do scikit-learn.
-
-        Parameters:
-        ---
-
-        * X : np.ndarray
-            Conjunto de características com shape (n_samples, n_features).
-        * y : np.ndarray
-            Valores verdadeiros com shape (n_samples,).
-
-        returns:
-        ---
-
-        accuracy : float
-            A acurácia do modelo.
-        """
-        if len(y) == 0:
-            return 0
-        y_pred = self.predict(X)
-        return accuracy_score(y, y_pred)
-
-    @abstractmethod
-    def fit(self, X: npt.NDArray, y: npt.NDArray, verbose: bool = True):
-        """
-        Function to train the model using the input data ``X`` and corresponding labels ``y``.
-
-        This abstract method is implemented by the class that inherits it.
-
-        Parameters:
-        ---
-            * X (``npt.NDArray``): Input data used for training the model, previously normalized to the range [0, 1].
-            * y (``npt.NDArray``): Corresponding labels or target values for the input data.
-            * verbose (``bool``, optional): Flag to enable or disable detailed output during \
-                training. Default is ``True``.
-
-        Returns:
-        ---
-            * self: Returns the instance of the class that implements this method.
-
-        ---
-
-        Função para treinar o modelo usando os dados de entrada ``X`` e os classes correspondentes ``y``.
-
-        Este método abstrato é implementado pela classe que o herdar.
-
-        Parâmetros:
-        ---
-            * X (``npt.NDArray``): Dados de entrada utilizados para o treinamento do modelo, previamente \
-                normalizados no intervalo [0, 1].
-            * y (``npt.NDArray``): Rótulos ou valores-alvo correspondentes aos dados de entrada.
-            * verbose (``bool``, opcional): Flag para ativar ou desativar a saída detalhada durante o \
-                treinamento. O padrão é ``True``.
-
-        Retornos:
-        ---
-            * self: Retorna a instância da classe que implementa este método.
-        """
-        pass
-
-    @abstractmethod
-    def predict(self, X) -> Optional[npt.NDArray]:
-        """
-        Function to generate predictions based on the input data ``X``.
-
-        This abstract method is implemented by the class that inherits it.
-
-        Parameters:
-        ---
-            * X (``npt.NDArray``): Input data for which predictions will be generated.
-
-        Returns:
-        ---
-            * Predictions (``Optional[npt.NDArray]``): Predicted values for each input sample, or ``None``
-                if the prediction fails.
-
-        ---
-
-        Função para gerar previsões com base nos dados de entrada ``X``.
-
-        Este método abstrato é implementado pela classe que o herdar.
-
-        Parâmetros:
-        ---
-            * X (``npt.NDArray``): Dados de entrada para os quais as previsões serão geradas.
-
-        Retornos:
-        ---
-            * Previsões (``Optional[npt.NDArray]``): Valores previstos para cada amostra de entrada,
-                ou ``None`` se a previsão falhar.
-        """
-        pass