Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix examples in VarQITE and VarQRTE docstrings #9860

Merged
merged 1 commit into from
Mar 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 14 additions & 6 deletions qiskit/algorithms/time_evolvers/variational/var_qite.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,13 @@ class VarQITE(VarQTE, ImaginaryTimeEvolver):

.. code-block::python

import numpy as np

from qiskit.algorithms import TimeEvolutionProblem, VarQITE
from qiskit.algorithms.time_evolvers.variational import ImaginaryMcLachlanPrinciple
from qiskit.circuit.library import EfficientSU2
from qiskit.quantum_info import SparsePauliOp
import numpy as np
from qiskit.quantum_info import SparsePauliOp, Pauli
from qiskit.primitives import Estimator

observable = SparsePauliOp.from_list(
[
Expand All @@ -54,13 +56,19 @@ class VarQITE(VarQTE, ImaginaryTimeEvolver):
)

ansatz = EfficientSU2(observable.num_qubits, reps=1)
init_param_values = np.zeros(len(ansatz.parameters))
for i in range(len(ansatz.parameters)):
init_param_values[i] = np.pi / 2
init_param_values = np.ones(len(ansatz.parameters)) * np.pi/2
var_principle = ImaginaryMcLachlanPrinciple()
time = 1

# without evaluating auxiliary operators
evolution_problem = TimeEvolutionProblem(observable, time)
var_qite = VarQITE(ansatz, var_principle, init_param_values)
var_qite = VarQITE(ansatz, init_param_values, var_principle)
evolution_result = var_qite.evolve(evolution_problem)

# evaluating auxiliary operators
aux_ops = [Pauli("XX"), Pauli("YZ")]
evolution_problem = TimeEvolutionProblem(observable, time, aux_operators=aux_ops)
var_qite = VarQITE(ansatz, init_param_values, var_principle, Estimator())
evolution_result = var_qite.evolve(evolution_problem)
"""

Expand Down
23 changes: 16 additions & 7 deletions qiskit/algorithms/time_evolvers/variational/var_qrte.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,14 @@ class VarQRTE(VarQTE, RealTimeEvolver):

.. code-block::python

from qiskit.algorithms import TimeEvolutionProblem, VarQITE
import numpy as np

from qiskit.algorithms import TimeEvolutionProblem, VarQRTE
from qiskit.circuit.library import EfficientSU2
from qiskit.algorithms.time_evolvers.variational import RealMcLachlanPrinciple
from qiskit.quantum_info import SparsePauliOp
import numpy as np
from qiskit.quantum_info import SparsePauliOp, Pauli
from qiskit.primitives import Estimator

observable = SparsePauliOp.from_list(
[
Expand All @@ -54,14 +57,20 @@ class VarQRTE(VarQTE, RealTimeEvolver):
)

ansatz = EfficientSU2(observable.num_qubits, reps=1)
init_param_values = np.zeros(len(ansatz.parameters))
for i in range(len(ansatz.parameters)):
init_param_values[i] = np.pi / 2
init_param_values = np.ones(len(ansatz.parameters)) * np.pi/2
var_principle = RealMcLachlanPrinciple()
time = 1

# without evaluating auxiliary operators
evolution_problem = TimeEvolutionProblem(observable, time)
var_qrte = VarQRTE(ansatz, var_principle, init_param_values)
evolution_result = var_qite.evolve(evolution_problem)
var_qrte = VarQRTE(ansatz, init_param_values, var_principle)
evolution_result = var_qrte.evolve(evolution_problem)

# evaluating auxiliary operators
aux_ops = [Pauli("XX"), Pauli("YZ")]
evolution_problem = TimeEvolutionProblem(observable, time, aux_operators=aux_ops)
var_qrte = VarQRTE(ansatz, init_param_values, var_principle, Estimator())
evolution_result = var_qrte.evolve(evolution_problem)
"""

def __init__(
Expand Down