parameters

Custom luigi parameters.

Classes:

DerivableInstParameter([default, is_global, ...])	Parameter that can be used to pass the instance of a Derivable subclass.
DerivableInstsParameter([default, ...])	Parameter that can be used to pass multiple instances of a Derivable subclass.
SettingsParameter(**kwargs)	Parameter that parses the input of a CSVParameter into a dictionary Example:
MultiSettingsParameter(**kwargs)	Parameter that parses the input of a MultiCSVParameter into a double-dict structure.

class DerivableInstParameter(default=<object object>, is_global=False, significant=True, description=None, config_path=None, positional=True, always_in_help=False, batch_method=None, visibility=ParameterVisibility.PUBLIC)

Bases: Parameter

Parameter that can be used to pass the instance of a Derivable subclass.

This class does not implement parameter value parsing.

Methods:

serialize(x)

Opposite of parse().

serialize(x)

Opposite of parse().

Converts the value x to a string.

Parameters:

x (Any) – the value to serialize.

Return type:

str

class DerivableInstsParameter(default=<object object>, is_global=False, significant=True, description=None, config_path=None, positional=True, always_in_help=False, batch_method=None, visibility=ParameterVisibility.PUBLIC)

Bases: Parameter

Parameter that can be used to pass multiple instances of a Derivable subclass.

This class does not implement parameter value parsing.

Methods:

serialize(x)

serialize(x)

Return type:

str

class SettingsParameter(**kwargs)

Bases: CSVParameter

Parameter that parses the input of a CSVParameter into a dictionary Example:

p = SettingsParameter()

p.parse("param1=10,param2,param3=text,param4=false")
=> {"param1": 10.0, "param2": True, "param3": "text", "param4": False}

p.serialize({"param1": 2, "param2": False})
=> "param1=2,param2=False"

Attributes:

settings_delimiter
tuple_delimiter

Methods:

parse_setting(setting)
parse_value(value)
serialize_setting(name, value)
parse(inp)
serialize(value)

settings_delimiter = '='

tuple_delimiter = ';'

classmethod parse_setting(setting)

Return type:

tuple[str, float | bool | str]

classmethod parse_value(value)

classmethod serialize_setting(name, value)

Return type:

str

parse(inp)

serialize(value)

class MultiSettingsParameter(**kwargs)

Bases: MultiCSVParameter

Parameter that parses the input of a MultiCSVParameter into a double-dict structure. Example:

p = MultiSettingsParameter()

p.parse("obj1,k1=10,k2,k3=text:obj2,k4=false")
# => {"obj1": {"k1": 10.0, "k2": True, "k3": "text"}, "obj2": {"k4": False}}

p.serialize({"obj1": {"k1": "val"}, "obj2": {"k2": 2}})
# => "obj1,k1=val:obj2,k2=2"

Methods:

parse(inp)
serialize(value)

parse(inp)

serialize(value)