Skip to content

sliderfilter

sliderfilter

Module contains the filter with a slider

Classes

SliderFilter 

SliderFilter(
    meta_function,
    default_min=None,
    default_max=None,
    mode="min",
)

Bases: ExperimentFilter

Filter for experiments which uses a slider

Source code in niceml/experiments/filters/sliderfilter.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
def __init__(
    self,
    meta_function: MetaFunction,
    default_min: Optional[Any] = None,
    default_max: Optional[Any] = None,
    mode: str = "min",
):
    super().__init__()
    self.meta_function = meta_function
    self.default_min = default_min
    self.default_max = default_max
    self.mode = mode
    self.selected_value = None
    if self.mode not in MODE_STR:
        raise UnsupportedModeError(
            f"Mode: {self.mode}" f"is not supported!" f"Supported modes: {MODE_STR}"
        )
Functions
filter 
filter(exp_list)

filters experiments according to the settings

Source code in niceml/experiments/filters/sliderfilter.py 
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
def filter(self, exp_list: List[ExperimentData]) -> List[ExperimentData]:
    """filters experiments according to the settings"""
    out_exp_list: List[ExperimentData] = []
    for exp_data in exp_list:
        val = self.meta_function(exp_data)
        if self.mode == MODE_STR[0] and self.selected_value <= val:
            out_exp_list.append(exp_data)
        elif self.mode == MODE_STR[1] and self.selected_value >= val:
            out_exp_list.append(exp_data)
        elif self.mode == MODE_STR[2]:
            sel_min, sel_max = self.selected_value
            if sel_min <= val <= sel_max:
                out_exp_list.append(exp_data)

    return out_exp_list
render 
render(exp_list)

renders the component in the streamlit sidebar and stores the selected result

Source code in niceml/experiments/filters/sliderfilter.py 
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
def render(self, exp_list: List[ExperimentData]):
    """renders the component in the streamlit sidebar
    and stores the selected result"""
    values = [self.meta_function(exp_data) for exp_data in exp_list]
    min_value = min(values)
    if self.default_min is not None:
        min_value = min(min_value, self.default_min)
    max_value = max(values)
    if self.default_max is not None:
        max_value = max(max_value, self.default_max)
    if self.mode == MODE_STR[0]:
        value = min_value
    elif self.mode == MODE_STR[1]:
        value = max_value
    else:
        value = (min_value, max_value)
    self.selected_value = st.sidebar.slider(
        label=self.meta_function.get_name(),
        min_value=min_value,
        max_value=max_value,
        value=value,
    )

UnsupportedModeError

Bases: Exception

Error when the mode is not supported