Skip to content

Model discovery and registration

hssm.list_models

hssm.list_models 

list_models() -> tuple[SupportedModels, ...]

Return the names of the built-in HSSM models.

Returns:

  • tuple[SupportedModels, ...] –

    A tuple containing all built-in HSSM model names.

hssm.register_model

hssm.register_model 

register_model(
    name: SupportedModels,
    response: list[str],
    list_params: list[str],
    choices: list[int],
    likelihoods: LoglikConfigs,
    description: str | None,
) -> None

Register a new model in HSSM.

Parameters:

  • name (str) –

    Name of the model to register

  • response (list[str]) –

    List of response variables

  • list_params (list[str]) –

    List of parameters

  • choices (list[int]) –

    List of possible choices

  • description (str) –

    Description of the model

  • likelihoods (LoglikConfigs) –

    Dictionary of likelihood configurations

Returns:

  • None –

Raises: