Commit 75793d3d authored by Thibault Hallouin's avatar Thibault Hallouin
Browse files

add missing parameters to docstrings

1 merge request!3release v0.1.0
Pipeline #43616 passed with stage
in 2 minutes and 36 seconds
Showing with 12 additions and 1 deletion
+12 -1
...@@ -31,6 +31,8 @@ namespace evalhyd ...@@ -31,6 +31,8 @@ namespace evalhyd
/// \param q_thr /// \param q_thr
/// Streamflow exceedance threshold(s). /// Streamflow exceedance threshold(s).
/// shape: (sites, thresholds) /// shape: (sites, thresholds)
/// \param is_high_flow_event
/// Whether events correspond to being above the threshold(s).
/// \return /// \return
/// Event observed outcome. /// Event observed outcome.
/// shape: (sites, thresholds, time) /// shape: (sites, thresholds, time)
...@@ -130,6 +132,8 @@ namespace evalhyd ...@@ -130,6 +132,8 @@ namespace evalhyd
/// \param q_thr /// \param q_thr
/// Streamflow exceedance threshold(s). /// Streamflow exceedance threshold(s).
/// shape: (sites, thresholds) /// shape: (sites, thresholds)
/// \param is_high_flow_event
/// Whether events correspond to being above the threshold(s).
/// \return /// \return
/// Number of forecast members exceeding threshold(s). /// Number of forecast members exceeding threshold(s).
/// shape: (sites, lead times, thresholds, time) /// shape: (sites, lead times, thresholds, time)
...@@ -406,7 +410,7 @@ namespace evalhyd ...@@ -406,7 +410,7 @@ namespace evalhyd
xt::all(), e, xt::all()); xt::all(), e, xt::all());
// calculate length of subset // calculate length of subset
auto l = xt::sum(t_msk_sampled, -1); // (sit, ldt, 1) auto l = xt::sum(t_msk_sampled, -1);
// compute mask to subsample time steps belonging to same forecast bin // compute mask to subsample time steps belonging to same forecast bin
// (where bins are defined as the range of forecast values) // (where bins are defined as the range of forecast values)
......
...@@ -503,6 +503,9 @@ namespace evalhyd ...@@ -503,6 +503,9 @@ namespace evalhyd
/// \param POFD /// \param POFD
/// Probabilities of false detection. /// Probabilities of false detection.
/// shape: (sites, lead times, subsets, samples, levels, thresholds) /// shape: (sites, lead times, subsets, samples, levels, thresholds)
/// \param q_thr
/// Streamflow exceedance threshold(s).
/// shape: (sites, thresholds)
/// \return /// \return
/// ROC skill scores. /// ROC skill scores.
/// shape: (sites, lead times, subsets, samples, thresholds) /// shape: (sites, lead times, subsets, samples, thresholds)
......
...@@ -50,6 +50,8 @@ namespace evalhyd ...@@ -50,6 +50,8 @@ namespace evalhyd
/// \param q_qnt /// \param q_qnt
/// Streamflow quantiles. /// Streamflow quantiles.
/// shape: (sites, lead times, quantiles, time) /// shape: (sites, lead times, quantiles, time)
/// \param n_mbr
/// Number of ensemble members.
/// \return /// \return
/// Quantile scores for each time step. /// Quantile scores for each time step.
/// shape: (sites, lead times, quantiles, time) /// shape: (sites, lead times, quantiles, time)
...@@ -93,6 +95,8 @@ namespace evalhyd ...@@ -93,6 +95,8 @@ namespace evalhyd
/// \param qs /// \param qs
/// Quantile scores for each time step. /// Quantile scores for each time step.
/// shape: (sites, lead times, quantiles, time) /// shape: (sites, lead times, quantiles, time)
/// \param n_mbr
/// Number of ensemble members.
/// \return /// \return
/// CRPS for each time step. /// CRPS for each time step.
/// shape: (sites, lead times, time) /// shape: (sites, lead times, time)
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment