Skip to content

Commit

Permalink
infections docs edit; latent folder first pass
Browse files Browse the repository at this point in the history
  • Loading branch information
AFg6K7h4fhy2 committed Apr 12, 2024
1 parent 6f077b0 commit 725048b
Showing 1 changed file with 23 additions and 2 deletions.
25 changes: 23 additions & 2 deletions model/src/pyrenew/latent/infections.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,29 @@
["infections"],
defaults=[None],
)
InfectionsSample.__doc__ = """
A container for holding the output from the InfectionsSample.
Attributes
----------
infections : ArrayLike or None
The estimated latent infections. Defaults to None.
"""


class Infections(RandomVariable):
"""Latent infections"""
"""Latent infections
Methods
-------
sample(Rt, I0, gen_int, **kwargs)
"""

def __init__(
self,
infections_mean_varname: str = "latent_infections",
) -> None:
"""Default constructor
"""Default constructor for Infections class.
Parameters
----------
Expand All @@ -40,6 +53,11 @@ def __init__(

@staticmethod
def validate() -> None:
"""
Notes
-----
TODO: Complete this method.
"""
return None

def sample(
Expand All @@ -61,6 +79,9 @@ def sample(
Initial infections.
gen_int : ArrayLike
Generation interval.
**kwargs : dict, optional
Additional keyword arguments passed through to internal
sample calls, should there be any.
Returns
-------
Expand Down

0 comments on commit 725048b

Please sign in to comment.