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

Add kwargs for EKP to initialize #92

Merged
merged 1 commit into from
Jun 17, 2024
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
31 changes: 20 additions & 11 deletions src/backends.jl
Original file line number Diff line number Diff line change
Expand Up @@ -43,17 +43,24 @@
eki = ClimaCalibrate.calibrate(experiment_dir)
```
"""
calibrate(config::ExperimentConfig; kwargs...) =
calibrate(get_backend(), config; kwargs...)
calibrate(config::ExperimentConfig; ekp_kwargs...) =

Check warning on line 46 in src/backends.jl

View check run for this annotation

Codecov / codecov/patch

src/backends.jl#L46

Added line #L46 was not covered by tests
calibrate(get_backend(), config; ekp_kwargs...)

calibrate(experiment_dir::AbstractString) =
calibrate(get_backend(), ExperimentConfig(experiment_dir))
calibrate(experiment_dir::AbstractString; ekp_kwargs...) =

Check warning on line 49 in src/backends.jl

View check run for this annotation

Codecov / codecov/patch

src/backends.jl#L49

Added line #L49 was not covered by tests
calibrate(get_backend(), ExperimentConfig(experiment_dir); ekp_kwargs...)

calibrate(b::Type{JuliaBackend}, experiment_dir::AbstractString) =
calibrate(b, ExperimentConfig(experiment_dir))
calibrate(

Check warning on line 52 in src/backends.jl

View check run for this annotation

Codecov / codecov/patch

src/backends.jl#L52

Added line #L52 was not covered by tests
b::Type{JuliaBackend},
experiment_dir::AbstractString;
ekp_kwargs...,
) = calibrate(b, ExperimentConfig(experiment_dir); ekp_kwargs...)

function calibrate(::Type{JuliaBackend}, config::ExperimentConfig)
initialize(config)
function calibrate(
::Type{JuliaBackend},
config::ExperimentConfig;
ekp_kwargs...,
)
initialize(config; ekp_kwargs...)
(; n_iterations, ensemble_size) = config
eki = nothing
for i in 0:(n_iterations - 1)
Expand Down Expand Up @@ -103,9 +110,10 @@
function calibrate(
b::Type{CaltechHPC},
experiment_dir::AbstractString;
kwargs...,
slurm_kwargs,
ekp_kwargs...,
)
calibrate(b, ExperimentConfig(experiment_dir); kwargs...)
calibrate(b, ExperimentConfig(experiment_dir); slurm_kwargs, ekp_kwargs...)

Check warning on line 116 in src/backends.jl

View check run for this annotation

Codecov / codecov/patch

src/backends.jl#L116

Added line #L116 was not covered by tests
end

function calibrate(
Expand All @@ -117,11 +125,12 @@
),
verbose = false,
slurm_kwargs = Dict(:time_limit => 45, :ntasks => 1),
ekp_kwargs...,
)
# ExperimentConfig is created from a YAML file within the experiment_dir
(; n_iterations, output_dir, ensemble_size) = config
@info "Initializing calibration" n_iterations ensemble_size output_dir
initialize(config)
initialize(config; ekp_kwargs...)

Check warning on line 133 in src/backends.jl

View check run for this annotation

Codecov / codecov/patch

src/backends.jl#L133

Added line #L133 was not covered by tests

eki = nothing
for iter in 0:(n_iterations - 1)
Expand Down
2 changes: 2 additions & 0 deletions src/ekp_interface.jl
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,7 @@ function initialize(
prior,
output_dir;
rng_seed = 1234,
ekp_kwargs...,
)
Random.seed!(rng_seed)
rng_ekp = Random.MersenneTwister(rng_seed)
Expand All @@ -234,6 +235,7 @@ function initialize(
EKP.Inversion();
rng = rng_ekp,
failure_handler_method = EKP.SampleSuccGauss(),
ekp_kwargs...,
)

param_dict = get_param_dict(prior)
Expand Down
18 changes: 16 additions & 2 deletions test/ekp_interface.jl
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Distributions
import EnsembleKalmanProcesses as EKP
using EnsembleKalmanProcesses.ParameterDistributions
import ClimaCalibrate as CAL
import ClimaParams as CP
Expand All @@ -7,7 +8,7 @@ using Test

FT = Float64
output_dir = "test_init"
prior_path = joinpath("test_case_inputs", "prior.toml")
prior_path = joinpath(pkgdir(CAL), "test", "test_case_inputs", "prior.toml")
param_names = ["one", "two"]

prior = CAL.get_prior(prior_path)
Expand All @@ -25,7 +26,20 @@ config = CAL.ExperimentConfig(
output_dir,
)

CAL.initialize(config)
eki = CAL.initialize(config)
eki_with_kwargs = CAL.initialize(
config;
scheduler = EKP.MutableScheduler(2),
accelerator = EKP.NesterovAccelerator(),
)

@testset "Test passing kwargs to EKP struct" begin
@test eki_with_kwargs.scheduler != eki.scheduler
@test eki_with_kwargs.scheduler isa EKP.MutableScheduler

@test eki_with_kwargs.accelerator != eki.accelerator
@test eki_with_kwargs.accelerator isa EKP.NesterovAccelerator
end

override_file = joinpath(
config.output_dir,
Expand Down
Loading