artlib.optimized.backends.torch.FuzzyARTMAP
===========================================

.. py:module:: artlib.optimized.backends.torch.FuzzyARTMAP

.. autoapi-nested-parse::

   Fuzzy ARTMAP :cite:`carpenter1991fuzzy`.



Classes
-------

.. autoapisummary::

   artlib.optimized.backends.torch.FuzzyARTMAP._TorchFuzzyARTMAPConfig
   artlib.optimized.backends.torch.FuzzyARTMAP._TorchFuzzyARTMAP
   artlib.optimized.backends.torch.FuzzyARTMAP.FuzzyARTMAP


Functions
---------

.. autoapisummary::

   artlib.optimized.backends.torch.FuzzyARTMAP._to_device
   artlib.optimized.backends.torch.FuzzyARTMAP._complement_code


Module Contents
---------------

.. py:function:: _to_device(x: Union[torch.Tensor, numpy.ndarray], device, dtype=torch.float32) -> torch.Tensor

.. py:function:: _complement_code(x: torch.Tensor) -> torch.Tensor

.. py:class:: _TorchFuzzyARTMAPConfig

   .. py:attribute:: input_dim
      :type:  int


   .. py:attribute:: alpha
      :type:  float
      :value: 0.001



   .. py:attribute:: rho
      :type:  float
      :value: 0.75



   .. py:attribute:: beta
      :type:  float
      :value: 1.0



   .. py:attribute:: epsilon
      :type:  float
      :value: 1e-07



   .. py:attribute:: match_tracking
      :type:  bool
      :value: True



   .. py:attribute:: device
      :type:  str
      :value: 'cuda'



   .. py:attribute:: dtype
      :type:  torch.dtype
      :value: Ellipsis



   .. py:attribute:: clamp_inputs
      :type:  bool
      :value: True



   .. py:attribute:: fallback_to_choice_on_fail
      :type:  bool
      :value: True



.. py:class:: _TorchFuzzyARTMAP(cfg: _TorchFuzzyARTMAPConfig)

   Torch accelerated Fuzzy ARTMAP with export hooks for artlib synchronization.


   .. py:attribute:: cfg


   .. py:attribute:: device


   .. py:attribute:: dtype


   .. py:attribute:: input_dim


   .. py:attribute:: code_dim


   .. py:attribute:: W
      :type:  Optional[torch.Tensor]
      :value: None



   .. py:attribute:: map_y
      :type:  Optional[torch.Tensor]
      :value: None



   .. py:attribute:: _lower_bounds
      :type:  Optional[torch.Tensor]
      :value: None



   .. py:attribute:: _upper_bounds
      :type:  Optional[torch.Tensor]
      :value: None



   .. py:attribute:: _prep_tol
      :type:  float
      :value: 1e-06



   .. py:property:: n_cat
      :type: int



   .. py:method:: _ensure_capacity()


   .. py:method:: _validate_prepared(X: torch.Tensor)


   .. py:method:: _free_mem_bytes() -> int


   .. py:method:: set_data_bounds(lower: Union[torch.Tensor, numpy.ndarray], upper: Union[torch.Tensor, numpy.ndarray])


   .. py:method:: prepare_data(X: Union[torch.Tensor, numpy.ndarray]) -> torch.Tensor


   .. py:method:: _choice_and_match(I: torch.Tensor) -> Tuple[torch.Tensor, torch.Tensor, torch.Tensor, torch.Tensor]

      Returns (T, m, I_sum, IandW_sum) for a single prepared input I.



   .. py:method:: _commit_new_category(I: torch.Tensor, y: int)


   .. py:method:: partial_fit_and_export(X_prepared: Union[torch.Tensor, numpy.ndarray], y: Union[torch.Tensor, numpy.ndarray], epsilon: float = 1e-10, match_tracking: Literal['MT+', 'MT-', 'MT0', 'MT1', 'MT~'] = 'MT+') -> Tuple[numpy.ndarray, list[numpy.ndarray], numpy.ndarray]

      Incremental training on already-prepared inputs.

      Returns:
      labels_a_out (np.ndarray): per-sample chosen A-side category indices
      weights_arrays (list[np.ndarray]): per-category weights (float64)
      cluster_labels_out (np.ndarray): map from A categories to B labels




   .. py:method:: predict_ab_prepared(X_prepared: Union[torch.Tensor, numpy.ndarray]) -> Tuple[numpy.ndarray, numpy.ndarray]


.. py:class:: FuzzyARTMAP(rho: float, alpha: float, beta: float, input_dim: Optional[int] = None, device: str = 'cuda', dtype: torch.dtype = torch.float64)

   Bases: :py:obj:`artlib.optimized.backends.torch._TorchSimpleARTMAP._TorchSimpleARTMAP`


   FuzzyARTMAP for Classification. optimized with torch.

   This module implements FuzzyARTMAP

   FuzzyARTMAP is a non-modular classification model which has been highly
   optimized for run-time performance. Fit and predict functions are implemented in
   torch for efficient execution. This class acts as a wrapper for the underlying torch
   functions and to provide compatibility with the artlib style and usage.
   Functionally, FuzzyARTMAP behaves as a special case of
   :class:`~artlib.supervised.SimpleARTMAP.SimpleARTMAP` instantiated with
   :class:`~artlib.elementary.FuzzyART.FuzzyART`.



   .. py:attribute:: _device
      :value: 'cuda'



   .. py:attribute:: _dtype
      :value: Ellipsis



   .. py:attribute:: _backend
      :type:  Optional[_TorchFuzzyARTMAP]
      :value: None



   .. py:attribute:: _declared_input_dim
      :value: None



   .. py:method:: _ensure_backend(X: numpy.ndarray)