Full documentation¶

sstudy.do_simulation_study(to_sample, func, db, Result, max_count=1, sample_filter=None)¶

Executes a simulation study, storing results on a SQL database engine.

Parameters

to_sampledict-like: Dictionary of set configurations to run simulation studies.
funcfunction: Function with receving **to_sample as arguments (must be named arguments), it must return the results of the simulation study in a dict-like object.
dbpeewee database object: peewee database instance where simulations are checked and stored.
Resultpeewee table object: peewee table instance where simulations are checked and stored.
max_countinteger: Number of simulation studies to execute for each configuration. This number can be changed on a configuration basis using sample_filter function.
sample_filterfunction: Optional function with receving **to_sample as arguments (must be named arguments), it must return the False, True or an integer. If False or 0 will dischard this simulation study configuration; if True, will execute max_count simulation studies with that configuration; if integer, will this integer simulation studies with that configuration.

Returns