docs: update seeds param to explain how each trial increases seed by …

…a unit #1005 (#1078)
facebookexperimental · Oct 21, 2024 · c8bb458 · c8bb458
1 parent 6324d6d
commit c8bb458
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 5 deletions.
diff --git 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", , "[email protected]", c("aut")),
     person("Bernardo", "Lares", , "[email protected]", c("cre","aut")),

diff --git 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
diff --git a/R/man/robyn_run.Rd b/R/man/robyn_run.Rd
diff --git a/R/man/robyn_train.Rd b/R/man/robyn_train.Rd