From 675d9a44f6fce1265cfdcce53d202ef379240ea2 Mon Sep 17 00:00:00 2001 From: Shivansh Mittal Date: Sat, 30 Nov 2024 12:45:23 +0530 Subject: [PATCH] adding linespace --- mitiq/cdr/cdr.py | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/mitiq/cdr/cdr.py b/mitiq/cdr/cdr.py index ec3384eb71..1a76802ead 100644 --- a/mitiq/cdr/cdr.py +++ b/mitiq/cdr/cdr.py @@ -74,22 +74,30 @@ def execute_with_cdr( scale_noise: scale_noise: Function for scaling the noise of a quantum circuit. scale_factors: Factors by which to scale the noise. + - When 1.0 is the only scale factor, the method is known as CDR. + - Note: When scale factors larger than 1.0 are provided, the method is known as "variable-noise CDR." + kwargs: Available keyword arguments are: + - method_select (string): Specifies the method used to select the non-Clifford gates to replace when constructing the near-Clifford training circuits. Can be 'uniform' or 'gaussian'. + - method_replace (string): Specifies the method used to replace the selected non-Clifford gates with a Clifford when constructing the near-Clifford training circuits. Can be 'uniform', 'gaussian', or 'closest'. + - sigma_select (float): Width of the Gaussian distribution used for ``method_select='gaussian'``. + - sigma_replace (float): Width of the Gaussian distribution used for ``method_replace='gaussian'``. + - random_state (int): Seed for sampling. """ # Handle keyword arguments for generating training circuits. @@ -201,22 +209,30 @@ def mitigate_executor( scale_noise: scale_noise: Function for scaling the noise of a quantum circuit. scale_factors: Factors by which to scale the noise. + - When 1.0 is the only scale factor, the method is known as CDR. + - Note: When scale factors larger than 1.0 are provided, the method is known as "variable-noise CDR." + kwargs: Available keyword arguments are: + - method_select (string): Specifies the method used to select the non-Clifford gates to replace when constructing the near-Clifford training circuits. Can be 'uniform' or 'gaussian'. + - method_replace (string): Specifies the method used to replace the selected non-Clifford gates with a Clifford when constructing the near-Clifford training circuits. Can be 'uniform', 'gaussian', or 'closest'. + - sigma_select (float): Width of the Gaussian distribution used for ``method_select='gaussian'``. + - sigma_replace (float): Width of the Gaussian distribution used for ``method_replace='gaussian'``. + - random_state (int): Seed for sampling.""" executor_obj = Executor(executor) if not executor_obj.can_batch: