Skip to content

Commit

Permalink
Start documenting generate_latent_infs
Browse files Browse the repository at this point in the history
  • Loading branch information
SamuelBrand1 committed Mar 11, 2024
1 parent 40f0ef1 commit fe20c7c
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion EpiAware/src/abstract-types.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,20 @@ abstract type AbstractLatentModel <: AbstractModel end

abstract type AbstractObservationModel <: AbstractModel end

function generate_latent_infs(epi_model::AbstractEpiModel, latent_model)
@doc raw"""
Generate latent infections based on the given epidemiological model and a latent process
path ``Z_t``.
# Arguments
- `epi_model::DirectInfections`: The epidemiological model used to generate latent infections.
- `Z_t`: The noise term.
# Returns
- An array of generated latent infections.
# Example
"""
function generate_latent_infs(epi_model::AbstractEpiModel, Z_t)
@info "No concrete implementation for `generate_latent_infs` is defined."
return nothing
end
Expand Down

0 comments on commit fe20c7c

Please sign in to comment.