Skip to content

Commit 79f136d

Browse files
committed
qualify module even more?
1 parent a4c9eb9 commit 79f136d

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

docs/src/calibrate.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ One draw of our approach is that it does not require the forward map to be writt
2323

2424
Two helper functions from `CalibrateEmulateSample.Utilities` simplify passing the calibration results to the emulator.
2525

26-
[`get_training_points(ekp, n; g_final = nothing)`](@ref Utilities.get_training_points) collects the stored parameter ensembles and forward-model outputs into a [`PairedDataContainer`](https://github.com/CliMA/EnsembleKalmanProcesses.jl/blob/main/src/DataContainers.jl) ready for emulator training. The argument `n` can be an integer (which uses iterations `1:n`) or an index vector. An optional keyword `g_final` accepts the forward-model outputs at the final, not-yet-stored parameter ensemble.
26+
[`get_training_points(ekp, n; g_final = nothing)`](@ref CalibrateEmulateSample.Utilities.get_training_points) collects the stored parameter ensembles and forward-model outputs into a [`PairedDataContainer`](https://github.com/CliMA/EnsembleKalmanProcesses.jl/blob/main/src/DataContainers.jl) ready for emulator training. The argument `n` can be an integer (which uses iterations `1:n`) or an index vector. An optional keyword `g_final` accepts the forward-model outputs at the final, not-yet-stored parameter ensemble.
2727

2828
```julia
2929
using CalibrateEmulateSample.Utilities
@@ -32,7 +32,7 @@ input_output_pairs = get_training_points(ekp, 1:2:9) # odd iterations 1
3232
input_output_pairs = get_training_points(ekp, 5; g_final = G(get_ϕ_final(prior, ekp)))
3333
```
3434

35-
[`encoder_kwargs_from(ekp, prior)`](@ref Utilities.encoder_kwargs_from) collects additional information from the calibration — the prior covariance, the observational noise covariance, and the sequence of parameter and output sample distributions across EKP iterations — into a named tuple that can be passed directly as the `encoder_kwargs` argument of the `Emulator`. This enables data-adaptive preprocessing such as likelihood-informed subspace reduction.
35+
[`encoder_kwargs_from(ekp, prior)`](@ref CalibrateEmulateSample.Utilities.encoder_kwargs_from) collects additional information from the calibration — the prior covariance, the observational noise covariance, and the sequence of parameter and output sample distributions across EKP iterations — into a named tuple that can be passed directly as the `encoder_kwargs` argument of the `Emulator`. This enables data-adaptive preprocessing such as likelihood-informed subspace reduction.
3636

3737
```julia
3838
encoder_kwargs = encoder_kwargs_from(ekp, prior)

0 commit comments

Comments
 (0)