.. _api:

======================
API Reference
======================

Methods are categorized based on their analytical focus:

1. **Single-Set Analysis**: Methods that examine relationships among variables within a single dataset, or when multiple datasets are combined and analyzed as one.
2. **Multi-Set Analysis**: Methods that investigate relationships or patterns between variables across two or more distinct datasets.


.. grid:: 2

    .. grid-item-card::  Single-Set Analysis
      :link: api_1_intra
      :link-type: doc


      Unveil relationships between variables within a single dataset.

    .. grid-item-card::  Multi-Set Analysis
      :link: api_2_inter
      :link-type: doc

      Uncover relationships between two or more datasets.


.. grid:: 2

    .. grid-item-card::  Model Evaluation
      :link: api_3_eval
      :link-type: doc


      Assess the quality of your model.

    .. grid-item-card::  Utilities
      :link: api_4_utils
      :link-type: doc

      Support functions.


.. warning:: 

    The package is under development, and its API may change.


.. toctree::
   :maxdepth: 3
   :hidden:

   api_1_intra
   api_2_inter
   api_3_eval
   api_4_utils