chap_core.simulation package¶
Submodules¶
chap_core.simulation.naive_simulator module¶
This is simulation code that can useful for creating tests. Currently in use.
todo: Can maybe be moved to tests/
- class chap_core.simulation.naive_simulator.AdditiveSimulator(params: SimulationParams = SimulationParams(loc=5, scale=2))[source]¶
Bases:
Simulator- generate_raw(data_dims: DatasetDimensions) ndarray[source]¶
- simulate(data_dims: DatasetDimensions) DataSet[source]¶
- simulate_observations(data_dims: DatasetDimensions, feature_name) list[Observation][source]¶
- class chap_core.simulation.naive_simulator.BacktestSimulator(params: ForecastParams = ForecastParams(prediction_length=3, n_samples=100, n_splits=2))[source]¶
Bases:
object- simulate(dataset: DataSet, dataset_dims: DatasetDimensions) BackTest[source]¶
- class chap_core.simulation.naive_simulator.DatasetDimensions(*, locations: list[str], time_periods: list[str], target: str = 'disease_cases', features: list[str] = [])[source]¶
Bases:
BaseModel- features: list[str]¶
- locations: list[str]¶
- model_config: ClassVar[ConfigDict] = {}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- target: str¶
- time_periods: list[str]¶
- class chap_core.simulation.naive_simulator.ForecastParams(*, prediction_length: int = 3, n_samples: int = 100, n_splits: int = 2)[source]¶
Bases:
BaseModel- model_config: ClassVar[ConfigDict] = {}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- n_samples: int¶
- n_splits: int¶
- prediction_length: int¶
- class chap_core.simulation.naive_simulator.SimulationParams(*, loc: float = 5, scale: float = 2)[source]¶
Bases:
BaseModel- loc: float¶
- model_config: ClassVar[ConfigDict] = {}¶
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- scale: float¶
- class chap_core.simulation.naive_simulator.Simulator(params: SimulationParams)[source]¶
Bases:
ABC- simulate(data_dims: DatasetDimensions) DataSet[source]¶