cotengra.hyperoptimizers.hyper_nevergrad
========================================

.. py:module:: cotengra.hyperoptimizers.hyper_nevergrad

.. autoapi-nested-parse::

   Hyper optimization using nevergrad.



Classes
-------

.. autoapisummary::

   cotengra.hyperoptimizers.hyper_nevergrad.NevergradOptLib


Functions
---------

.. autoapisummary::

   cotengra.hyperoptimizers.hyper_nevergrad.convert_param_to_nevergrad
   cotengra.hyperoptimizers.hyper_nevergrad.get_methods_space
   cotengra.hyperoptimizers.hyper_nevergrad.convert_to_nevergrad_space


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

.. py:function:: convert_param_to_nevergrad(param)

.. py:function:: get_methods_space(methods)

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

.. py:class:: NevergradOptLib

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


   Hyper-optimization using ``nevergrad``.


   .. py:method:: setup(methods, space, optimizer=None, sampler='NaiveTBPSA', method_sampler=None, budget='auto', num_workers=1, method_budget='auto', method_num_workers=1, sampler_opts=None, method_sampler_opts=None)

      Initialize the ``nevergrad`` 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, used for ``max_repeats``
                        and ``_num_workers`` when ``budget`` or ``num_workers``
                        are ``'auto'``.
      :type optimizer: HyperOptimizer, optional
      :param sampler: The optimizer to use to search each method's search space,
                      see nevergrad docs.
      :type sampler: str, optional
      :param method_sampler: The meta-optimizer to use to select overall methods.
      :type method_sampler: str, optional
      :param budget: Supplied to optimizer.
      :type budget: int, optional
      :param num_workers: Supplied to optimizer.
      :type num_workers: int, optional
      :param method_budget: Supplied to meta-optimizer.
      :type method_budget: int, optional
      :param method_num_workers: Supplied to meta-optimizer.
      :type method_num_workers: int, optional



   .. py:method:: get_setting()

      Get a setting to trial from one of the nevergrad optimizers.



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

      Report the result of a trial to the nevergrad optimizers.