bayesline.api.equity.FactorRiskModelSettingsMenu

pydantic model bayesline.api.equity.FactorRiskModelSettingsMenu

Defines available settings to build a factor risk model.

Show JSON schema

{
   "title": "FactorRiskModelSettingsMenu",
   "description": "Defines available settings to build a factor risk model.",
   "type": "object",
   "properties": {},
   "additionalProperties": false
}

Config:

• frozen: bool = True

• extra: str = forbid

describe(settings: FactorRiskModelSettings | None = None) → str

Parameters

settingsSettingsType | None

The settings to describe. If None, then the description is not evaluated against any settings.

Returns

A human readable description of the settings menu, optionally evaluated against the given settings.

validate_settings(settings: FactorRiskModelSettings) → None

Validates if the given settings are valid for this settings menu.

Parameters

settingsSettingsType

The settings to validate.

Raises

ValidationError if a pydantic error occurs or ValueError if passed settings values are invalid.