From 8726f2d89e31a6f087c35ae854e6937e12a76b5e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mos=C3=A8=20Giordano?= Date: Fri, 15 Nov 2024 15:56:08 +0000 Subject: [PATCH] [docs] Add missing docstrings --- docs/src/index.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/src/index.md b/docs/src/index.md index e19df61..6b5c9f1 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -118,6 +118,21 @@ ParticleDA.get_covariance_state_observation_given_previous_state ParticleDA.get_covariance_observation_observation_given_previous_state ``` +### Other function you may want to extend + +```@docs +ParticleDA.get_state_indices_correlated_to_observations +ParticleDA.get_initial_state_mean! +ParticleDA.write_snapshot +ParticleDA.write_state +ParticleDA.get_covariance_initial_state +ParticleDA.init_filter +ParticleDA.sample_proposal_and_compute_log_weights! +ParticleDA.write_observation +ParticleDA.write_weights +ParticleDA.get_initial_state_mean +``` + ### Input parameters You can store the input parameters in an YAML file with the following structure