CDCgov / multisignal-epi-inference

Python package for statistical inference and forecast of epi models using multiple signals
https://cdcgov.github.io/multisignal-epi-inference/
10 stars 1 forks source link

Pretty print for the model class #97

Open gvegayon opened 2 months ago

gvegayon commented 2 months ago

Goal

We need to have a nice printout of the model class. Users should be able to quickly inspect what the model is without having to list all members of the model class.

Context

During the development of the tutorials, it became apparent the need for this feature.

Required features

pyrenew.[Model instance]
Number of parameters: [a number goes here]
State of the MCMC: [run/not run]
Model components:
- [Latent process 1]
- [Latent process 2]
- [...]
First (k) parameters: param1, param2, ..., (omitting [N - k]).

Model components can be sort of an instance-dependent print implemented in a hidden function, e.g., _print_details().

Specifications