qemcmc.model.model_maker
========================

.. py:module:: qemcmc.model.model_maker


Classes
-------

.. autoapisummary::

   qemcmc.model.model_maker.ModelMaker


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

.. py:class:: ModelMaker(n_spins: int, model_type: str, name: str, cost_function_signs: list = [-1, -1])

   Utility class for constructing standard Ising energy models used in simulations and experiments.

   This class constructs predefined random energy models used for testing
   and experimentation. Depending on the chosen ``model_type``, it generates
   coupling tensors and initialises an :class:`EnergyModel` instance.


   .. py:attribute:: name


   .. py:attribute:: n_spins


   .. py:attribute:: cost_function_signs


   .. py:method:: make_fully_connected_ising()


   .. py:method:: make_fully_connected_binary()

      Transforms the existing Ising couplings into an mathematically
      equivalent QUBO model via s = 2x - 1.