simopt.experimental
===================

.. py:module:: simopt.experimental

.. autoapi-nested-parse::

   Experimental framework for running experiments.







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

.. py:class:: ProblemConfig(name: str, rename: str | None = None, fixed_factors: dict | None = None, model_fixed_factors: dict | None = None)

   Class to hold problem config information.

   Initialize the Problem with name, rename, and problem/model fixed factors.


   .. py:attribute:: name


   .. py:attribute:: rename


   .. py:attribute:: fixed_factors


   .. py:attribute:: model_fixed_factors


.. py:class:: SolverConfig(name: str, rename: str | None = None, fixed_factors: dict | None = None)

   Class to hold solver config information.

   Initialize the Solver with name, rename, and solver fixed factors.


   .. py:attribute:: name


   .. py:attribute:: rename


   .. py:attribute:: fixed_factors


.. py:function:: run_experiment(problems: list[dict], solvers: list[dict], num_macroreps: int, num_postreps: int, num_postnorms: int) -> list[list[simopt.experiment_base.ProblemSolver]]

   Run an experiment using the provided configurations.

   :param problems: List of ProblemConfig instances.
   :param solvers: List of SolverConfig instances.
   :param num_macroreps: Number of macroreplications.
   :param num_postreps: Number of post-replications.
   :param num_postnorms: Number of post-normalizations.

   :returns: A list of lists containing ProblemSolver instances,
             grouped by problem.
   :rtype: List[list[ProblemSolver]]


.. py:function:: group_experiments_by_solver(all_experiments: list[list[simopt.experiment_base.ProblemSolver]]) -> list[list[simopt.experiment_base.ProblemSolver]]

   Group experiments by solver name.