bayesline.api.equity.ForecastBacktestMeasureSettings#

pydantic model bayesline.api.equity.ForecastBacktestMeasureSettings#

Settings for forecast backtest measure.

This class defines settings for a forecast backtest measure, which provides forecast backtest calculations and metrics.

Show JSON schema
{
   "title": "ForecastBacktestMeasureSettings",
   "description": "Settings for forecast backtest measure.\n\nThis class defines settings for a forecast backtest measure,\nwhich provides forecast backtest calculations and metrics.",
   "type": "object",
   "properties": {
      "type": {
         "const": "ForecastBacktest",
         "default": "ForecastBacktest",
         "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 stability",
         "title": "Ddof",
         "type": "integer"
      }
   },
   "additionalProperties": false
}

Config:
  • frozen: bool = True

  • extra: str = forbid

Fields:
  • ddof (int)

  • type (Literal['ForecastBacktest'])

  • window (str)

field type: Literal['ForecastBacktest'] = 'ForecastBacktest'#
field window: str = '6mo'#

The size of the rolling window

field ddof: int = 1#

The degrees of freedom to use for the stability

property columns: list[str]#

Get the column names for this measure.

Returns#

list[str]

The column names for this measure.