Skip to content

Reference Frame

ReferenceFrame

Bases: CTkFrame, EvaluationBaseFrame

Class for the reference evaluation frame.

Source code in evaluator/frontend/components/evaluation_frames/reference_frame.py 
 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
class ReferenceFrame(ctk.CTkFrame, EvaluationBaseFrame):
    """Class for the reference 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.reference_eval = self.run["eval_data"]["reference_eval"]

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

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

        self.ref_eval_label = ctk.CTkLabel(
            master=self,
            text="How relevant are the reference nodes?",
            font=(self.state["font"], 16, "bold"),
        )
        self.ref_eval_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.ref_eval_var = ctk.IntVar(
            value=self.reference_eval.get(
                "reference_relevancy", EVAL_DEFAULTS["reference_relevancy"]
            )
        )
        self.ref_eval_button = ctk.CTkSegmentedButton(
            master=self, values=[-1, 0, 1, 2], variable=self.ref_eval_var
        )
        self.ref_eval_button.grid(
            row=2,
            column=1,
            padx=(self.state["padding"] // 4, self.state["padding"]),
            pady=self.state["padding"] // 4,
        )

        self.top_ref_var = ctk.StringVar(
            value=reverse_cast_checkbox(
                self.reference_eval.get(
                    "top_reference_retrieval", EVAL_DEFAULTS["top_reference_retrieval"]
                )
            )
        )
        self.top_ref_checkbox = ctk.CTkCheckBox(
            master=self,
            text="Top reference is most relevant?",
            variable=self.top_ref_var,
            onvalue="on",
            offvalue="off",
        )
        self.top_ref_checkbox.grid(
            row=3,
            column=0,
            padx=self.state["padding"],
            pady=self.state["padding"] // 4,
            sticky="w",
        )

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

        self.ref_notes = ctk.CTkTextbox(
            master=self, wrap="word", font=(self.state["font"], 18)
        )
        self.ref_notes.grid(
            row=5,
            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 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.reference_eval = self.run["eval_data"]["reference_eval"]

        self.ref_eval_var = ctk.IntVar(
            value=self.reference_eval.get(
                "reference_relevancy", EVAL_DEFAULTS["reference_relevancy"]
            )
        )
        self.ref_eval_button.configure(variable=self.ref_eval_var)

        self.top_ref_var = ctk.StringVar(
            value=reverse_cast_checkbox(
                self.reference_eval.get(
                    "top_reference_retrieval", EVAL_DEFAULTS["top_reference_retrieval"]
                )
            )
        )
        self.top_ref_checkbox.configure(variable=self.top_ref_var)

        self.ref_notes.delete(0.0, "end")
        self.ref_notes.insert(
            0.0, self.reference_eval.get("notes", EVAL_DEFAULTS["notes"])
        )

    def get_results(self) -> RefereceEval:
        """Returns the reference evaluations.

        Returns
        -------
        ReferenceEval
            The reference evaluation results.
        """
        ref_eval_score = self.ref_eval_var.get()
        top_ref_val = self.top_ref_var.get()
        notes = self.ref_notes.get(0.0, "end")
        ref_eval = create_reference_eval(
            reference_relevancy=ref_eval_score,
            top_reference_retrieval=top_ref_val,
            notes=notes,
        )
        return ref_eval

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

Constructor.

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

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

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

    self.ref_eval_label = ctk.CTkLabel(
        master=self,
        text="How relevant are the reference nodes?",
        font=(self.state["font"], 16, "bold"),
    )
    self.ref_eval_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.ref_eval_var = ctk.IntVar(
        value=self.reference_eval.get(
            "reference_relevancy", EVAL_DEFAULTS["reference_relevancy"]
        )
    )
    self.ref_eval_button = ctk.CTkSegmentedButton(
        master=self, values=[-1, 0, 1, 2], variable=self.ref_eval_var
    )
    self.ref_eval_button.grid(
        row=2,
        column=1,
        padx=(self.state["padding"] // 4, self.state["padding"]),
        pady=self.state["padding"] // 4,
    )

    self.top_ref_var = ctk.StringVar(
        value=reverse_cast_checkbox(
            self.reference_eval.get(
                "top_reference_retrieval", EVAL_DEFAULTS["top_reference_retrieval"]
            )
        )
    )
    self.top_ref_checkbox = ctk.CTkCheckBox(
        master=self,
        text="Top reference is most relevant?",
        variable=self.top_ref_var,
        onvalue="on",
        offvalue="off",
    )
    self.top_ref_checkbox.grid(
        row=3,
        column=0,
        padx=self.state["padding"],
        pady=self.state["padding"] // 4,
        sticky="w",
    )

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

    self.ref_notes = ctk.CTkTextbox(
        master=self, wrap="word", font=(self.state["font"], 18)
    )
    self.ref_notes.grid(
        row=5,
        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 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/reference_frame.py 
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
def update_state(self, app_state: AppState, run_state: RunState) -> None:
    """Update the 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.reference_eval = self.run["eval_data"]["reference_eval"]

    self.ref_eval_var = ctk.IntVar(
        value=self.reference_eval.get(
            "reference_relevancy", EVAL_DEFAULTS["reference_relevancy"]
        )
    )
    self.ref_eval_button.configure(variable=self.ref_eval_var)

    self.top_ref_var = ctk.StringVar(
        value=reverse_cast_checkbox(
            self.reference_eval.get(
                "top_reference_retrieval", EVAL_DEFAULTS["top_reference_retrieval"]
            )
        )
    )
    self.top_ref_checkbox.configure(variable=self.top_ref_var)

    self.ref_notes.delete(0.0, "end")
    self.ref_notes.insert(
        0.0, self.reference_eval.get("notes", EVAL_DEFAULTS["notes"])
    )

get_results()

Returns the reference evaluations.

Returns:

Type Description
ReferenceEval

The reference evaluation results.
Source code in evaluator/frontend/components/evaluation_frames/reference_frame.py 
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
def get_results(self) -> RefereceEval:
    """Returns the reference evaluations.

    Returns
    -------
    ReferenceEval
        The reference evaluation results.
    """
    ref_eval_score = self.ref_eval_var.get()
    top_ref_val = self.top_ref_var.get()
    notes = self.ref_notes.get(0.0, "end")
    ref_eval = create_reference_eval(
        reference_relevancy=ref_eval_score,
        top_reference_retrieval=top_ref_val,
        notes=notes,
    )
    return ref_eval