Skip to content

Commit

Permalink
Add log param to run docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
bdg221 committed Nov 14, 2024
1 parent 9561b9f commit 3e1a6f7
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion mitiq/calibration/calibrator.py
Original file line number Diff line number Diff line change
Expand Up @@ -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()

Expand Down

0 comments on commit 3e1a6f7

Please sign in to comment.