bayesline.api.SettingsMenu

pydantic model bayesline.api.SettingsMenu

Show JSON schema

{
   "title": "SettingsMenu",
   "type": "object",
   "properties": {},
   "additionalProperties": false
}

Config:

• frozen: bool = True

• extra: str = forbid

abstract describe(settings: SettingsType | 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.

abstract validate_settings(settings: SettingsType) → 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.