robyn_train  R Documentation 
robyn_train()
consumes output from robyn_input()
and runs the robyn_mmm()
on each trial.
robyn_train(
InputCollect,
hyper_collect,
cores,
iterations,
trials,
intercept_sign,
intercept,
nevergrad_algo,
dt_hyper_fixed = NULL,
ts_validation = TRUE,
add_penalty_factor = FALSE,
objective_weights = NULL,
rssd_zero_penalty = TRUE,
refresh = FALSE,
seed = 123,
quiet = FALSE
)
InputCollect 
List. Contains all input parameters for the model.
Required when 
hyper_collect 
List. Containing hyperparameter bounds. Defaults to

cores 
Integer. Default to 
iterations 
Integer. Recommended 2000 for default when using

trials 
Integer. Recommended 5 for default

intercept_sign 
Character. Choose one of "non_negative" (default) or
"unconstrained". By default, if intercept is negative, Robyn will drop intercept
and refit the model. Consider changing intercept_sign to "unconstrained" when
there are 
intercept 
Boolean. Should intercept(s) be fitted (default=TRUE) or set to zero (FALSE). 
nevergrad_algo 
Character. Default to "TwoPointsDE". Options are

dt_hyper_fixed 
data.frame or named list. Only provide when loading
old model results. It consumes hyperparameters from saved csv

ts_validation 
Boolean. When set to 
add_penalty_factor 
Boolean. Add penalty factor hyperparameters to glmnet's penalty.factor to be optimized by nevergrad. Use with caution, because this feature might add too much hyperparameter space and probably requires more iterations to converge. 
objective_weights 
Numeric vector. Default to NULL to give equal weights
to all objective functions. Order: NRMSE, DECOMP.RSSD, MAPE (when calibration
data is provided). When you are not calibrating, only the first 2 values for

rssd_zero_penalty 
Boolean. When TRUE, the objective function DECOMP.RSSD will penalize models with more 0 media effects additionally. In other words, given the same DECOMP.RSSD score, a model with 50% 0coef variables will get penalized by DECOMP.RSSD * 1.5 (larger error), while another model with no 0coef variables gets unpenalized with DECOMP.RSSD * 1. 
refresh 
Boolean. Set to 
seed 
Integer. For reproducible results when running nevergrad. 
quiet 
Boolean. Keep messages off? 
List. Iteration results to include in robyn_run()
results.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.