From 78f1b3381fed76011c8a6d08f7357cb24518c8e7 Mon Sep 17 00:00:00 2001
From: Ben Sully <ben.sully88@gmail.com>
Date: Tue, 10 Dec 2024 11:32:07 +0000
Subject: [PATCH] Add note on default uncertainty samples in ProphetForecaster

---
 crates/augurs-prophet/src/forecaster.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/crates/augurs-prophet/src/forecaster.rs b/crates/augurs-prophet/src/forecaster.rs
index a1de3b8..bd176ba 100644
--- 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>(