bayesline.api.equity.TimeSeriesVolatilityMeasureSettings

pydantic model bayesline.api.equity.TimeSeriesVolatilityMeasureSettings

Settings for time series volatility measure.

This class defines settings for a time series volatility measure, which provides time series volatility data using rolling windows.

Show JSON schema

{
   "title": "TimeSeriesVolatilityMeasureSettings",
   "description": "Settings for time series volatility measure.\n\nThis class defines settings for a time series volatility measure,\nwhich provides time series volatility data using rolling windows.",
   "type": "object",
   "properties": {
      "type": {
         "const": "TimeSeriesVolatility",
         "default": "TimeSeriesVolatility",
         "title": "Type",
         "type": "string"
      },
      "window": {
         "default": "6mo",
         "description": "The size of the rolling window",
         "title": "Window",
         "type": "string"
      },
      "ddof": {
         "default": 1,
         "description": "The degrees of freedom to use for the volality",
         "title": "Ddof",
         "type": "integer"
      }
   },
   "additionalProperties": false
}

Config:

• frozen: bool = True

• extra: str = forbid

Fields:

• ddof (int)

• type (Literal['TimeSeriesVolatility'])

• window (str)

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

field window: str = '6mo'

The size of the rolling window

field ddof: int = 1

The degrees of freedom to use for the volality