parsnip.parse_settings

parsnip.parse_settings(bands, settings={}, ignore_unknown_settings=False)

Parse the settings for a ParSNIP model

Parameters:
  • bands (List[str]) – Bands to use in the encoder model

  • settings (dict, optional) – Settings to override, by default {}

  • ignore_unknown_settings (bool, optional) – If False (default), raise an KeyError if there are any unknown settings. Otherwise, do nothing.

Returns:

Parsed settings dictionary

Return type:

dict

Raises:

KeyError – If there are unknown keys in the input settings