Lookups dataclass

These indexes are useful to climb up the hierarchies of certain axes. Lookups includes lookups like location_lookups: wholesaler->state->region lookups product_lookups: brand vehicle_lookups: vehicle->parent vehicle signal_lookups: signal->parent signal

Source code in wt_ml/output/artifacts/artifacts_dataclass.py 
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
@dataclass(frozen=True, slots=True)
class Lookups:
    """
    These indexes are useful to climb up the hierarchies of certain axes.
    Lookups includes lookups like
    location_lookups: wholesaler->state->region lookups
    product_lookups: brand
    vehicle_lookups: vehicle->parent vehicle
    signal_lookups: signal->parent signal
    """

    location_lookups: pd.MultiIndex
    product_lookups: pd.MultiIndex
    vehicle_lookups: pd.MultiIndex
    signal_lookups: pd.MultiIndex

Others dataclass

For backward compatibility purposes, it is imperative that any new dataframes must be added here only! The dataframes are nullable, so any function using this must handle it coreectly.

Source code in wt_ml/output/artifacts/artifacts_dataclass.py 
35
36
37
38
39
40
41
42
@dataclass(frozen=True, slots=True)
class Others:
    """
    For backward compatibility purposes, it is imperative that any new dataframes must be added here only!
    The dataframes are nullable, so any function using this must handle it coreectly.
    """

    pass

dataclass_from_dict(data_class, data)

Create a data class instance from a dictionary.

:param data_class: a data class type :param data: a dictionary of a input data :param config: a configuration of the creation process :return: an instance of a data class

Source code in wt_ml/output/artifacts/_utils.py 
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
def dataclass_from_dict(data_class: type[D], data: Data) -> D:
    """Create a data class instance from a dictionary.

    :param data_class: a data class type
    :param data: a dictionary of a input data
    :param config: a configuration of the creation process
    :return: an instance of a data class
    """
    init_values = {}

    for field in get_fields(data_class):
        if field.name in data:
            field_data = data[field.name]
            value = _create_field_value(field, field_data)
        else:
            value = get_default_value_for_field(field)

        init_values[field.name] = value

    instance = data_class(**init_values)
    return instance