Skip to content

expviscomponent

expviscomponent

Module for ExpVisComponent for the dashboard

Classes

ExpVisComponent 

ExpVisComponent(
    component_name=None,
    meta_function=None,
    target_value_list=None,
    assert_on_error=False,
)

Bases: ABC

Basic dashboard component to visualize experiments

Source code in niceml/dashboard/components/expviscomponent.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
def __init__(
    self,
    component_name: Optional[str] = None,
    meta_function: Optional[MetaFunction] = None,
    target_value_list: Optional[List[Any]] = None,
    assert_on_error: bool = False,
):
    # Create empty list for chart images
    self.component_name: Optional[str] = component_name
    self.chart_images_list: List[Image.Image] = []
    self.meta_function = meta_function
    self.target_value_list = [] if target_value_list is None else target_value_list
    self.assert_on_error = assert_on_error
Functions
get_component_name 
get_component_name()

Returns the components_name for visualization

Source code in niceml/dashboard/components/expviscomponent.py 
35
36
37
def get_component_name(self) -> Optional[str]:
    """Returns the components_name for visualization"""
    return self.component_name
get_images 
get_images()

Returns the chart images

Source code in niceml/dashboard/components/expviscomponent.py 
75
76
77
def get_images(self) -> List[Image.Image]:
    """Returns the chart images"""
    return self.chart_images_list
render 
render(
    exp_manager,
    storage_interface,
    exp_ids,
    subset_name=None,
)

Called when a component is rendered

Source code in niceml/dashboard/components/expviscomponent.py 
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
def render(
    self,
    exp_manager: ExperimentManager,
    storage_interface: StorageInterface,
    exp_ids: List[str],
    subset_name: Optional[str] = None,
):
    """Called when a component is rendered"""
    try:
        if self.meta_function is None:
            self._render(exp_manager, storage_interface, exp_ids, subset_name)
        else:
            filtered_exp_list: List[str] = []
            for exp_id in exp_ids:
                exp_data: ExperimentData = exp_manager.get_exp_by_id(exp_id)
                meta_target = self.meta_function(exp_data)
                if meta_target in self.target_value_list:
                    filtered_exp_list.append(exp_id)
            self._render(
                exp_manager, storage_interface, filtered_exp_list, subset_name
            )
    except Exception as error:  # pylint: disable=broad-except
        st.error(f"Rendering failed: {error}")
        if self.assert_on_error:
            raise error

RenderingError

Bases: Exception

Error when component could not be rendered

SingleExpVisComponent 

SingleExpVisComponent(
    meta_function=None,
    target_value_list=None,
    assert_on_error=False,
)

Bases: ABC

Visualization component for a single experiment

Source code in niceml/dashboard/components/expviscomponent.py 
83
84
85
86
87
88
89
90
91
92
93
def __init__(
    self,
    meta_function: Optional[MetaFunction] = None,
    target_value_list: Optional[List[Any]] = None,
    assert_on_error: bool = False,
):
    # Create empty list for chart images
    self.chart_images_list: List[Image.Image] = []
    self.meta_function = meta_function
    self.target_value_list = [] if target_value_list is None else target_value_list
    self.assert_on_error = assert_on_error
Functions
get_images 
get_images()

Returns the chart images

Source code in niceml/dashboard/components/expviscomponent.py 
126
127
128
def get_images(self) -> List[Image.Image]:
    """Returns the chart images"""
    return self.chart_images_list
render 
render(
    exp_manager, storage_interface, exp_id, subset_name=None
)

Called when a component is rendered

Source code in niceml/dashboard/components/expviscomponent.py 
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
def render(
    self,
    exp_manager: ExperimentManager,
    storage_interface: StorageInterface,
    exp_id: str,
    subset_name: Optional[str] = None,
):
    """Called when a component is rendered"""
    try:
        if self.meta_function is None:
            self._render(exp_manager, storage_interface, exp_id, subset_name)
        else:
            exp_data: ExperimentData = exp_manager.get_exp_by_id(exp_id)
            meta_target = self.meta_function(exp_data)
            if meta_target in self.target_value_list:
                self._render(exp_manager, storage_interface, exp_id, subset_name)
    except RenderingError as error:
        st.error(f"Rendering failed: {error}")
        if self.assert_on_error:
            raise error