Add note on default uncertainty samples in ProphetForecaster

grafana · Dec 10, 2024 · 78f1b33 · 78f1b33
1 parent 4cabe52
commit 78f1b33
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/crates/augurs-prophet/src/forecaster.rs b/crates/augurs-prophet/src/forecaster.rs
@@ -27,6 +27,8 @@ impl ProphetForecaster {
     /// # Parameters
     ///
     /// - `opts`: The options to use for fitting the model.
+    ///           Note that `uncertainty_samples` will be set to 1000 if it is 0,
+    ///           to facilitate generating prediction intervals.
     /// - `optimizer`: The optimizer to use for fitting the model.
     /// - `optimize_opts`: The options to use for optimizing the model.
     pub fn new<T: Optimizer + 'static>(