.. _api:

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

Linear Models
-------------

.. autoclass:: gaugefixer.HierarchicalModel
    :members: get_orbits, get_generating_orbits, get_features, get_params, set_params, set_random_params, __call__, get_fixed_params

.. autoclass:: gaugefixer.AllOrderModel
    :members: get_orbits, get_generating_orbits, get_features, get_params, set_params, set_random_params, set_landscape, __call__, get_fixed_params,

.. autoclass:: gaugefixer.KorderModel
    :members: get_orbits, get_generating_orbits, get_features, get_params, set_params, set_random_params,  __call__, get_fixed_params

.. autoclass:: gaugefixer.PairwiseModel
    :members: get_orbits, get_generating_orbits, get_features, get_params, set_params, set_random_params, __call__, get_fixed_params

.. autoclass:: gaugefixer.AdditiveModel
    :members: get_orbits, get_generating_orbits, get_features, get_params, set_params, set_random_params, __call__, get_fixed_params

.. autoclass:: gaugefixer.KadjacentModel
    :members: get_orbits, get_generating_orbits, get_features, get_params, set_params, set_random_params, __call__, get_fixed_params

.. autoclass:: gaugefixer.NeighborModel
    :members: get_orbits, get_generating_orbits, get_features, get_params, set_params, set_random_params, __call__, get_fixed_params