From c8bb458ae00b47924101d54415926b78efd8de9b Mon Sep 17 00:00:00 2001
From: laresbernardo <laresbernardo@gmail.com>
Date: Mon, 21 Oct 2024 12:09:54 +0200
Subject: [PATCH] docs: update seeds param to explain how each trial increases
 seed by a unit #1005 (#1078)

---
 R/DESCRIPTION        | 2 +-
 R/R/model.R          | 4 +++-
 R/man/robyn_mmm.Rd   | 4 +++-
 R/man/robyn_run.Rd   | 4 +++-
 R/man/robyn_train.Rd | 4 +++-
 5 files changed, 13 insertions(+), 5 deletions(-)

diff --git a/R/DESCRIPTION b/R/DESCRIPTION
index 49cfe403d..fbebcc50e 100644
--- a/R/DESCRIPTION
+++ b/R/DESCRIPTION
@@ -1,7 +1,7 @@
 Package: Robyn
 Type: Package
 Title: Semi-Automated Marketing Mix Modeling (MMM) from Meta Marketing Science 
-Version: 3.11.1.9003
+Version: 3.11.1.9004
 Authors@R: c(
     person("Gufeng", "Zhou", , "gufeng@meta.com", c("aut")),
     person("Bernardo", "Lares", , "laresbernardo@gmail.com", c("cre","aut")),
diff --git a/R/R/model.R b/R/R/model.R
index 55ee41ff3..487ea9e65 100644
--- a/R/R/model.R
+++ b/R/R/model.R
@@ -55,7 +55,9 @@
 #' \code{objective_weights} must be defined, i.e. set c(2, 1) to give double weight
 #' to the 1st (NRMSE). This is an experimental feature. There's no research on
 #' optimal weight setting. Subjective weights might strongly bias modeling results.
-#' @param seed Integer. For reproducible results when running nevergrad.
+#' @param seed Integer. For reproducible results when running nevergrad and
+#' clustering. Each trial will increase the seed by 1 unit (i.e. 10 trials with
+#' seed 1 will share 9 results with 10 trials with seed 2).
 #' @param lambda_control Deprecated in v3.6.0.
 #' @param outputs Boolean. If set to TRUE, will run \code{robyn_run()} and
 #' \code{robyn_outputs()}, returning a list with OutputModels and
diff --git a/R/man/robyn_mmm.Rd b/R/man/robyn_mmm.Rd
index bab534330..8339546b0 100644
--- a/R/man/robyn_mmm.Rd
+++ b/R/man/robyn_mmm.Rd
@@ -87,7 +87,9 @@ another model with no 0-coef variables gets un-penalized with DECOMP.RSSD * 1.}
 
 \item{trial}{Integer. Which trial are we running? Used to ID each model.}
 
-\item{seed}{Integer. For reproducible results when running nevergrad.}
+\item{seed}{Integer. For reproducible results when running nevergrad and
+clustering. Each trial will increase the seed by 1 unit (i.e. 10 trials with
+seed 1 will share 9 results with 10 trials with seed 2).}
 
 \item{quiet}{Boolean. Keep messages off?}
 
diff --git a/R/man/robyn_run.Rd b/R/man/robyn_run.Rd
index 9bd0be9cf..238bc301c 100644
--- a/R/man/robyn_run.Rd
+++ b/R/man/robyn_run.Rd
@@ -58,7 +58,9 @@ more iterations to converge.}
 
 \item{refresh}{Boolean. Set to \code{TRUE} when used in \code{robyn_refresh()}.}
 
-\item{seed}{Integer. For reproducible results when running nevergrad.}
+\item{seed}{Integer. For reproducible results when running nevergrad and
+clustering. Each trial will increase the seed by 1 unit (i.e. 10 trials with
+seed 1 will share 9 results with 10 trials with seed 2).}
 
 \item{quiet}{Boolean. Keep messages off?}
 
diff --git a/R/man/robyn_train.Rd b/R/man/robyn_train.Rd
index f82d51207..b1a2d1689 100644
--- a/R/man/robyn_train.Rd
+++ b/R/man/robyn_train.Rd
@@ -85,7 +85,9 @@ another model with no 0-coef variables gets un-penalized with DECOMP.RSSD * 1.}
 
 \item{refresh}{Boolean. Set to \code{TRUE} when used in \code{robyn_refresh()}.}
 
-\item{seed}{Integer. For reproducible results when running nevergrad.}
+\item{seed}{Integer. For reproducible results when running nevergrad and
+clustering. Each trial will increase the seed by 1 unit (i.e. 10 trials with
+seed 1 will share 9 results with 10 trials with seed 2).}
 
 \item{quiet}{Boolean. Keep messages off?}
 }