Skip to content

Commit 5162326

Browse files
authored
Minor updates to calibration_faq page (#5357)
- Correct names of a few references to provide correct linking. - Expose the function name for a function used in this tutorial.
1 parent 15d0fc9 commit 5162326

File tree

3 files changed

+13
-11
lines changed

3 files changed

+13
-11
lines changed

cirq-google/cirq_google/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@
4141
make_zeta_chi_gamma_compensation_for_moments,
4242
make_zeta_chi_gamma_compensation_for_operations,
4343
merge_matching_results,
44+
prepare_characterization_for_circuits_moments,
4445
prepare_floquet_characterization_for_moments,
4546
prepare_characterization_for_moments,
4647
prepare_floquet_characterization_for_moment,

cirq-google/cirq_google/calibration/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@
4242
make_zeta_chi_gamma_compensation_for_moments,
4343
make_zeta_chi_gamma_compensation_for_operations,
4444
prepare_floquet_characterization_for_moments,
45+
prepare_characterization_for_circuits_moments,
4546
prepare_characterization_for_moments,
4647
prepare_floquet_characterization_for_moment,
4748
prepare_characterization_for_moment,

docs/google/calibration_faq.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ This is in principle a three-step process which consists of the following three
6565
to be characterized.
6666

6767
3. Compile the circuit: The final step is to use the results of the characterization to re-compile the circuit to compensate
68-
for ζ, χ and γ angles. This can be done with the help of `cirq_google.make_zeta_chi_gamma_compensation_for_moment` function.
68+
for ζ, χ and γ angles. This can be done with the help of `cirq_google.make_zeta_chi_gamma_compensation_for_moments` function.
6969

7070
## When should Floquet or XEB Calibrations be used?
7171

@@ -199,7 +199,7 @@ Compensation for the remaining two parameters θ and φ can’t be realized in a
199199
to adjust to these errors by modifying circuit construction, compilation, or problem statement, but this must be handled by the
200200
user and cannot be done automatically.
201201

202-
For these advanced use cases, the `cirq_google.run_calibration` method can be called directly with a list of
202+
For these advanced use cases, the `cirq_google.run_calibrations` method can be called directly with a list of
203203
`cirq_google.PhasedFSimCalibrationRequest` objects. This will allow you to call the Calibration API directly to specify
204204
customized layers for characterizations.
205205

@@ -212,11 +212,11 @@ class PhasedFSimCalibrationRequest(abc.ABC):
212212
# either FloquetPhasedFSimCalibrationOptions or LocalXEBPhasedFSimCalibrationOptions
213213
```
214214

215-
After triggering this calibration with the `cirq_google.run_calibrations` method, the `PhasedFSimCalibrationResult` is returned
216-
with a parameters field that contains the unitary parameters of all the requested gates. The object also contains additional
217-
execution metadata which might be useful.
215+
After triggering this calibration with the `cirq_google.run_calibrations` method, the `cirq_google.PhasedFSimCalibrationResult`
216+
is returned with a parameters field that contains the unitary parameters of all the requested gates. The object also contains
217+
additional execution metadata which might be useful.
218218

219-
See also ["How to compensate for the parasitic c-phase φ angle?"](#how-to-compensate-for-the-parasitic-c-phase-φ-angle) below.
219+
See also ["How to compensate for the parasitic c-phase φ angle?"](##how_to_compensate_for_the_parasitic_c-phase_φ_angle) below.
220220

221221
## Floquet calibration fails with a message: Readout errors above the tolerance for qubit pairs (...), what can be done?
222222

@@ -286,14 +286,14 @@ For a complete set of best practices, check the following [guide](./best_practic
286286

287287
## How to compensate for the parasitic c-phase φ angle?
288288

289-
The `cirq_google.SQRT_ISWAP` gate ideally should have a zero value of the φ angle. In practice the ZZ interaction always
290-
happen during the gate execution and all the two-qubit gates attain some unwanted parasitic c-phase angle φ. The typical
291-
values for √iSWAP gate are about 0.13 which might be significant amount for certain applications, especially when circuits
289+
The `cirq_google.SQRT_ISWAP` gate ideally should have a zero value of the φ angle. In practice the ZZ interaction always
290+
happens during the gate execution, and all the two-qubit gates attain some unwanted parasitic c-phase angle φ. The typical
291+
values for √iSWAP gate are about 0.13 which might be significant for certain applications, especially when circuits
292292
of large depth are executed that accumulate errors caused by this term.
293293

294294
Compensating for this parameter can be achieved in certain situations although in most cases the compensation adds more gates
295295
which can cause the increase in the circuit runtime. Thus, the compensation itself might introduce even more noise during
296-
execution, so it’s feasibility should be chosen on a case-by-case basis.
296+
execution, so its feasibility should be chosen on a case-by-case basis.
297297

298298
The following references might provide some help on dealing with this issue but none of them is a complete solution to the problem:
299299

@@ -313,4 +313,4 @@ The following references might provide some help on dealing with this issue but
313313
[arXiv:2105.06074](https://arxiv.org/abs/2105.06074). However, it only allows to decompose into ideal `cirq.SQRT_ISWAP`
314314
gates and thus is not useful for dealing with parasitic c-phase.
315315

316-
* This is an active topic of research and we welcome more references.
316+
* This is an active topic of research, and we welcome more references.

0 commit comments

Comments
 (0)