Skip to content

hssm.show_defaults

hssm.show_defaults

show_defaults(model: SupportedModels, loglik_kind=Optional[LoglikKind]) -> str

Show the defaults for supported models.

Parameters:

  • model (SupportedModels) –

    One of the supported model strings.

  • loglik_kind (optional, default: Optional[LoglikKind] ) –

    The kind of likelihood function, by default None, in which case the defaults for all likelihoods will be shown.

Returns:

  • str

    A nicely organized printout for the defaults of provided model.