Skip to content

General Frame

GeneralFrame

Bases: CTkFrame, EvaluationBaseFrame

Class for the general evaluation frame.

Source code in evaluator/frontend/components/evaluation_frames/general_frame.py 
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 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
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
class GeneralFrame(ctk.CTkFrame, EvaluationBaseFrame):
    """Class for the general evaluation frame."""

    def __init__(
        self, master: ctk.CTkFrame, app_state: AppState, run_state: RunState, **kwargs
    ):
        """Constructor."""
        super().__init__(master, **kwargs)
        self.state = app_state
        self.run = run_state
        self.general_eval = self.run["eval_data"]["general_eval"]

        self.grid_columnconfigure(0, weight=1)
        self.grid_rowconfigure(1, weight=1)

        self.main_gen_label = ctk.CTkLabel(
            master=self,
            text="General Evaluation",
            font=(self.state["font"], 28, "bold"),
        )
        self.main_gen_label.grid(
            row=0, columnspan=2, padx=self.state["padding"], pady=self.state["padding"]
        )

        self.relevancy_label = ctk.CTkLabel(
            master=self,
            text="How relevant is the domain content?",
            font=(self.state["font"], 16, "bold"),
        )
        self.relevancy_label.grid(
            row=2,
            column=0,
            padx=(self.state["padding"], self.state["padding"] // 4),
            pady=(self.state["padding"] // 2, self.state["padding"] // 4),
            sticky="w",
        )

        self.relevancy_var = ctk.IntVar(
            value=self.general_eval.get("relevancy", EVAL_DEFAULTS["relevancy"])
        )
        self.relevancy_button = ctk.CTkSegmentedButton(
            master=self, values=[-1, 0, 1, 2], variable=self.relevancy_var
        )
        self.relevancy_button.grid(
            row=2,
            column=1,
            padx=(self.state["padding"] // 4, self.state["padding"]),
            pady=(self.state["padding"] // 2, self.state["padding"] // 4),
            sticky="w",
        )

        self.readability_label = ctk.CTkLabel(
            master=self,
            text="How readable is the domain content?",
            font=(self.state["font"], 16, "bold"),
        )
        self.readability_label.grid(
            row=3,
            column=0,
            padx=(self.state["padding"], self.state["padding"] // 4),
            pady=self.state["padding"] // 4,
            sticky="w",
        )

        self.readability_var = ctk.IntVar(
            value=self.general_eval.get("readability", EVAL_DEFAULTS["readability"])
        )
        self.readability_button = ctk.CTkSegmentedButton(
            master=self, values=[-1, 0, 1, 2], variable=self.readability_var
        )
        self.readability_button.grid(
            row=3,
            column=1,
            padx=(self.state["padding"] // 4, self.state["padding"]),
            pady=self.state["padding"] // 4,
            sticky="w",
        )

        self.reproducibility_label = ctk.CTkLabel(
            master=self,
            text="How reproducible is the domain content?",
            font=(self.state["font"], 16, "bold"),
        )
        self.reproducibility_label.grid(
            row=4,
            column=0,
            padx=(self.state["padding"], self.state["padding"] // 4),
            pady=self.state["padding"] // 4,
            sticky="w",
        )

        self.reproducibility_var = ctk.IntVar(
            value=self.general_eval.get(
                "reproducibility", EVAL_DEFAULTS["reproducibility"]
            )
        )
        self.reproducibility_button = ctk.CTkSegmentedButton(
            master=self, values=[-1, 0, 1, 2], variable=self.reproducibility_var
        )
        self.reproducibility_button.grid(
            row=4,
            column=1,
            padx=(self.state["padding"] // 4, self.state["padding"]),
            pady=self.state["padding"] // 4,
            sticky="w",
        )

        self.conf_label = ctk.CTkLabel(
            master=self,
            text="What is your confidence rating for the domain?",
            font=(self.state["font"], 16, "bold"),
        )
        self.conf_label.grid(
            row=5,
            column=0,
            padx=(self.state["padding"], self.state["padding"] // 4),
            pady=self.state["padding"] // 4,
            sticky="w",
        )

        self.conf_var = ctk.IntVar(
            value=self.general_eval.get(
                "confidence_rating", EVAL_DEFAULTS["confidence_rating"]
            )
        )
        self.conf_button = ctk.CTkSegmentedButton(
            master=self, values=[-1, 0, 1, 2], variable=self.conf_var
        )
        self.conf_button.grid(
            row=5,
            column=1,
            padx=(self.state["padding"] // 4, self.state["padding"]),
            pady=self.state["padding"] // 4,
            sticky="w",
        )

        self.general_notes_label = ctk.CTkLabel(
            master=self, text="Notes", font=(self.state["font"], 16, "bold")
        )
        self.general_notes_label.grid(
            row=6,
            column=0,
            padx=self.state["padding"],
            pady=(self.state["padding"] // 2, self.state["padding"] // 4),
            sticky="w",
        )

        self.general_notes = ctk.CTkTextbox(
            master=self, wrap="word", font=(self.state["font"], 18)
        )
        self.general_notes.grid(
            row=7,
            columnspan=2,
            padx=self.state["padding"] // 2,
            pady=(self.state["padding"] // 4, self.state["padding"]),
            sticky="nsew",
        )

    def update_state(self, app_state: AppState, run_state: RunState) -> None:
        """Update the component state.

        Parameters
        ----------
        app_state : AppState
            The updated app state.
        run_state : RunState
            The updated run state.
        """
        self.run = run_state
        self.state = app_state
        self.general_eval = self.run["eval_data"]["general_eval"]

        self.relevancy_var = ctk.IntVar(
            value=self.general_eval.get("relevancy", EVAL_DEFAULTS["relevancy"])
        )
        self.relevancy_button.configure(variable=self.relevancy_var)

        self.readability_var = ctk.IntVar(
            value=self.general_eval.get("readability", EVAL_DEFAULTS["readability"])
        )
        self.readability_button.configure(variable=self.readability_var)

        self.reproducibility_var = ctk.IntVar(
            value=self.general_eval.get(
                "reproducibility", EVAL_DEFAULTS["reproducibility"]
            )
        )
        self.reproducibility_button.configure(variable=self.reproducibility_var)

        self.conf_var = ctk.IntVar(
            value=self.general_eval.get(
                "confidence_rating", EVAL_DEFAULTS["confidence_rating"]
            )
        )
        self.conf_button.configure(variable=self.conf_var)

        self.general_notes.delete(0.0, "end")
        self.general_notes.insert(
            0.0, self.general_eval.get("notes", EVAL_DEFAULTS["notes"])
        )

    def get_results(self) -> GeneralEval:
        """Returns the general evaluations.

        Returns
        -------
        GeneralEval
            The general evaluation results.
        """
        relevancy_val = self.relevancy_var.get()
        readability_var = self.readability_var.get()
        reproducibility_var = self.reproducibility_var.get()
        conf_var = self.conf_var.get()
        general_val = create_general_eval(
            relevancy=relevancy_val,
            readability=readability_var,
            reproducibility=reproducibility_var,
            confidence_rating=conf_var,
            notes=self.general_notes.get(0.0, "end"),
        )
        return general_val

__init__(master, app_state, run_state, **kwargs)

Constructor.

Source code in evaluator/frontend/components/evaluation_frames/general_frame.py 
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 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
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
def __init__(
    self, master: ctk.CTkFrame, app_state: AppState, run_state: RunState, **kwargs
):
    """Constructor."""
    super().__init__(master, **kwargs)
    self.state = app_state
    self.run = run_state
    self.general_eval = self.run["eval_data"]["general_eval"]

    self.grid_columnconfigure(0, weight=1)
    self.grid_rowconfigure(1, weight=1)

    self.main_gen_label = ctk.CTkLabel(
        master=self,
        text="General Evaluation",
        font=(self.state["font"], 28, "bold"),
    )
    self.main_gen_label.grid(
        row=0, columnspan=2, padx=self.state["padding"], pady=self.state["padding"]
    )

    self.relevancy_label = ctk.CTkLabel(
        master=self,
        text="How relevant is the domain content?",
        font=(self.state["font"], 16, "bold"),
    )
    self.relevancy_label.grid(
        row=2,
        column=0,
        padx=(self.state["padding"], self.state["padding"] // 4),
        pady=(self.state["padding"] // 2, self.state["padding"] // 4),
        sticky="w",
    )

    self.relevancy_var = ctk.IntVar(
        value=self.general_eval.get("relevancy", EVAL_DEFAULTS["relevancy"])
    )
    self.relevancy_button = ctk.CTkSegmentedButton(
        master=self, values=[-1, 0, 1, 2], variable=self.relevancy_var
    )
    self.relevancy_button.grid(
        row=2,
        column=1,
        padx=(self.state["padding"] // 4, self.state["padding"]),
        pady=(self.state["padding"] // 2, self.state["padding"] // 4),
        sticky="w",
    )

    self.readability_label = ctk.CTkLabel(
        master=self,
        text="How readable is the domain content?",
        font=(self.state["font"], 16, "bold"),
    )
    self.readability_label.grid(
        row=3,
        column=0,
        padx=(self.state["padding"], self.state["padding"] // 4),
        pady=self.state["padding"] // 4,
        sticky="w",
    )

    self.readability_var = ctk.IntVar(
        value=self.general_eval.get("readability", EVAL_DEFAULTS["readability"])
    )
    self.readability_button = ctk.CTkSegmentedButton(
        master=self, values=[-1, 0, 1, 2], variable=self.readability_var
    )
    self.readability_button.grid(
        row=3,
        column=1,
        padx=(self.state["padding"] // 4, self.state["padding"]),
        pady=self.state["padding"] // 4,
        sticky="w",
    )

    self.reproducibility_label = ctk.CTkLabel(
        master=self,
        text="How reproducible is the domain content?",
        font=(self.state["font"], 16, "bold"),
    )
    self.reproducibility_label.grid(
        row=4,
        column=0,
        padx=(self.state["padding"], self.state["padding"] // 4),
        pady=self.state["padding"] // 4,
        sticky="w",
    )

    self.reproducibility_var = ctk.IntVar(
        value=self.general_eval.get(
            "reproducibility", EVAL_DEFAULTS["reproducibility"]
        )
    )
    self.reproducibility_button = ctk.CTkSegmentedButton(
        master=self, values=[-1, 0, 1, 2], variable=self.reproducibility_var
    )
    self.reproducibility_button.grid(
        row=4,
        column=1,
        padx=(self.state["padding"] // 4, self.state["padding"]),
        pady=self.state["padding"] // 4,
        sticky="w",
    )

    self.conf_label = ctk.CTkLabel(
        master=self,
        text="What is your confidence rating for the domain?",
        font=(self.state["font"], 16, "bold"),
    )
    self.conf_label.grid(
        row=5,
        column=0,
        padx=(self.state["padding"], self.state["padding"] // 4),
        pady=self.state["padding"] // 4,
        sticky="w",
    )

    self.conf_var = ctk.IntVar(
        value=self.general_eval.get(
            "confidence_rating", EVAL_DEFAULTS["confidence_rating"]
        )
    )
    self.conf_button = ctk.CTkSegmentedButton(
        master=self, values=[-1, 0, 1, 2], variable=self.conf_var
    )
    self.conf_button.grid(
        row=5,
        column=1,
        padx=(self.state["padding"] // 4, self.state["padding"]),
        pady=self.state["padding"] // 4,
        sticky="w",
    )

    self.general_notes_label = ctk.CTkLabel(
        master=self, text="Notes", font=(self.state["font"], 16, "bold")
    )
    self.general_notes_label.grid(
        row=6,
        column=0,
        padx=self.state["padding"],
        pady=(self.state["padding"] // 2, self.state["padding"] // 4),
        sticky="w",
    )

    self.general_notes = ctk.CTkTextbox(
        master=self, wrap="word", font=(self.state["font"], 18)
    )
    self.general_notes.grid(
        row=7,
        columnspan=2,
        padx=self.state["padding"] // 2,
        pady=(self.state["padding"] // 4, self.state["padding"]),
        sticky="nsew",
    )

update_state(app_state, run_state)

Update the component state.

Parameters:

Name Type Description Default
app_state AppState

The updated app state.

 required
run_state RunState

The updated run state.

 required
Source code in evaluator/frontend/components/evaluation_frames/general_frame.py 
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
def update_state(self, app_state: AppState, run_state: RunState) -> None:
    """Update the component state.

    Parameters
    ----------
    app_state : AppState
        The updated app state.
    run_state : RunState
        The updated run state.
    """
    self.run = run_state
    self.state = app_state
    self.general_eval = self.run["eval_data"]["general_eval"]

    self.relevancy_var = ctk.IntVar(
        value=self.general_eval.get("relevancy", EVAL_DEFAULTS["relevancy"])
    )
    self.relevancy_button.configure(variable=self.relevancy_var)

    self.readability_var = ctk.IntVar(
        value=self.general_eval.get("readability", EVAL_DEFAULTS["readability"])
    )
    self.readability_button.configure(variable=self.readability_var)

    self.reproducibility_var = ctk.IntVar(
        value=self.general_eval.get(
            "reproducibility", EVAL_DEFAULTS["reproducibility"]
        )
    )
    self.reproducibility_button.configure(variable=self.reproducibility_var)

    self.conf_var = ctk.IntVar(
        value=self.general_eval.get(
            "confidence_rating", EVAL_DEFAULTS["confidence_rating"]
        )
    )
    self.conf_button.configure(variable=self.conf_var)

    self.general_notes.delete(0.0, "end")
    self.general_notes.insert(
        0.0, self.general_eval.get("notes", EVAL_DEFAULTS["notes"])
    )

get_results()

Returns the general evaluations.

Returns:

Type Description
GeneralEval

The general evaluation results.
Source code in evaluator/frontend/components/evaluation_frames/general_frame.py 
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
def get_results(self) -> GeneralEval:
    """Returns the general evaluations.

    Returns
    -------
    GeneralEval
        The general evaluation results.
    """
    relevancy_val = self.relevancy_var.get()
    readability_var = self.readability_var.get()
    reproducibility_var = self.reproducibility_var.get()
    conf_var = self.conf_var.get()
    general_val = create_general_eval(
        relevancy=relevancy_val,
        readability=readability_var,
        reproducibility=reproducibility_var,
        confidence_rating=conf_var,
        notes=self.general_notes.get(0.0, "end"),
    )
    return general_val