pyfebiopt.optimize.options
==========================

.. py:module:: pyfebiopt.optimize.options

.. autoapi-nested-parse::

   Configuration dataclasses for the optimization engine.



Classes
-------

.. autoapisummary::

   pyfebiopt.optimize.options.GridPolicyOptions
   pyfebiopt.optimize.options.JacobianOptions
   pyfebiopt.optimize.options.CleanupOptions
   pyfebiopt.optimize.options.RunnerOptions
   pyfebiopt.optimize.options.StorageOptions
   pyfebiopt.optimize.options.LoggingOptions
   pyfebiopt.optimize.options.MonitorOptions
   pyfebiopt.optimize.options.OptimizerOptions
   pyfebiopt.optimize.options.EngineOptions


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

.. py:class:: GridPolicyOptions

   Configuration for how simulations align with experiments.


   .. py:attribute:: policy
      :type:  Literal['exp_to_sim', 'fixed_user']
      :value: 'exp_to_sim'



   .. py:attribute:: values
      :type:  collections.abc.Sequence[float] | None
      :value: None



.. py:class:: JacobianOptions

   Jacobian evaluation controls.


   .. py:attribute:: enabled
      :type:  bool
      :value: False



   .. py:attribute:: perturbation
      :type:  float
      :value: 1e-06



   .. py:attribute:: parallel
      :type:  bool
      :value: True



.. py:class:: CleanupOptions

   Cleanup behavior for working directories.


   .. py:attribute:: remove_previous
      :type:  bool
      :value: False



   .. py:attribute:: mode
      :type:  Literal['none', 'all']
      :value: 'none'



.. py:class:: RunnerOptions

   Execution backend configuration.


   .. py:attribute:: jobs
      :type:  int
      :value: 1



   .. py:attribute:: command
      :type:  collections.abc.Sequence[str] | None
      :value: None



   .. py:attribute:: env
      :type:  collections.abc.Mapping[str, str] | None
      :value: None



.. py:class:: StorageOptions

   Storage and logging configuration.


   .. py:attribute:: mode
      :type:  Literal['disk', 'tmp']
      :value: 'disk'



   .. py:attribute:: root
      :type:  str | pathlib.Path | None
      :value: None



   .. py:attribute:: log_file
      :type:  str | pathlib.Path | None
      :value: None



.. py:class:: LoggingOptions

   Console reporting controls.


   .. py:attribute:: optimizer_space
      :type:  bool
      :value: False



.. py:class:: MonitorOptions

   Monitoring client configuration.


   .. py:attribute:: enabled
      :type:  bool
      :value: True



   .. py:attribute:: socket
      :type:  str | pathlib.Path | None
      :value: None



   .. py:attribute:: label
      :type:  str | None
      :value: None



.. py:class:: OptimizerOptions

   Optimizer adapter selection and advanced settings.


   .. py:attribute:: name
      :type:  Literal['least_squares', 'minimize']
      :value: 'least_squares'



   .. py:attribute:: settings
      :type:  collections.abc.Mapping[str, Any]


   .. py:attribute:: reparametrize
      :type:  bool
      :value: True



.. py:class:: EngineOptions

   Aggregate container for optimization engine configuration.


   .. py:attribute:: jacobian
      :type:  JacobianOptions


   .. py:attribute:: cleanup
      :type:  CleanupOptions


   .. py:attribute:: runner
      :type:  RunnerOptions


   .. py:attribute:: storage
      :type:  StorageOptions


   .. py:attribute:: logging
      :type:  LoggingOptions


   .. py:attribute:: monitor
      :type:  MonitorOptions


   .. py:attribute:: optimizer
      :type:  OptimizerOptions