cotengra.hyperoptimizers.hyper_skopt
====================================

.. py:module:: cotengra.hyperoptimizers.hyper_skopt

.. autoapi-nested-parse::

   Hyper optimization using scikit-optimize.



Classes
-------

.. autoapisummary::

   cotengra.hyperoptimizers.hyper_skopt.SkoptOptLib


Functions
---------

.. autoapisummary::

   cotengra.hyperoptimizers.hyper_skopt.convert_param_to_skopt
   cotengra.hyperoptimizers.hyper_skopt.get_methods_space
   cotengra.hyperoptimizers.hyper_skopt.convert_to_skopt_space


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

.. py:function:: convert_param_to_skopt(param, name)

.. py:function:: get_methods_space(methods)

.. py:function:: convert_to_skopt_space(method, space)

.. py:class:: SkoptOptLib

   Bases: :py:obj:`cotengra.hyperoptimizers.hyper.HyperOptLib`


   Hyper-optimization using ``scikit-optimize``.


   .. py:method:: setup(methods, space, optimizer=None, sampler='et', method_sampler='et', sampler_opts=None, method_sampler_opts=None, **kwargs)

      Initialize the ``scikit-optimize`` optimizer.

      :param methods: The list of contraction methods to optimize over.
      :type methods: list[str]
      :param space: The search space.
      :type space: dict[str, dict[str, dict]]
      :param optimizer: The parent optimizer instance.
      :type optimizer: HyperOptimizer, optional
      :param sampler: The regressor to use to optimize each method's search space, valid
                      options are:

                      - "et": Extra Trees Regressor
                      - "rf": Random Forest Regressor
                      - "gbrt": Gradient Boosting Regressor
                      - "gp": Gaussian Process Regressor
      :type sampler: str, optional
      :param method_sampler: Meta-optimizer to use to select which overall method to use.
      :type method_sampler: str, optional
      :param sampler_opts: Options to supply to the per-method optimizer.
      :type sampler_opts: dict, optional
      :param method_sampler_opts: Options to supply to the method selector.
      :type method_sampler_opts: dict, optional



   .. py:method:: get_setting()

      Find the next parameters to test.



   .. py:method:: report_result(setting, trial, score)

      Report the result of a trial to the skopt optimizers.