From 3e1a6f79cfb02c78294d1df8ad9e076f730707f5 Mon Sep 17 00:00:00 2001 From: bdg221 Date: Thu, 14 Nov 2024 11:31:09 -0800 Subject: [PATCH] Add log param to run docstring --- mitiq/calibration/calibrator.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/mitiq/calibration/calibrator.py b/mitiq/calibration/calibrator.py index 4f81fb6c0..f034d0bc8 100644 --- a/mitiq/calibration/calibrator.py +++ b/mitiq/calibration/calibrator.py @@ -297,7 +297,13 @@ def get_cost(self) -> Dict[str, int]: } def run(self, log: Optional[OutputForm] = None) -> None: - """Runs all the circuits required for calibration.""" + """Runs all the circuits required for calibration. + + args: + log: If set, detailed results of each experiment run by the + calibrator are printed. The value corresponds to the format of + the information and can be set to “flat” or “cartesian”. + """ if not self.results.is_missing_data(): self.results.reset_data()