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

This section provides the auto-generated API documentation for the gaitmod library.


Leadfield Simulation
--------------------

.. automodule:: gaitmod.MatFileReader
   :members:
   :undoc-members:
   :show-inheritance:

Data Simulation
---------------

.. automodule:: gaitmod.DataProcessor
   :members:
   :undoc-members:
   :show-inheritance:

Source Estimation
------------------

.. automodule:: gaitmod.Visualise
   :members:
   :undoc-members:
   :show-inheritance:

Base Model
----------

.. automodule:: gaitmod.BaseModel
   :members:
   :undoc-members:
   :show-inheritance:

Regression Models
-----------------

.. automodule:: gaitmod.RegressionModels
   :members:
   :undoc-members:
   :show-inheritance:

Linear Regression Model
----------------------

.. automodule:: gaitmod.LinearRegressionModel
   :members:
   :undoc-members:
   :show-inheritance:

Regression LSTM Model
---------------------

.. automodule:: gaitmod.RegressionLSTMModel
   :members:
   :undoc-members:
   :show-inheritance:

Classification Models
---------------------

.. automodule:: gaitmod.ClassificationModels
   :members:
   :undoc-members:
   :show-inheritance:

Classification LSTM Model
-------------------------

.. automodule:: gaitmod.ClassificationLSTMModel
   :members:
   :undoc-members:
   :show-inheritance:

Feature Extractor 2
-------------------

.. automodule:: gaitmod.FeatureExtractor2
   :members:
   :undoc-members:
   :show-inheritance:

LSTM Classifier
---------------

.. automodule:: gaitmod.LSTMClassifier
   :members:
   :undoc-members:
   :show-inheritance:

Custom Grid Search CV
---------------------

.. automodule:: gaitmod.CustomGridSearchCV
   :members:
   :undoc-members:
   :show-inheritance:

Custom Training Logger
----------------------

.. automodule:: gaitmod.CustomTrainingLogger
   :members:
   :undoc-members:
   :show-inheritance: