`sid.validation`¶

This module contains routines to validate inputs to functions.

Module Contents¶

Functions¶

`validate_params`(params: pandas.DataFrame) → None	Validate the parameter DataFrame.
`validate_initial_states`(initial_states)
`validate_prepared_initial_states`(states, duration)
`validate_contact_models`(contact_models)	Validate contact models and policies.
`validate_contact_policies`(contact_policies, contact_models)
`validate_testing_models`(testing_demand_models, testing_allocation_models, testing_processing_models)	Validate models for testing.
`validate_vaccination_models`(vaccination_models)	Validate vaccination models.
`validate_return_is_series_or_ndarray`(x, model_name, model_group, index)
`_validate_model_function`(model_name: str, model_group: str, model: Callable, args: List[str]) → None

Attributes¶

`COMMON_ARGS`
`NECESSARY_CONTACT_MODEL_KEYS`
`NECESSARY_CONTACT_POLICY_KEYS`

COMMON_ARGS = ['states', 'params', 'seed'][source]¶

NECESSARY_CONTACT_MODEL_KEYS = ['is_recurrent', 'model', 'assort_by'][source]¶

NECESSARY_CONTACT_POLICY_KEYS = ['policy'][source]¶

validate_params(params: pandas.DataFrame) → None[source]¶: Validate the parameter DataFrame.

validate_initial_states(initial_states)[source]¶

validate_prepared_initial_states(states, duration)[source]¶

validate_contact_models(contact_models)[source]¶: Validate contact models and policies.

validate_contact_policies(contact_policies, contact_models)[source]¶

validate_testing_models(testing_demand_models, testing_allocation_models, testing_processing_models)[source]¶: Validate models for testing.

validate_vaccination_models(vaccination_models)[source]¶: Validate vaccination models.

validate_return_is_series_or_ndarray(x, model_name, model_group, index)[source]¶

_validate_model_function(model_name: str, model_group: str, model: Callable, args: List[str]) → None[source]¶