Skip to content

App

App

Bases: CTk

Frontend for evaluating generated BCO domains from BcoRag.

Source code in evaluator/frontend/app.py 
10
11
12
13
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
class App(ctk.CTk):
    """Frontend for evaluating generated BCO domains from
    BcoRag.
    """

    def __init__(self):
        """Constructor."""
        super().__init__()
        init_data = app_start.initialization()

        self.attributes = init_data

        self.title("BCO RAG Evaluator")
        self.geometry(f"{1920}x{1080}")

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

        self.login_screen = LoginScreen(
            master=self,
            attributes=self.attributes,
            on_login=login,
            on_login_success=self._login_success,
            on_exit=misc.exit_app,
        )

    def start(self):
        """Start the app main loop."""
        self.mainloop()

    def navigate(
        self, direction: Literal[-1, 1], run_index: int, app_state: AppState
    ) -> None:
        """Callback to execute when the user presses
        the next or previous buttons.

        Parameters
        ----------
        direction : -1 or 1
            Indicates the direction the user is navigating,
            -1 for previous, 1 for next.
        run_index : int
            The new run index being navigated to.
        app_state : AppState
            The current app state.
        """
        self.app_state = app_state
        updated_run_state = state.load_run_state(
            run_index=run_index,
            total_runs=self.run["total_runs"],
            app_state=self.app_state,
        )
        self.view_page.update_state(
            app_state=self.app_state, run_state=updated_run_state
        )

    def _login_success(self, app_state: AppState) -> None:
        """Callback to execute on login success."""
        self.app_state = app_state
        self.login_screen.grid_forget()
        self.intermediate_screen = IntermediateScreen(
            master=self, on_start=self._on_start, app_state=self.app_state
        )

    def _on_start(self, app_state: AppState) -> None:
        """Callback to execute on evaluation start."""
        self.intermediate_screen.grid_forget()
        self.app_state = app_state
        # create init run state
        init_run_state = app_start.create_init_run_state(app_state)
        self.run = init_run_state
        self.view_page = ViewPage(
            master=self,
            app_state=self.app_state,
            run_state=init_run_state,
            navigate=self.navigate,
            on_save=state.save_state,
            on_exit=misc.exit_app,
        )

__init__()

Constructor.

Source code in evaluator/frontend/app.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
def __init__(self):
    """Constructor."""
    super().__init__()
    init_data = app_start.initialization()

    self.attributes = init_data

    self.title("BCO RAG Evaluator")
    self.geometry(f"{1920}x{1080}")

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

    self.login_screen = LoginScreen(
        master=self,
        attributes=self.attributes,
        on_login=login,
        on_login_success=self._login_success,
        on_exit=misc.exit_app,
    )

start()

Start the app main loop.

Source code in evaluator/frontend/app.py 
36
37
38
def start(self):
    """Start the app main loop."""
    self.mainloop()

navigate(direction, run_index, app_state)

Callback to execute when the user presses the next or previous buttons.

Parameters:

Name Type Description Default
direction -1 or 1

Indicates the direction the user is navigating, -1 for previous, 1 for next.

 required
run_index int

The new run index being navigated to.

 required
app_state AppState

The current app state.

 required
Source code in evaluator/frontend/app.py 
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
def navigate(
    self, direction: Literal[-1, 1], run_index: int, app_state: AppState
) -> None:
    """Callback to execute when the user presses
    the next or previous buttons.

    Parameters
    ----------
    direction : -1 or 1
        Indicates the direction the user is navigating,
        -1 for previous, 1 for next.
    run_index : int
        The new run index being navigated to.
    app_state : AppState
        The current app state.
    """
    self.app_state = app_state
    updated_run_state = state.load_run_state(
        run_index=run_index,
        total_runs=self.run["total_runs"],
        app_state=self.app_state,
    )
    self.view_page.update_state(
        app_state=self.app_state, run_state=updated_run_state
    )

_login_success(app_state)

Callback to execute on login success.

Source code in evaluator/frontend/app.py 
66
67
68
69
70
71
72
def _login_success(self, app_state: AppState) -> None:
    """Callback to execute on login success."""
    self.app_state = app_state
    self.login_screen.grid_forget()
    self.intermediate_screen = IntermediateScreen(
        master=self, on_start=self._on_start, app_state=self.app_state
    )

_on_start(app_state)

Callback to execute on evaluation start.

Source code in evaluator/frontend/app.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
def _on_start(self, app_state: AppState) -> None:
    """Callback to execute on evaluation start."""
    self.intermediate_screen.grid_forget()
    self.app_state = app_state
    # create init run state
    init_run_state = app_start.create_init_run_state(app_state)
    self.run = init_run_state
    self.view_page = ViewPage(
        master=self,
        app_state=self.app_state,
        run_state=init_run_state,
        navigate=self.navigate,
        on_save=state.save_state,
        on_exit=misc.exit_app,
    )