Skip to content

Commit

Permalink
change docstring for zne/layer_scaling
Browse files Browse the repository at this point in the history
  • Loading branch information
purva-thakre committed May 4, 2024
1 parent 1b61317 commit 63297af
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions mitiq/zne/scaling/layer_scaling.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,15 @@ def layer_folding(
) -> cirq.Circuit:
"""Applies a variable amount of folding to select layers of a circuit.
Note that this method only works for the univariate extrapolation methods.
It allows a user to choose which layers in the input circuit will be scaled
The layerwise folding required for multivariate extrapolation is different
as the layers in the input circuit have to be scaled in a specific pattern.
The required specific pattern for multivariate extrapolation does not allow
a user to provide a choice of which layers to fold. If you would prefer to
use a multivariate extrapolation method for unitary
folding, use the functions available in `mitiq/lre` instead.
Args:
circuit: The input circuit.
layers_to_fold: A list with the index referring to the layer number,
Expand Down

0 comments on commit 63297af

Please sign in to comment.