Skip to content

Commit 01596f2

Browse files
committed
cleanup
1 parent 4282039 commit 01596f2

2 files changed

Lines changed: 6 additions & 4 deletions

File tree

src/Utils/data_sample.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ $TYPEDEF
44
Data sample data structure.
55
Its main purpose is to store datasets generated by the benchmarks.
66
It has 3 main (optional) fields: features `x`, cost parameters `θ`, and solution `y`.
7-
Additionally, it has an `maximizer_kwargs` field (solver kwargs, spread into the maximizer as
7+
Additionally, it has a `maximizer_kwargs` field (solver kwargs, spread into the maximizer as
88
`maximizer(θ; sample.maximizer_kwargs...)`) and an `extra` field (non-solver data, never passed
99
to the maximizer).
1010

src/Utils/interface.jl

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -217,9 +217,11 @@ part). Decisions are taken by seeing only the instance. Scenarios are used to ge
217217
anticipative targets and compute objective values.
218218
219219
# Required methods ([`ExogenousStochasticBenchmark`](@ref) only)
220-
- [`generate_instance`](@ref)`(bench, rng)`: returns a [`DataSample`](@ref) with instance
221-
and features but **no scenario**. Scenarios are added later by [`generate_dataset`](@ref)
222-
via [`generate_scenario`](@ref).
220+
- [`generate_instance`](@ref)`(bench, rng)`: returns a [`DataSample`](@ref) with the
221+
problem instance (solver kwargs) and, if not overriding [`generate_context`](@ref),
222+
the ML features `x`. Scenarios are added later by [`generate_dataset`](@ref) via
223+
[`generate_scenario`](@ref). When [`generate_context`](@ref) is overridden, `x` may
224+
be absent here and constructed there instead.
223225
- [`generate_scenario`](@ref)`(bench, rng; kwargs...)`: draws a random scenario.
224226
Solver kwargs are spread from `sample.maximizer_kwargs`; context latents from `ctx.extra`.
225227

0 commit comments

Comments
 (0)