bayesline.api.SettingsRegistry#
- class bayesline.api.SettingsRegistry#
Bases:
Registry[SettingsType],Generic[SettingsType,SettingsMenuType]Methods
__init__()available_settings([dataset_name])Parameters dataset_name str | None The name of the dataset to use when retrieving the settings menu. If not provided, the settings menu will be retrieved for the default dataset.
delete(name)Parameters name str | int The unique name or int identifier of the settings to delete.
get(name)Parameters name str | int The unique name or int identifier of the item to retrieve.
get_all()Returns A dictionary of all valid available settings.
Returns A dictionary of all available settings metadata (valid or invalid).
Returns A dictionary of all valid available settings with metadata.
get_metadata(name)Parameters name str | int The unique name or int identifier of the item to retrieve.
get_raw(name_or_id)Parameters name_or_id list[str | int] The unique names or int identifiers of the items to retrieve.
ids([mode])Parameters mode Mode The mode to use when retrieving the ids.
names([mode])Parameters mode Mode The mode to use when retrieving the ids.
save(name, settings)Parameters name str The unique name of the item to save. The name cannot be all numbers. settings T The item to save.
update(name, settings)Parameters name str | int The unique name or int identifier of the item to update. settings T The item to update.
- abstract available_settings(dataset_name: str | None = None) SettingsMenuType#
Parameters#
- dataset_namestr | None
The name of the dataset to use when retrieving the settings menu. If not provided, the settings menu will be retrieved for the default dataset.
Returns#
A description of valid settings for this registry.