Skip to main content

Config

Struct Config 

Source
pub struct Config {
    pub schema: Option<String>,
    pub modeling: ModelingConfig,
    pub training: TrainingConfig,
    pub upper_bound_evaluation: UpperBoundEvaluationConfig,
    pub policy: PolicyConfig,
    pub simulation: SimulationConfig,
    pub exports: ExportsConfig,
    pub estimation: EstimationConfig,
}
Expand description

Top-level deserialized representation of config.json.

All sections except training are optional; their defaults are applied by serde when the section is absent from the JSON.

Fields§

§schema: Option<String>

JSON schema URI — informational, not validated.

§modeling: ModelingConfig

Modeling options (inflow non-negativity treatment).

§training: TrainingConfig

Training parameters — contains mandatory fields.

§upper_bound_evaluation: UpperBoundEvaluationConfig

Upper-bound evaluation via inner approximation.

§policy: PolicyConfig

Policy directory settings (warm-start / resume).

§simulation: SimulationConfig

Post-training simulation settings.

§exports: ExportsConfig

Export flags controlling which outputs are written to disk.

§estimation: EstimationConfig

Time series estimation settings for automatic model parameter fitting.

Implementations§

Source§

impl Config

Source

pub fn training_scenario_source( &self, path: &Path, ) -> Result<ScenarioSource, LoadError>

Resolve the training-phase ScenarioSource.

When training.scenario_source is absent, returns ScenarioSource::default() (all classes InSample, no seed, no historical years).

§Errors

Returns LoadError::SchemaError if the raw config contains an invalid scheme string, Historical on a non-inflow class, or seed/year validation failures.

§Examples
use cobre_io::config::parse_config;
use std::path::Path;

let cfg = parse_config(Path::new("case/config.json")).unwrap();
let source = cfg.training_scenario_source(Path::new("case/config.json")).unwrap();
Source

pub fn simulation_scenario_source( &self, path: &Path, ) -> Result<ScenarioSource, LoadError>

Resolve the simulation-phase ScenarioSource.

Falls back to training_scenario_source() when simulation.scenario_source is absent.

§Errors

Returns LoadError::SchemaError on validation failures in either the simulation or training scenario source.

§Examples
use cobre_io::config::parse_config;
use std::path::Path;

let cfg = parse_config(Path::new("case/config.json")).unwrap();
let source = cfg.simulation_scenario_source(Path::new("case/config.json")).unwrap();
Source

pub fn training_openings(&self) -> Option<&Openings>

The training-phase openings source declaration, or None when absent (equivalent to generated). Single owner of the training openings lookup that downstream opening-tree selection reads.

Source

pub fn resolve_forward_passes(&self) -> Option<ForwardPassesResolution>

Resolve the effective training forward-pass method from training.selection.

Returns None when selection is absent, leaving the mandatory-count rejection to [validate_config]. An enumerated selection resolves to ForwardPassesResolution::Enumerated — config load holds no policy graph, so the count itself is derived downstream.

Source

pub fn resolve_num_scenarios(&self) -> NumScenariosResolution

Resolve the effective simulation scenario-count method from simulation.selection, defaulting to [DEFAULT_NUM_SCENARIOS] when absent.

An enumerated selection resolves to NumScenariosResolution::Enumerated — config load holds no policy graph, so the derived count happens downstream.

Source

pub fn with_overrides( base: &Value, overrides: &Map<String, Value>, ) -> Result<Config, LoadError>

Deep-merge a flat map of dotted-key overrides into base and re-deserialize the result into a validated Config.

base is the parsed-but-not-typed config.json (a serde_json::Value::Object). overrides is a flat map whose keys are dotted paths into the config schema (e.g. "training.tree_seed", "policy.checkpointing.compress"). Intermediate objects are reused rather than replaced, so setting policy.checkpointing.compress does not clobber sibling keys under policy or policy.checkpointing.

After merging, the value is re-deserialized into Config. Because Config is #[serde(deny_unknown_fields)], an override key that does not exist in the schema (a typo such as trainning.tree_seed) fails loudly. The same post-deserialization checks as parse_config then run via validate_config.

All errors carry the synthetic path "<config_overrides>" so callers can recognize override-originated failures.

§Errors

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Config

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Config

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Config

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more