tracts.driver_utils.ModelsConfig

class ModelsConfig(**data)

Bases: BaseModel

Configuration for the demographic and admixture models used in the inference.

model_filename

The filename of the demographic model to use for the inference.

Type:

str

implicit_population

The name of the population to use as the implicit population in the discrete founder event (if any), whose proportion is set to one minus the sum of the proportions contributed by the other source populations. The corresponding rate and sex-bias parameters will not be optimized and their optimal values will be derived from the optimal values of the rest of parameters. If None, defaults to the first source population specified in the founder event.

Type:

str | None

ad_model_autosomes

The admixture model to use for the autosomes. Must be one in [“M”, “DC”, “DF”, “H-DC”, “H-DF]. See online documentation for details. Defaults to “DC”.

Type:

str

ad_model_allosomes

The admixture model to use for the allosomes. Must be one in [“DC”, “DF”, “H-DC”, “H-DF]. See online documentation for details. Defaults to “DC”.

Type:

str

rho_f

The female-specific recombination rate. Defaults to 1.

Type:

float

rho_m

The male-specific recombination rate. Defaults to 1.

Type:

float

TP

The number of pedigree generations under the hybrid-pedigree refinements of the Dioecious models. Ignored if not applicable. Defaults to 2.

Type:

int

TP: int

implicit_population: str | None

model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

rho_f: float

rho_m: float