aisp 0.1.35__py3-none-any.whl → 0.1.41__py3-none-any.whl

aisp/__init__.py

@@ -1,4 +1,4 @@
 """Artificial Immune Systems Package"""
 
 __author__ = "João Paulo da Silva Barros"
-__version__ = "0.1.35"
+__version__ = "0.1.40"

aisp/base/__init__.py

@@ -0,0 +1,4 @@
+"""Base class modules."""
+from ._classifier import BaseClassifier
+
+__all__ = ['BaseClassifier']

aisp/base/_classifier.py

@@ -0,0 +1,110 @@
+"""Base class for classification algorithm."""
+
+from abc import ABC, abstractmethod
+from typing import Optional, Union
+
+import numpy.typing as npt
+
+from ..utils import slice_index_list_by_class
+from ..utils.metrics import accuracy_score
+
+
+class BaseClassifier(ABC):
+    """
+    Base class for classification algorithms, defining the abstract methods ``fit`` and ``predict``,
+    and implementing the ``get_params`` method.
+    """
+
+    classes: Optional[Union[npt.NDArray, list]] = None
+
+    @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.
+        """
+
+    @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.
+        """
+
+    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.
+        """
+        if len(y) == 0:
+            return 0
+        y_pred = self.predict(X)
+        return accuracy_score(y, y_pred)
+
+    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.
+
+        Parameters
+        ----------
+        * 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.
+        """
+        return slice_index_list_by_class(self.classes, y)
+
+    def get_params(self, deep: bool = True) -> dict:  # pylint: disable=W0613
+        """
+        The get_params function Returns a dictionary with the object's main parameters.
+
+        This function is required to ensure compatibility with scikit-learn functions.
+        """
+        return {
+            key: value
+            for key, value in self.__dict__.items()
+            if not key.startswith("_")
+        }

aisp/nsa/__init__.py

@@ -8,4 +8,4 @@ from ._negative_selection import BNSA, RNSA
 
 __author__ = "João Paulo da Silva Barros"
 __all__ = ["RNSA", "BNSA"]
-__version__ = "0.1.35"
+__version__ = "0.1.40"

aisp/nsa/_base.py

@@ -1,68 +1,27 @@
 """Base Class for Negative Selection Algorithm."""
-from abc import abstractmethod
+
+from abc import ABC
+from dataclasses import dataclass
 from typing import Literal, Optional
 
 import numpy as np
 import numpy.typing as npt
-from scipy.spatial.distance import cityblock, euclidean, minkowski
 
+from ..base import BaseClassifier
 from ..exceptions import FeatureDimensionMismatch
-from ..utils.metrics import accuracy_score
-from ..utils.sanitizers import sanitize_choice
 
 
-class Base:
+class BaseNSA(BaseClassifier, ABC):
     """
     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.
-
-    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][1].
-
-    Notes
-    ----------
-    [1]: https://docs.scipy.org/doc/scipy/reference/generated/scipy.spatial.minkowski_distance.html
     """
 
-    def __init__(self, metric: str = "euclidean", p: float = 2):
-        self.metric = sanitize_choice(metric, ["manhattan", "minkowski"], "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.
-        """
-        if self.metric == "manhattan":
-            return cityblock(u, v)
-        if self.metric == "minkowski":
-            return minkowski(u, v, self.p)
-
-        return euclidean(u, v)
-
     @staticmethod
     def _check_and_raise_exceptions_fit(
-            X: npt.NDArray = None,
-            y: npt.NDArray = None,
-            _class_: Literal["RNSA", "BNSA"] = "RNSA",
+        X: npt.NDArray = None,
+        y: npt.NDArray = None,
+        _class_: Literal["RNSA", "BNSA"] = "RNSA",
     ) -> None:
         """
         Function responsible for verifying fit function parameters and throwing exceptions if the
@@ -78,7 +37,7 @@ class Base:
         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 
+        * ValueError: If _class_ is BNSA and X contains values that are not composed only of
             0 and 1.
         """
         if isinstance(X, list):
@@ -123,21 +82,16 @@ class Base:
 
         Raises
         ----------
-        * TypeError
-            If X is not an ndarray or list.
-        * FeatureDimensionMismatch
-            If the number of features in X does not match the expected number.
-        * ValueError
-            If _class_ is BNSA and X contains values that are not composed only of 0 and 1.
+        * TypeError: If X is not an ndarray or list.
+        * FeatureDimensionMismatch: If the number of features in X does not match the expected
+            number.
+        * ValueError: If _class_ is BNSA and X contains values that are not composed only of 0
+        and 1.
         """
         if not isinstance(X, (np.ndarray, list)):
             raise TypeError("X is not an ndarray or list")
         if expected != len(X[0]):
-            raise FeatureDimensionMismatch(
-                expected,
-                len(X[0]),
-                "X"
-            )
+            raise FeatureDimensionMismatch(expected, len(X[0]), "X")
 
         if _class_ != "BNSA":
             return
@@ -148,65 +102,17 @@ class Base:
                 "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.
-        """
-        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.
-        """
-
-    @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.
+@dataclass(slots=True)
+class Detector:
+    """
+    Represents a non-self detector of the RNSA class.
 
-        Parameters
-        ----------
-        * X (``npt.NDArray``): Input data for which predictions will be generated.
+    Attributes
+    ----------
+    * position (``npt.NDArray[np.float64]``): Detector feature vector.
+    * radius (``float, optional``): Detector radius, used in the V-detector algorithm.
+    """
 
-        Returns
-        ----------
-        * Predictions (``Optional[npt.NDArray]``): Predicted values for each input sample, or
-            ``None`` if the prediction fails.
-        """
+    position: npt.NDArray[np.float64]
+    radius: Optional[float] = None