bayesline.api.equity.HVaRMeasureSettings

pydantic model bayesline.api.equity.HVaRMeasureSettings

Settings for historical VaR measure.

This class defines settings for a historical Value at Risk (VaR) measure, which provides historical VaR calculations at specified confidence levels.

Show JSON schema

{
   "title": "HVaRMeasureSettings",
   "description": "Settings for historical VaR measure.\n\nThis class defines settings for a historical Value at Risk (VaR) measure,\nwhich provides historical VaR calculations at specified confidence levels.",
   "type": "object",
   "properties": {
      "type": {
         "const": "Historical VaR",
         "default": "Historical VaR",
         "title": "Type",
         "type": "string"
      },
      "alpha": {
         "default": [
            0.1,
            0.05
         ],
         "items": {
            "type": "number"
         },
         "title": "Alpha",
         "type": "array"
      }
   },
   "additionalProperties": false
}

Config:

• frozen: bool = True

• extra: str = forbid

Fields:

• alpha (list[float])

• type (Literal['Historical VaR'])

field type: Literal['Historical VaR'] = 'Historical VaR'

field alpha: list[float] = [0.1, 0.05]

property columns: list[str]

Get the column names for this measure.

Returns

list[str]

The column names for this measure.