Skip to content

Commit 13271fd

Browse files
committed
default generators with informative errors + formatting
1 parent 327c3c1 commit 13271fd

2 files changed

Lines changed: 13 additions & 5 deletions

File tree

src/Utils/data_sample.jl

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,9 +80,7 @@ function DataSample(; x=nothing, θ=nothing, y=nothing, extra=NamedTuple(), kwar
8080
end
8181
shadowed_extra = intersect(keys(extra), reserved)
8282
if !isempty(shadowed_extra)
83-
error(
84-
"Keys $(collect(shadowed_extra)) in extra shadow DataSample struct fields",
85-
)
83+
error("Keys $(collect(shadowed_extra)) in extra shadow DataSample struct fields")
8684
end
8785
return DataSample(x, θ, y, maximizer_kwargs, extra)
8886
end

src/Utils/interface.jl

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,12 @@ end
9797
9898
Returns a callable `f(θ; kwargs...) -> y`, solving a maximization problem.
9999
"""
100-
function generate_maximizer end
100+
function generate_maximizer(bench::AbstractBenchmark; kwargs...)
101+
return error(
102+
"`generate_maximizer` is not implemented for $(typeof(bench)). " *
103+
"Implement `generate_maximizer(::$(typeof(bench)); kwargs...) -> f(θ; kwargs...) -> y`.",
104+
)
105+
end
101106

102107
"""
103108
generate_statistical_model(::AbstractBenchmark, seed=nothing; kwargs...)
@@ -106,7 +111,12 @@ Returns an untrained statistical model (usually a Flux neural network) that maps
106111
feature matrix `x` to an output array `θ`. The `seed` parameter controls initialization
107112
randomness for reproducibility.
108113
"""
109-
function generate_statistical_model end
114+
function generate_statistical_model(bench::AbstractBenchmark, seed=nothing; kwargs...)
115+
return error(
116+
"`generate_statistical_model` is not implemented for $(typeof(bench)). " *
117+
"Implement `generate_statistical_model(::$(typeof(bench)), seed=nothing; kwargs...) -> model`.",
118+
)
119+
end
110120

111121
"""
112122
generate_baseline_policies(::AbstractBenchmark) -> NamedTuple or Tuple

0 commit comments

Comments
 (0)