Generate SqDRIFT circuits¶
With SQD, you must choose an ansatz from which to sample bitstrings. The SqDRIFT variant uses an ensemble of time evolution circuits constructed directly from the target Hamiltonian instead. This is achieved by subsampling smaller time evolution operators from the Hamiltonian based on its coefficients, which is known as the qDRIFT Trotterization method.
This getting-started guide shows how to generate an ensemble of such randomized circuits.
1. Hamiltonian setup¶
For the purposes of this guide, we load the electronic structure Hamiltonian
of N2 from an FCIDUMP file. Of course, there are other means of
constructing the FermionOperator. Be sure to check out its
documentation, as well as the qiskit_fermions.operators.library.
>>> from qiskit_fermions.operators.library import FCIDump
>>> from qiskit_fermions.operators import FermionOperator
>>>
>>> fcidump = FCIDump.from_file("docs/guides/n2.fcidump")
>>> num_modes = 2 * fcidump.norb
>>> hamil = FermionOperator.from_fcidump(fcidump)
#include <qiskit_fermions.h>
QfFCIDump* fcidump = qf_fcidump_from_file("docs/guides/n2.fcidump");
QfFermionOperator* hamil = qf_ferm_op_from_fcidump(fcidump);
uint32_t num_modes = 2 * qf_fcidump_norb(fcidump);
2. Group Hamiltonian terms¶
In this step, we exploit the many symmetries that are present in the electronic structure Hamiltonian by grouping related terms that have identical coefficients. This action changes the operator coefficient distribution that the qDRIFT protocol samples from, but it does not affect its convergence guarantees. Crucially, grouping terms that are related by symmetry results in a favorable cancellation of Pauli terms, resulting in an overall shorter circuit depth when time evolving a state under their action.
The qiskit_fermions.operators.grouping module provides convenience
functions for grouping an operator’s terms. This is explained in more
detail in this guide.
>>> from qiskit_fermions.operators.grouping import group_terms_by_electronic_structure
>>>
>>> exit_code = group_terms_by_electronic_structure(hamil, num_modes)
>>> assert exit_code is None
>>> print(hamil.groups) # the groups attribute now contains some list of group indices
[0, ...]
QfExitCode exit = qf_group_terms_by_electronic_structure(hamil, num_modes, false);
3. Prepare the time evolution circuit¶
In this step, we prepare the Hamiltonian’s time evolution circuit and the
base circuit from which to draw samples. The
qiskit_fermions.circuit.library contains all the required
components to do so, in compliance with Qiskit conventions.
>>> from qiskit_fermions.circuit import FermionicCircuit
>>> from qiskit_fermions.circuit.library import Evolution
>>>
>>> time = 1.0 # you can choose a desired scaling factor here
>>> evo_gate = Evolution(num_modes, hamil, time)
>>>
>>> circ = FermionicCircuit(num_modes)
>>> circ.append(evo_gate, circ.modes)
// WARNING: Qiskit's C API does not yet allow us to implement circuits
// with custom gate definitions.
Note
In this example, we neither initialize the fermionic modes with particles, nor measure their final state.
4. Transpile the circuit with QDrift Trotterization¶
The qiskit_fermions.transpiler module integrates directly with Qiskit’s
transpilation pipeline, allowing the FermionicCircuit constructed above
to be directly transpiled to a QuantumCircuit.
Here, we are using the jordan_wigner() fermion-to-qubit mapping to
convert the Hamiltonian expressed in terms of fermions to be expressed in Pauli strings instead. This
can be done directly as part of the transpilation process by using the
EvolutionSynthesis transpilation pass plugin. Here, we are using
generate_preset_jw_pass_manager() to build
FermionicStagedPassManager, which ensures that the
Jordan-Wigner encoding is used consistently for all circuit instructions.
Crucially, we add the QDriftTrotterization transpilation pass to the
optimization stage of the transpilation pipeline. This ensures that we do
not use the time evolution of the entire Hamiltonian, a circuit whose depth
would exceed the capabilities of currently available quantum computing hardware.
Instead, it will subsample a fixed number of groups of Hamiltonian terms for
each circuit, every time we transpile the circuit. Through this, we can generate
multiple circuit randomizations as required by the SqDRIFT algorithm by
repeatedly running the transpilation pipeline.
This step also introduces the few parameters with which one can tweak the ensemble of circuits to generate:
the number of circuits to generate:
num_sqdrift_randomizationsthe length of each circuit in terms of excitation groups:
num_groups
>>> from qiskit_fermions.transpiler import FermionicPassManager
>>> from qiskit_fermions.transpiler.presets import generate_preset_jw_pass_manager
>>> from qiskit_fermions.transpiler.passes import QDriftTrotterization
>>>
>>> num_groups = 10
>>> qdrift = QDriftTrotterization(num_groups, rng=42)
>>>
>>> pm = generate_preset_jw_pass_manager()
>>> pm.optimization = FermionicPassManager([qdrift])
>>>
>>> num_sqdrift_randomizations = 10
>>> sqdrift_circuits = [
... pm.run(circ) for _ in range(num_sqdrift_randomizations)
... ]
// WARNING: Qiskit's C API does not yet allow us to implement circuits
// with custom gate definitions, which we therefore also cannot transpile
// via this API.
Note
In the example above we have fixed the seed for the random number
generator used inside of the QDriftTrotterization transpilation
pass.
(Optional) Optimize the fermionic mode indexing¶
You can add an additional optimization step to the transpilation pipeline that
minimizes the distance of the fermionic excitation spans by relabeling the
fermionic mode indices. This optimization was introduced in the SqDRIFT paper
and is implemented by build_excitation_span_minimization_model(). It can
be easily inserted into the transpiler pipeline via the RelabelModes
pass:
>>> from pyomo.environ import SolverFactory
>>> from qiskit_fermions.transpiler.passes import RelabelModes
>>>
>>> solver = SolverFactory("appsi_highs")
>>> solver.options["time_limit"] = 60
>>>
>>> qdrift = QDriftTrotterization(5, rng=42)
>>> relabel = RelabelModes(solver=solver)
>>>
>>> pm.optimization = FermionicPassManager([qdrift, relabel])
>>>
>>> relabeled_circ = pm.run(circ)
>>> assert "permutation" in relabeled_circ.metadata
// WARNING: This feature is not available via the C API.
Note
Using the automatic optimization inside RelabelModes (which
leverages build_excitation_span_minimization_model()) requires the
optional dependency managed by HAS_PYOMO.
Important
In order to perform the correct subspace diagonalization, the bitstrings
sampled from circuits that were transpiled with the RelabelModes
optimization pass must be post-processed based on the permutation
information contained in the circuits’ metadata!
Next steps¶
Now that we have successfully generated an ensemble of circuits, we can sample bitstrings from them. To do so, the circuits must be executed on hardware. Refer to the Qiskit documentation for detailed instructions.
Once the bitstring samples have been obtained, these can be used in combination with the Hamiltonian coefficients to perform SQD post-processing, as explained in the SQD addon tutorials tutorial.