bayesline.api.equity.MovingAverageMeasureSettings

pydantic model bayesline.api.equity.MovingAverageMeasureSettings

Settings for moving average measure.

This class defines settings for a moving average measure, which provides moving average calculations for time series data.

Show JSON schema

{
   "title": "MovingAverageMeasureSettings",
   "description": "Settings for moving average measure.\n\nThis class defines settings for a moving average measure,\nwhich provides moving average calculations for time series data.",
   "type": "object",
   "properties": {
      "type": {
         "const": "MovingAverage",
         "default": "MovingAverage",
         "title": "Type",
         "type": "string"
      },
      "window": {
         "default": "6mo",
         "description": "The size of the rolling window",
         "title": "Window",
         "type": "string"
      },
      "var": {
         "default": "r2",
         "description": "The variable to average",
         "enum": [
            "r2",
            "sigma2",
            "sigma",
            "aic",
            "bic"
         ],
         "title": "Var",
         "type": "string"
      }
   },
   "additionalProperties": false
}

Config:

• frozen: bool = True

• extra: str = forbid

Fields:

• type (Literal['MovingAverage'])

• var (Literal['r2', 'sigma2', 'sigma', 'aic', 'bic'])

• window (str)

field type: Literal['MovingAverage'] = 'MovingAverage'

field window: str = '6mo'

The size of the rolling window

field var: Literal['r2', 'sigma2', 'sigma', 'aic', 'bic'] = 'r2'

The variable to average

property columns: list[str]

Get the column names for this measure.

Returns

list[str]

The column names for this measure.