diff --git a/pyrs/src/optimiser.rs b/pyrs/src/optimiser.rs index a56eb0409..9355b9957 100644 --- a/pyrs/src/optimiser.rs +++ b/pyrs/src/optimiser.rs @@ -42,11 +42,25 @@ impl PyDefaultTasoOptimiser { /// /// Returns an optimised circuit and optionally log the progress to a CSV /// file. + /// + /// # Parameters + /// + /// * `circ`: The circuit to optimise. + /// * `timeout`: The timeout in seconds. + /// * `n_threads`: The number of threads to use. + /// * `split_circ`: Whether to split the circuit into chunks before + /// processing. + /// + /// If this option is set, the optimise will divide the circuit into + /// `n_threads` chunks and optimise each on a separate thread. + /// * `log_progress`: The path to a CSV file to log progress to. + /// pub fn optimise( &self, circ: PyObject, timeout: Option, n_threads: Option, + split_circ: Option, log_progress: Option, ) -> PyResult { let taso_logger = log_progress @@ -61,7 +75,7 @@ impl PyDefaultTasoOptimiser { taso_logger, timeout, n_threads.unwrap_or(NonZeroUsize::new(1).unwrap()), - false, + split_circ.unwrap_or(false), ) }) }