Randomness Interface
This module provides an interface to the RandomnessManager.
- class vivarium.framework.randomness.interface.RandomnessInterface(manager)[source]
- Parameters:
manager (RandomnessManager)
- get_stream(decision_point, initializes_crn_attributes=False)[source]
Provides a new source of random numbers for the given decision point.
Vivarium provides a Common Random Number framework which allows for variance reduction when modeling counter-factual scenarios. Users interested in causal analysis and comparisons between simulation scenarios should be careful to use randomness streams provided by the framework wherever randomness is employed.
- Return type:
- Parameters:
decision_point (str) – A unique identifier for a stream of random numbers. Typically, this represents a decision that needs to be made each time step like ‘moves_left’ or ‘gets_disease’.
initializes_crn_attributes (bool) – A flag indicating whether this stream is used to generate key initialization information that will be used to identify simulants in the Common Random Number framework. These streams cannot be copied and should only be used to generate the state table columns specified in
builder.configuration.randomness.key_columns.
- Returns:
An entry point into the Common Random Number framework. The stream provides vectorized access to random numbers and a few other utilities.
- get_seed(decision_point)[source]
Gets a randomly generated seed for use with external randomness tools.
- Return type:
- Parameters:
decision_point (str) – A unique identifier for a stream of random numbers. Typically represents a decision that needs to be made each time step like ‘moves_left’ or ‘gets_disease’.
- Returns:
A seed for a random number generation that is linked to Vivarium’s Common Random Number framework.