meridian.schema.processors.model_processor.OptimizationSpec

A dated spec for optimization.

Inherits From: DatedSpec

meridian.schema.processors.model_processor.OptimizationSpec(
    start_date: (datetime.date | None) = None,
    end_date: (datetime.date | None) = None,
    date_interval_tag: str = '',
    *,
    optimization_name: str,
    grid_name: str,
    group_id: (str | None) = None,
    confidence_level: float = c.DEFAULT_CONFIDENCE_LEVEL
)

optimization_name The name of the optimization in this spec.
grid_name The name of the optimization grid.
group_id An optional group ID for linking related optimizations.
confidence_level The threshold for computing confidence intervals. Defaults to 0.9. Must be a number between 0 and 1.
start_date Dataclass field
end_date Dataclass field
date_interval_tag Dataclass field

Methods

resolver

View source

resolver(
    time_coordinates: meridian.data.time_coordinates.TimeCoordinates
) -> 'DatedSpecResolver'

Returns a date resolver for this spec, with the given Meridian model.

validate

View source

validate()

Check optimization parameters are valid.

__eq__

__eq__(
    other
)

Return self==value.

confidence_level 0.9
date_interval_tag ''
end_date None
group_id None
start_date None