kd.konfig.DEFINE_config_file

kd.konfig.DEFINE_config_file#

kauldron.konfig.DEFINE_config_file(
name: str,
default: str | None = None,
help_string: str = 'path to config file.',
*,
flag_values: absl.flags._flagvalues.FlagValues = <absl.flags._flagvalues.FlagValues object>,
lock_config: bool = False,
) → absl.flags._flagvalues.FlagHolder[kauldron.konfig.configdict_base.ConfigDict][source]

Defines flag for ConfigDict.

This is a wrapper over ml_collections.config_flags.DEFINE_config_file which set the relevant default params.

Parameters:

  • name – Flag name, optionally including extra config after a colon.

  • default – Default value of the flag (default: None).

  • help_string – Help string to display when –helpfull is called. (default: “path to config file.”)

  • flag_values – FlagValues instance used for parsing. (default: absl.flags.FLAGS)

  • lock_config – If set to True, loaded config will be locked through calling .lock() method on its instance (if it exists). (default: True)

Returns:

a handle to defined flag.