Skip to content

Commit

Permalink
Merge pull request #5 from AIS-Package/main
Browse files Browse the repository at this point in the history 
v0.1.31
  • Loading branch information
@Joao-Paulo-Silva
Joao-Paulo-Silva authored Apr 29, 2024
2 parents 3090feb + db08166 commit 231f12a
Show file tree
Hide file tree
Showing 7 changed files with 843 additions and 386 deletions.
8 changes: 4 additions & 4 deletions aisp/NSA/__init__.py
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
from ._negativeSelection import RNSA, BNSA
from ._negative_selection import BNSA, RNSA

__author__ = 'João Paulo da Silva Barros'
__all__ = ['RNSA', 'BNSA']
__version__ = '0.1.21'
__author__ = "João Paulo da Silva Barros"
__all__ = ["RNSA", "BNSA"]
__version__ = "0.1.31"
154 changes: 93 additions & 61 deletions aisp/_base.py → aisp/NSA/_base.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,51 +3,61 @@
from typing import Literal
from scipy.spatial.distance import euclidean, cityblock, minkowski


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.
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.
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):

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).
* ``'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|).
* ``'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).
* 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' or metric == 'euclidean':
if metric == "manhattan" or metric == "minkowski":
self.metric: str = metric
else:
self.metric: str = 'euclidean'
self.metric: str = "euclidean"
self.p: float = p

def _distance(self, u: npt.NDArray, v: npt.NDArray):
Expand Down Expand Up @@ -76,94 +86,115 @@ def _distance(self, u: npt.NDArray, v: npt.NDArray):
---
* Distância (``double``) entre os dois pontos.
"""
if self.metric == 'manhattan':
if self.metric == "manhattan":
return cityblock(u, v)
elif self.metric == 'minkowski':
elif self.metric == "minkowski":
return minkowski(u, v, self.p)
else:
return euclidean(u, v)

def _check_and_raise_exceptions_fit(self, X: npt.NDArray = None, y: npt.NDArray = None, _class_: Literal['RNSA', 'BNSA'] = 'RNSA'):

def _check_and_raise_exceptions_fit(self, 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.
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)].
* 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'.
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)):
if not isinstance(X, np.ndarray):
if isinstance(X, list):
X = np.array(X)
else:
raise TypeError("X is not an ndarray.")
elif not isinstance(y, (np.ndarray)):
if isinstance(y, (list)):
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.")
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():
"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.")
"The array X contains values that are not composed only of 0 and 1."
)

def _slice_index_list_by_class(self, y: npt.NDArray) -> dict:
"""
The function ``__slice_index_list_by_class(...)``, separates the indices of the lines according to the output class,
to loop through the sample array, only in positions where the output is the class being trained.
The function ``__slice_index_list_by_class(...)``, separates the indices of the lines \
according to the output class, to loop through the sample array, only in positions where \
the output is the class being trained.
Parameters:
---
* y (npt.NDArray): Receives a ``y``[``N sample``] array with the output classes of the ``X`` sample array.
* y (npt.NDArray): Receives a ``y``[``N sample``] array with the output classes of the \
``X`` sample array.
returns:
---
* dict: A dictionary with the list of array positions(``y``), with the classes as key.
---
A função ``__slice_index_list_by_class(...)``, separa os índices das linhas conforme a classe de saída,
para percorrer o array de amostra, apenas nas posições que a saída for a classe que está sendo treinada.
A função ``__slice_index_list_by_class(...)``, separa os índices das linhas conforme a \
classe de saída, para percorrer o array de amostra, apenas nas posições que a saída for \
a classe que está sendo treinada.
Parameters:
---
* y (npt.NDArray): Recebe um array ``y``[``N amostra``] com as classes de saida do array de amostra ``X``.
* y (npt.NDArray): Recebe um array ``y``[``N amostra``] com as classes de saída do \
array de amostra ``X``.
Returns:
---
* dict: Um dicionário com a lista de posições do array(``y``), com as classes como chave.
"""
positionSamples = dict()
position_samples = dict()
for _class_ in self.classes:
# Pega as posições das amostras por classes a partir do y.
positionSamples[_class_] = list(np.where(y == _class_)[0])
position_samples[_class_] = list(np.where(y == _class_)[0])

return position_samples

return positionSamples

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.
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:
-----------
Expand All @@ -185,8 +216,9 @@ def _score(self, X: npt.NDArray, y: list) -> float:
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.
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:
---
Expand All @@ -205,4 +237,4 @@ def _score(self, X: npt.NDArray, y: list) -> float:
if len(y) == 0:
return 0
y_pred = self.predict(X)
return np.sum(y == y_pred)/len(y)
return np.sum(y == y_pred) / len(y)
Loading

0 comments on commit 231f12a

Please sign in to comment.