Source code for qiskit_optimization.runtime.vqe_program

# This code is part of Qiskit.
# (C) Copyright IBM 2021.
# This code is licensed under the Apache License, Version 2.0. You may
# obtain a copy of this license in the LICENSE.txt file in the root directory
# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
# Any modifications or derivative works of this code must retain this
# copyright notice, and modified files need to carry a notice indicating
# that they have been altered from the originals.

"""The Qiskit Optimization VQE Quantum Program."""

from typing import List, Callable, Optional, Any, Dict, Union
import warnings
import numpy as np

from qiskit import QuantumCircuit
from qiskit.providers import Provider
from qiskit.providers.backend import Backend
from qiskit.algorithms import MinimumEigensolverResult
from qiskit.algorithms.optimizers import Optimizer
from qiskit.opflow import OperatorBase

from ..deprecation import warn_deprecated, DeprecatedType

from .vqe_client import VQEClient, VQERuntimeResult

[docs]class VQEProgram(VQEClient): """DEPRECATED. This class has been renamed to ``qiskit_optimization.runtime.VQEClient``. This renaming reflects that this class is a client for a program executed in the cloud. """ def __init__( self, ansatz: QuantumCircuit, optimizer: Optional[Union[Optimizer, Dict[str, Any]]] = None, initial_point: Optional[np.ndarray] = None, provider: Optional[Provider] = None, backend: Optional[Backend] = None, shots: int = 1024, measurement_error_mitigation: bool = False, callback: Optional[Callable[[int, np.ndarray, float, float], None]] = None, store_intermediate: bool = False, ) -> None: """ Args: ansatz: A parameterized circuit used as Ansatz for the wave function. optimizer: An optimizer or dictionary specifying a classical optimizer. If a dictionary, only SPSA and QN-SPSA are supported. The dictionary must contain a key ``name`` for the name of the optimizer and may contain additional keys for the settings. E.g. ``{'name': 'SPSA', 'maxiter': 100}``. Per default, SPSA is used. backend: The backend to run the circuits on. initial_point: An optional initial point (i.e. initial parameter values) for the optimizer. If ``None`` a random vector is used. provider: Provider that supports the runtime feature. shots: The number of shots to be used measurement_error_mitigation: Whether or not to use measurement error mitigation. callback: a callback that can access the intermediate data during the optimization. Four parameter values are passed to the callback as follows during each evaluation by the optimizer for its current set of parameters as it works towards the minimum. These are: the evaluation count, the optimizer parameters for the ansatz, the evaluated mean and the evaluated standard deviation. store_intermediate: Whether or not to store intermediate values of the optimization steps. Per default False. """ warn_deprecated( version="0.3.0", old_type=DeprecatedType.CLASS, old_name="VQEProgram", new_name="VQEClient", additional_msg="from qiskit_optimization.runtime", ) super().__init__( ansatz, optimizer, initial_point, provider, backend, shots, measurement_error_mitigation, callback, store_intermediate, )
[docs] @classmethod def supports_aux_operators(cls) -> bool: return True
[docs] def compute_minimum_eigenvalue( self, operator: OperatorBase, aux_operators: Optional[List[Optional[OperatorBase]]] = None ) -> MinimumEigensolverResult: result = super().compute_minimum_eigenvalue(operator, aux_operators) # convert to previous result type with warnings.catch_warnings(): warnings.filterwarnings("ignore", category=DeprecationWarning) vqe_result = VQEProgramResult() vqe_result.combine(result) return vqe_result
[docs]class VQEProgramResult(VQERuntimeResult): """DEPRECATED. The ``VQEProgram`` result object has been renamed to ``VQERuntimeResult``. This result objects contains the same as the VQEResult and additionally the history of the optimizer, containing information such as the function and parameter values per step. """ def __init__(self) -> None: super().__init__() warn_deprecated( version="0.3.0", old_type=DeprecatedType.CLASS, old_name="VQEProgramResult", new_name="VQERuntimeResult", additional_msg="from qiskit_optimization.runtime", )

© Copyright 2018, 2021, Qiskit Optimization Development Team.

Built with Sphinx using a theme provided by Read the Docs.