Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix fitted_mean docstring #137

Merged
merged 2 commits into from
Apr 23, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "ScoreDrivenModels"
uuid = "4a87933e-d659-11e9-0e65-7f40dedd4a3a"
authors = ["guilhermebodin <[email protected]>, raphaelsaavedra <[email protected]>"]
version = "0.1.9"
version = "0.1.10"

[deps]
Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
Expand Down
8 changes: 5 additions & 3 deletions src/univariate_score_driven_recursion.jl
Original file line number Diff line number Diff line change
Expand Up @@ -127,9 +127,11 @@ function update_param_tilde!(param_tilde::Matrix{T}, ω::Vector{T}, A::Dict{Int,
end

"""
fitted_mean(gas::Model{D, T}, observations::Vector{T}, initial_params::Vector{T}) where {D, T}
fitted_mean(gas::Model{D, T}, observations::Vector{T};
initial_params::Matrix{T}=stationary_initial_params(gas)) where {D, T}

return the fitted mean.. #TODO
Returns the fitted mean of the in-sample series, i.e., the mean of the predictive
distribution at each time step using the fitted parameters in `gas`.
"""
function fitted_mean(gas::Model{D, T}, observations::Vector{T};
initial_params::Matrix{T} = stationary_initial_params(gas)) where {D, T}
Expand All @@ -147,4 +149,4 @@ function fitted_mean(gas::Model{D, T}, observations::Vector{T};
end

return fitted_mean
end
end