Forecast-skill API

Forecast-skill sensitivity for weather/outage-aware annual recourse.

A coarse skill model draws a perfect annual forecast with probability forecast_skill and an independent synthetic forecast otherwise. The result is a diagnostic, not a meteorological forecast product.

class brushline.strategic.forecast_skill.ForecastSkillCase(*, forecast_skill: Annotated[float, Ge(ge=0), Le(le=1)], summary: WeatherCaseSummary)[source]

Bases: BaseModel

One forecast-skill point.

model_config = {'extra': 'forbid', 'frozen': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class brushline.strategic.forecast_skill.ForecastSkillResult(*, schema_version: Literal['brushline.forecast-skill.v1'] = 'brushline.forecast-skill.v1', instance_id: str, episodes: Annotated[int, Ge(ge=1)], seed: int, years: list[int], solver: Literal['exact', 'heuristic'], lookahead_years: Annotated[int, Ge(ge=1)], calendar: WeatherCalendarConfig, cases: list[ForecastSkillCase], created_utc: datetime)[source]

Bases: BaseModel

Forecast-skill sensitivity for the calendar-aware policy.

model_config = {'extra': 'forbid', 'frozen': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

brushline.strategic.forecast_skill.evaluate_forecast_skill(*, instance_id: str, plan: StatefulPlan, segments: list[StatefulSegment], methods: list[StatefulMethod], periods: list[StatefulPeriod], crews: list[ShiftCrew], machines: list[ShiftMachine], skills: list[float], config: StatefulConfig | None = None, episodes: int = 20, seed: int = 7, solver: Literal['exact', 'heuristic'] = 'exact', heuristic_iterations: int = 100, lookahead_years: int = 2, calendar: WeatherCalendarConfig | None = None, created_utc: datetime | None = None) → ForecastSkillResult[source]

Evaluate forecast-aware execution across a forecast-skill sweep.