Skip to content

Miscellaneous Frame

MiscFrame

Bases: CTkFrame, EvaluationBaseFrame

Class for the miscellaneous evaluation frame.

Source code in evaluator/frontend/components/evaluation_frames/miscellaneous_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
class MiscFrame(ctk.CTkFrame, EvaluationBaseFrame):
    """Class for the miscellaneous 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.misc_eval = self.run["eval_data"]["misc_eval"]

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

        self.main_misc_label = ctk.CTkLabel(
            master=self,
            text="Miscellaneous Evaluation",
            font=(self.state["font"], 28, "bold"),
        )
        self.main_misc_label.grid(
            row=0,
            column=0,
            columnspan=2,
            padx=self.state["padding"],
            pady=self.state["padding"],
            sticky="n",
        )

        self.human_domain_rating_label = ctk.CTkLabel(
            master=self,
            text="What would you rate the human curated domain?",
            font=(self.state["font"], 16, "bold"),
        )
        self.human_domain_rating_label.grid(
            row=2,
            column=0,
            padx=(self.state["padding"], 0),
            pady=(self.state["padding"] // 2, self.state["padding"] // 4),
            sticky="w",
        )

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

        self.evaluator_conf_label = ctk.CTkLabel(
            master=self,
            text="What is your confidence in your evaluation?",
            font=(self.state["font"], 16, "bold"),
        )
        self.evaluator_conf_label.grid(
            row=4,
            column=0,
            padx=(self.state["padding"], 0),
            pady=(self.state["padding"] // 2, self.state["padding"] // 4),
            sticky="w",
        )

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

        self.evaluator_fam_label = ctk.CTkLabel(
            master=self,
            text="What is your familiarity with the paper content?",
            font=(self.state["font"], 16, "bold"),
        )
        self.evaluator_fam_label.grid(
            row=6,
            column=0,
            padx=(self.state["padding"], 0),
            pady=(self.state["padding"] // 2, self.state["padding"] // 4),
            sticky="w",
        )

        self.evaluator_fam_var = ctk.IntVar(
            value=self.misc_eval.get(
                "evaluator_familiarity_level",
                EVAL_DEFAULTS["evaluator_familiarity_level"],
            )
        )
        self.evaluator_fam_button = ctk.CTkSegmentedButton(
            master=self, values=[-1, 0, 1, 2], variable=self.evaluator_conf_var
        )
        self.evaluator_fam_button.grid(
            row=7,
            column=0,
            padx=(self.state["padding"], 0),
            pady=(self.state["padding"] // 4, self.state["padding"] // 2),
            sticky="w",
        )

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

        self.misc_notes = ctk.CTkTextbox(
            master=self, wrap="word", font=(self.state["font"], 18)
        )
        self.misc_notes.grid(
            row=3,
            rowspan=6,
            column=1,
            padx=(0, 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.misc_eval = self.run["eval_data"]["misc_eval"]

        self.human_domain_rating_var = ctk.IntVar(
            value=self.misc_eval.get(
                "human_domain_rating", EVAL_DEFAULTS["human_domain_rating"]
            )
        )
        self.human_domain_rating_button.configure(variable=self.human_domain_rating_var)

        self.evaluator_conf_var = ctk.IntVar(
            value=self.misc_eval.get(
                "evaluator_confidence_rating",
                EVAL_DEFAULTS["evaluator_confidence_rating"],
            )
        )
        self.evaluator_conf_button.configure(variable=self.evaluator_conf_var)

        self.evaluator_fam_var = ctk.IntVar(
            value=self.misc_eval.get(
                "evaluator_familiarity_level",
                EVAL_DEFAULTS["evaluator_familiarity_level"],
            )
        )
        self.evaluator_fam_button.configure(variable=self.evaluator_fam_var)

        self.misc_notes.delete(0.0, "end")
        self.misc_notes.insert(0.0, self.misc_eval.get("notes", EVAL_DEFAULTS["notes"]))

    def get_results(self) -> MiscEval:
        """Returns the miscellaneous evaluations.

        Returns
        -------
        MiscEval
            The miscellaneous evaluation results.
        """
        human_domain_rating = self.human_domain_rating_var.get()
        evaluator_conf_rating = self.evaluator_conf_var.get()
        evaluator_familiarity_level = self.evaluator_fam_var.get()
        misc_eval = create_misc_eval(
            human_domain_rating=human_domain_rating,
            evaluator_confidence_rating=evaluator_conf_rating,
            evaluator_familiarity_level=evaluator_familiarity_level,
            notes=self.misc_notes.get(0.0, "end"),
        )
        return misc_eval

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

Constructor.

Source code in evaluator/frontend/components/evaluation_frames/miscellaneous_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
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.misc_eval = self.run["eval_data"]["misc_eval"]

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

    self.main_misc_label = ctk.CTkLabel(
        master=self,
        text="Miscellaneous Evaluation",
        font=(self.state["font"], 28, "bold"),
    )
    self.main_misc_label.grid(
        row=0,
        column=0,
        columnspan=2,
        padx=self.state["padding"],
        pady=self.state["padding"],
        sticky="n",
    )

    self.human_domain_rating_label = ctk.CTkLabel(
        master=self,
        text="What would you rate the human curated domain?",
        font=(self.state["font"], 16, "bold"),
    )
    self.human_domain_rating_label.grid(
        row=2,
        column=0,
        padx=(self.state["padding"], 0),
        pady=(self.state["padding"] // 2, self.state["padding"] // 4),
        sticky="w",
    )

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

    self.evaluator_conf_label = ctk.CTkLabel(
        master=self,
        text="What is your confidence in your evaluation?",
        font=(self.state["font"], 16, "bold"),
    )
    self.evaluator_conf_label.grid(
        row=4,
        column=0,
        padx=(self.state["padding"], 0),
        pady=(self.state["padding"] // 2, self.state["padding"] // 4),
        sticky="w",
    )

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

    self.evaluator_fam_label = ctk.CTkLabel(
        master=self,
        text="What is your familiarity with the paper content?",
        font=(self.state["font"], 16, "bold"),
    )
    self.evaluator_fam_label.grid(
        row=6,
        column=0,
        padx=(self.state["padding"], 0),
        pady=(self.state["padding"] // 2, self.state["padding"] // 4),
        sticky="w",
    )

    self.evaluator_fam_var = ctk.IntVar(
        value=self.misc_eval.get(
            "evaluator_familiarity_level",
            EVAL_DEFAULTS["evaluator_familiarity_level"],
        )
    )
    self.evaluator_fam_button = ctk.CTkSegmentedButton(
        master=self, values=[-1, 0, 1, 2], variable=self.evaluator_conf_var
    )
    self.evaluator_fam_button.grid(
        row=7,
        column=0,
        padx=(self.state["padding"], 0),
        pady=(self.state["padding"] // 4, self.state["padding"] // 2),
        sticky="w",
    )

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

    self.misc_notes = ctk.CTkTextbox(
        master=self, wrap="word", font=(self.state["font"], 18)
    )
    self.misc_notes.grid(
        row=3,
        rowspan=6,
        column=1,
        padx=(0, 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/miscellaneous_frame.py 
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
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.misc_eval = self.run["eval_data"]["misc_eval"]

    self.human_domain_rating_var = ctk.IntVar(
        value=self.misc_eval.get(
            "human_domain_rating", EVAL_DEFAULTS["human_domain_rating"]
        )
    )
    self.human_domain_rating_button.configure(variable=self.human_domain_rating_var)

    self.evaluator_conf_var = ctk.IntVar(
        value=self.misc_eval.get(
            "evaluator_confidence_rating",
            EVAL_DEFAULTS["evaluator_confidence_rating"],
        )
    )
    self.evaluator_conf_button.configure(variable=self.evaluator_conf_var)

    self.evaluator_fam_var = ctk.IntVar(
        value=self.misc_eval.get(
            "evaluator_familiarity_level",
            EVAL_DEFAULTS["evaluator_familiarity_level"],
        )
    )
    self.evaluator_fam_button.configure(variable=self.evaluator_fam_var)

    self.misc_notes.delete(0.0, "end")
    self.misc_notes.insert(0.0, self.misc_eval.get("notes", EVAL_DEFAULTS["notes"]))

get_results()

Returns the miscellaneous evaluations.

Returns:

Type Description
MiscEval

The miscellaneous evaluation results.
Source code in evaluator/frontend/components/evaluation_frames/miscellaneous_frame.py 
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
def get_results(self) -> MiscEval:
    """Returns the miscellaneous evaluations.

    Returns
    -------
    MiscEval
        The miscellaneous evaluation results.
    """
    human_domain_rating = self.human_domain_rating_var.get()
    evaluator_conf_rating = self.evaluator_conf_var.get()
    evaluator_familiarity_level = self.evaluator_fam_var.get()
    misc_eval = create_misc_eval(
        human_domain_rating=human_domain_rating,
        evaluator_confidence_rating=evaluator_conf_rating,
        evaluator_familiarity_level=evaluator_familiarity_level,
        notes=self.misc_notes.get(0.0, "end"),
    )
    return misc_eval