Source code for cann.data.market_surface

from __future__ import annotations

from dataclasses import dataclass
from typing import Dict, Any

import numpy as np




[docs]
@dataclass
class MarketSurface:
    """
    Container for market surface data used in model calibration.

    Fields:
        ``market_inputs`` (shape ``(N, m)``), ``observed`` (shape ``(N,)`` or ``(N, 1)``),
        optional ``weights`` (shape ``(N,)``), and optional ``metadata``.
    """

    market_inputs: np.ndarray  # Shape: (num_samples, num_features)
    observed: np.ndarray  # Shape: (num_samples, ) or (num_samples, 1)
    weights: np.ndarray | None = None
    metadata: Dict[str, Any] | None = None