Skip to content

export_screen

sleap_nn.config_generator.tui.screens.export_screen

Export configuration screen.

Provides UI for previewing and exporting generated configurations.

Classes:

Name Description
ExportScreen

Export configuration screen component.
TopDownExportScreen

Specialized export screen for top-down pipelines.

ExportScreen

Bases: VerticalScroll

Export configuration screen component.

Provides: - YAML configuration preview - Dual config preview for top-down pipelines - Save to file functionality - Copy to clipboard - CLI command suggestions

Methods:

Name Description
__init__

Initialize the export screen.
compose

Compose the export screen layout.
handle_copy

Handle copy to clipboard button press.
handle_refresh

Handle refresh button press.
handle_save

Handle save button press.
on_mount

Initialize preview when mounted.
update_preview

Update the YAML preview displays.
Source code in sleap_nn/config_generator/tui/screens/export_screen.py 
 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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
class ExportScreen(VerticalScroll):
    """Export configuration screen component.

    Provides:
    - YAML configuration preview
    - Dual config preview for top-down pipelines
    - Save to file functionality
    - Copy to clipboard
    - CLI command suggestions
    """

    DEFAULT_CSS = """
    ExportScreen {
        width: 100%;
        height: 100%;
        padding: 1;
    }

    .section-title {
        text-style: bold;
        padding: 1 0;
    }

    .yaml-preview {
        height: 1fr;
        min-height: 20;
    }

    .button-row {
        height: auto;
        padding: 1;
        align: center middle;
    }

    .cli-box {
        height: auto;
        padding: 1;
        margin: 1 0;
        border: solid $surface-lighten-2;
        background: $surface;
    }

    .cli-command {
        color: $success;
    }

    .status-message {
        height: auto;
        padding: 1 0;
    }
    """

    def __init__(self, state: "ConfigState", **kwargs):
        """Initialize the export screen.

        Args:
            state: Shared configuration state.
            **kwargs: Additional arguments for Container.
        """
        super().__init__(**kwargs)
        self._state = state

    def compose(self) -> ComposeResult:
        """Compose the export screen layout."""
        yield Static("Configuration Preview", classes="section-title")

        # Show different preview based on pipeline type
        if self._state.is_topdown:
            yield from self._compose_dual_preview()
        else:
            yield from self._compose_single_preview()

        yield Rule()

        # Export Options
        yield from self._compose_export_options()

        yield Rule()

        # CLI Commands
        yield from self._compose_cli_section()

        # Status message
        yield Static("", id="export-status", classes="status-message")

    def _compose_single_preview(self) -> ComposeResult:
        """Compose single config preview."""
        yield TextArea(
            id="yaml-preview",
            read_only=True,
            language="yaml",
            classes="yaml-preview",
        )

    def _compose_dual_preview(self) -> ComposeResult:
        """Compose dual config preview for top-down pipelines."""
        yield InfoBox(
            "Top-down pipelines require two separate configs: one for the centroid model "
            "and one for the centered instance model.",
        )

        with TabbedContent(id="dual-preview-tabs"):
            with TabPane("Centroid Config", id="centroid-tab"):
                yield TextArea(
                    id="centroid-yaml-preview",
                    read_only=True,
                    language="yaml",
                    classes="yaml-preview",
                )

            with TabPane("Centered Instance Config", id="ci-tab"):
                yield TextArea(
                    id="ci-yaml-preview",
                    read_only=True,
                    language="yaml",
                    classes="yaml-preview",
                )

    def _compose_export_options(self) -> ComposeResult:
        """Compose export options section."""
        yield Static("Export Options", classes="section-title")

        # Output path
        with Horizontal(classes="form-row"):
            yield Static("Output Path:", classes="form-label")
            yield Input(
                value=str(self._get_default_output_path()),
                id="output-path-input",
            )

        # Buttons
        with Horizontal(classes="button-row"):
            yield Button("Refresh Preview", id="refresh-btn")
            yield Button("Save to File", id="save-btn", variant="primary")
            yield Button("Copy to Clipboard", id="copy-btn")

    def _compose_cli_section(self) -> ComposeResult:
        """Compose CLI command suggestions section."""
        yield Static("CLI Commands", classes="section-title")

        yield InfoBox(
            "After saving your config, use these commands to train and run inference:",
        )

        # Training command
        output_path = self._get_default_output_path()
        with Container(classes="cli-box"):
            yield Static("Train the model:", classes="subsection-title")
            if self._state.is_topdown:
                yield Static(
                    f"# Step 1: Train centroid model\n"
                    f"sleap-nn train --config {output_path.stem}_centroid.yaml\n\n"
                    f"# Step 2: Train centered instance model\n"
                    f"sleap-nn train --config {output_path.stem}_centered_instance.yaml",
                    id="train-command",
                    classes="cli-command",
                )
            else:
                yield Static(
                    f"sleap-nn train --config {output_path}",
                    id="train-command",
                    classes="cli-command",
                )

        # Inference command
        with Container(classes="cli-box"):
            yield Static("Run inference:", classes="subsection-title")
            if self._state.is_topdown:
                yield Static(
                    "sleap-nn predict \\\n"
                    "  --model-paths centroid_model.ckpt centered_instance_model.ckpt \\\n"
                    "  --video-path your_video.mp4 \\\n"
                    "  --output-path predictions.slp",
                    id="predict-command",
                    classes="cli-command",
                )
            else:
                yield Static(
                    "sleap-nn predict \\\n"
                    "  --model-paths your_model.ckpt \\\n"
                    "  --video-path your_video.mp4 \\\n"
                    "  --output-path predictions.slp",
                    id="predict-command",
                    classes="cli-command",
                )

    def _get_default_output_path(self) -> Path:
        """Get the default output path for the config file."""
        return self._state.slp_path.parent / f"{self._state.slp_path.stem}_config.yaml"

    def update_preview(self) -> None:
        """Update the YAML preview displays."""
        try:
            if self._state.is_topdown:
                # Update dual previews
                try:
                    centroid_preview = self.query_one(
                        "#centroid-yaml-preview", TextArea
                    )
                    centroid_preview.text = self._state.to_centroid_yaml()
                except Exception:
                    pass

                try:
                    ci_preview = self.query_one("#ci-yaml-preview", TextArea)
                    ci_preview.text = self._state.to_centered_instance_yaml()
                except Exception:
                    pass
            else:
                # Update single preview
                try:
                    preview = self.query_one("#yaml-preview", TextArea)
                    preview.text = self._state.to_yaml()
                except Exception:
                    pass
        except Exception as e:
            self._show_status(f"Error generating preview: {e}", error=True)

    def _show_status(
        self, message: str, error: bool = False, success: bool = False
    ) -> None:
        """Show a status message.

        Args:
            message: Message to display.
            error: Whether this is an error message.
            success: Whether this is a success message.
        """
        try:
            status = self.query_one("#export-status", Static)
            if error:
                status.update(f"[red]Error: {message}[/red]")
            elif success:
                status.update(f"[green]✓ {message}[/green]")
            else:
                status.update(message)
        except Exception:
            pass

    @on(Button.Pressed, "#refresh-btn")
    def handle_refresh(self) -> None:
        """Handle refresh button press."""
        self.update_preview()
        self._show_status("Preview refreshed", success=True)

    @on(Button.Pressed, "#save-btn")
    def handle_save(self) -> None:
        """Handle save button press."""
        try:
            output_path = self.query_one("#output-path-input", Input).value

            if self._state.is_topdown:
                # Save dual configs
                base_path = output_path.replace(".yaml", "").replace("_config", "")
                centroid_path, ci_path = self._state.save_dual(base_path)
                self._show_status(
                    f"Saved: {centroid_path} and {ci_path}",
                    success=True,
                )
            else:
                # Save single config
                self._state.save(output_path)
                self._show_status(f"Saved to: {output_path}", success=True)

        except Exception as e:
            self._show_status(str(e), error=True)

    @on(Button.Pressed, "#copy-btn")
    def handle_copy(self) -> None:
        """Handle copy to clipboard button press."""
        try:
            if self._state.is_topdown:
                # Copy both configs
                yaml_str = (
                    "# ============== CENTROID CONFIG ==============\n"
                    + self._state.to_centroid_yaml()
                    + "\n\n# ============== CENTERED INSTANCE CONFIG ==============\n"
                    + self._state.to_centered_instance_yaml()
                )
            else:
                yaml_str = self._state.to_yaml()

            # Try to copy to clipboard
            try:
                import pyperclip

                pyperclip.copy(yaml_str)
                self._show_status("Copied to clipboard!", success=True)
            except ImportError:
                self._show_status(
                    "Install pyperclip for clipboard support: pip install pyperclip",
                    error=True,
                )
        except Exception as e:
            self._show_status(str(e), error=True)

    def on_mount(self) -> None:
        """Initialize preview when mounted."""
        self.update_preview()

__init__(state, **kwargs)

Initialize the export screen.

Parameters:

Name Type Description Default
state ConfigState

Shared configuration state.

 required
**kwargs

Additional arguments for Container.

 {}
Source code in sleap_nn/config_generator/tui/screens/export_screen.py 
82
83
84
85
86
87
88
89
90
def __init__(self, state: "ConfigState", **kwargs):
    """Initialize the export screen.

    Args:
        state: Shared configuration state.
        **kwargs: Additional arguments for Container.
    """
    super().__init__(**kwargs)
    self._state = state

compose()

Compose the export screen layout.

Source code in sleap_nn/config_generator/tui/screens/export_screen.py 
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
def compose(self) -> ComposeResult:
    """Compose the export screen layout."""
    yield Static("Configuration Preview", classes="section-title")

    # Show different preview based on pipeline type
    if self._state.is_topdown:
        yield from self._compose_dual_preview()
    else:
        yield from self._compose_single_preview()

    yield Rule()

    # Export Options
    yield from self._compose_export_options()

    yield Rule()

    # CLI Commands
    yield from self._compose_cli_section()

    # Status message
    yield Static("", id="export-status", classes="status-message")

handle_copy()

Handle copy to clipboard button press.

Source code in sleap_nn/config_generator/tui/screens/export_screen.py 
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
@on(Button.Pressed, "#copy-btn")
def handle_copy(self) -> None:
    """Handle copy to clipboard button press."""
    try:
        if self._state.is_topdown:
            # Copy both configs
            yaml_str = (
                "# ============== CENTROID CONFIG ==============\n"
                + self._state.to_centroid_yaml()
                + "\n\n# ============== CENTERED INSTANCE CONFIG ==============\n"
                + self._state.to_centered_instance_yaml()
            )
        else:
            yaml_str = self._state.to_yaml()

        # Try to copy to clipboard
        try:
            import pyperclip

            pyperclip.copy(yaml_str)
            self._show_status("Copied to clipboard!", success=True)
        except ImportError:
            self._show_status(
                "Install pyperclip for clipboard support: pip install pyperclip",
                error=True,
            )
    except Exception as e:
        self._show_status(str(e), error=True)

handle_refresh()

Handle refresh button press.

Source code in sleap_nn/config_generator/tui/screens/export_screen.py 
269
270
271
272
273
@on(Button.Pressed, "#refresh-btn")
def handle_refresh(self) -> None:
    """Handle refresh button press."""
    self.update_preview()
    self._show_status("Preview refreshed", success=True)

handle_save()

Handle save button press.

Source code in sleap_nn/config_generator/tui/screens/export_screen.py 
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
@on(Button.Pressed, "#save-btn")
def handle_save(self) -> None:
    """Handle save button press."""
    try:
        output_path = self.query_one("#output-path-input", Input).value

        if self._state.is_topdown:
            # Save dual configs
            base_path = output_path.replace(".yaml", "").replace("_config", "")
            centroid_path, ci_path = self._state.save_dual(base_path)
            self._show_status(
                f"Saved: {centroid_path} and {ci_path}",
                success=True,
            )
        else:
            # Save single config
            self._state.save(output_path)
            self._show_status(f"Saved to: {output_path}", success=True)

    except Exception as e:
        self._show_status(str(e), error=True)

on_mount()

Initialize preview when mounted.

Source code in sleap_nn/config_generator/tui/screens/export_screen.py 
326
327
328
def on_mount(self) -> None:
    """Initialize preview when mounted."""
    self.update_preview()

update_preview()

Update the YAML preview displays.

Source code in sleap_nn/config_generator/tui/screens/export_screen.py 
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
def update_preview(self) -> None:
    """Update the YAML preview displays."""
    try:
        if self._state.is_topdown:
            # Update dual previews
            try:
                centroid_preview = self.query_one(
                    "#centroid-yaml-preview", TextArea
                )
                centroid_preview.text = self._state.to_centroid_yaml()
            except Exception:
                pass

            try:
                ci_preview = self.query_one("#ci-yaml-preview", TextArea)
                ci_preview.text = self._state.to_centered_instance_yaml()
            except Exception:
                pass
        else:
            # Update single preview
            try:
                preview = self.query_one("#yaml-preview", TextArea)
                preview.text = self._state.to_yaml()
            except Exception:
                pass
    except Exception as e:
        self._show_status(f"Error generating preview: {e}", error=True)

TopDownExportScreen

Bases: Container

Specialized export screen for top-down pipelines.

Shows side-by-side configuration for centroid and centered instance models.

Methods:

Name Description
__init__

Initialize the top-down export screen.
compose

Compose the top-down export screen layout.
handle_refresh

Handle refresh button press.
handle_save

Handle save button press.
on_mount

Initialize previews on mount.
update_preview

Update both preview panes.
Source code in sleap_nn/config_generator/tui/screens/export_screen.py 
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
class TopDownExportScreen(Container):
    """Specialized export screen for top-down pipelines.

    Shows side-by-side configuration for centroid and centered instance models.
    """

    DEFAULT_CSS = """
    TopDownExportScreen {
        height: 100%;
        padding: 0;
    }

    TopDownExportScreen .dual-preview {
        height: 1fr;
        layout: horizontal;
    }

    TopDownExportScreen .preview-pane {
        width: 1fr;
        height: 100%;
        padding: 0 1;
    }

    TopDownExportScreen .preview-title {
        text-style: bold;
        padding: 1 0;
        text-align: center;
    }
    """

    def __init__(self, state: "ConfigState", **kwargs):
        """Initialize the top-down export screen.

        Args:
            state: Shared configuration state.
            **kwargs: Additional arguments for Container.
        """
        super().__init__(**kwargs)
        self._state = state

    def compose(self) -> ComposeResult:
        """Compose the top-down export screen layout."""
        with Container(classes="dual-preview"):
            # Centroid config
            with Container(classes="preview-pane"):
                yield Static("Centroid Model Config", classes="preview-title")
                yield TextArea(
                    id="td-centroid-preview",
                    read_only=True,
                    language="yaml",
                )

            # Centered instance config
            with Container(classes="preview-pane"):
                yield Static("Centered Instance Model Config", classes="preview-title")
                yield TextArea(
                    id="td-ci-preview",
                    read_only=True,
                    language="yaml",
                )

        with Horizontal(classes="button-row"):
            yield Button("Refresh", id="td-refresh-btn")
            yield Button("Save Both", id="td-save-btn", variant="primary")

        yield Static("", id="td-export-status")

    def update_preview(self) -> None:
        """Update both preview panes."""
        try:
            self.query_one("#td-centroid-preview", TextArea).text = (
                self._state.to_centroid_yaml()
            )
            self.query_one("#td-ci-preview", TextArea).text = (
                self._state.to_centered_instance_yaml()
            )
        except Exception:
            pass

    @on(Button.Pressed, "#td-refresh-btn")
    def handle_refresh(self) -> None:
        """Handle refresh button press."""
        self.update_preview()

    @on(Button.Pressed, "#td-save-btn")
    def handle_save(self) -> None:
        """Handle save button press."""
        try:
            base_path = str(self._state.slp_path.parent / self._state.slp_path.stem)
            centroid_path, ci_path = self._state.save_dual(base_path)

            status = self.query_one("#td-export-status", Static)
            status.update(f"[green]✓ Saved: {centroid_path}, {ci_path}[/green]")
        except Exception as e:
            status = self.query_one("#td-export-status", Static)
            status.update(f"[red]Error: {e}[/red]")

    def on_mount(self) -> None:
        """Initialize previews on mount."""
        self.update_preview()

__init__(state, **kwargs)

Initialize the top-down export screen.

Parameters:

Name Type Description Default
state ConfigState

Shared configuration state.

 required
**kwargs

Additional arguments for Container.

 {}
Source code in sleap_nn/config_generator/tui/screens/export_screen.py 
361
362
363
364
365
366
367
368
369
def __init__(self, state: "ConfigState", **kwargs):
    """Initialize the top-down export screen.

    Args:
        state: Shared configuration state.
        **kwargs: Additional arguments for Container.
    """
    super().__init__(**kwargs)
    self._state = state

compose()

Compose the top-down export screen layout.

Source code in sleap_nn/config_generator/tui/screens/export_screen.py 
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
def compose(self) -> ComposeResult:
    """Compose the top-down export screen layout."""
    with Container(classes="dual-preview"):
        # Centroid config
        with Container(classes="preview-pane"):
            yield Static("Centroid Model Config", classes="preview-title")
            yield TextArea(
                id="td-centroid-preview",
                read_only=True,
                language="yaml",
            )

        # Centered instance config
        with Container(classes="preview-pane"):
            yield Static("Centered Instance Model Config", classes="preview-title")
            yield TextArea(
                id="td-ci-preview",
                read_only=True,
                language="yaml",
            )

    with Horizontal(classes="button-row"):
        yield Button("Refresh", id="td-refresh-btn")
        yield Button("Save Both", id="td-save-btn", variant="primary")

    yield Static("", id="td-export-status")

handle_refresh()

Handle refresh button press.

Source code in sleap_nn/config_generator/tui/screens/export_screen.py 
410
411
412
413
@on(Button.Pressed, "#td-refresh-btn")
def handle_refresh(self) -> None:
    """Handle refresh button press."""
    self.update_preview()

handle_save()

Handle save button press.

Source code in sleap_nn/config_generator/tui/screens/export_screen.py 
415
416
417
418
419
420
421
422
423
424
425
426
@on(Button.Pressed, "#td-save-btn")
def handle_save(self) -> None:
    """Handle save button press."""
    try:
        base_path = str(self._state.slp_path.parent / self._state.slp_path.stem)
        centroid_path, ci_path = self._state.save_dual(base_path)

        status = self.query_one("#td-export-status", Static)
        status.update(f"[green]✓ Saved: {centroid_path}, {ci_path}[/green]")
    except Exception as e:
        status = self.query_one("#td-export-status", Static)
        status.update(f"[red]Error: {e}[/red]")

on_mount()

Initialize previews on mount.

Source code in sleap_nn/config_generator/tui/screens/export_screen.py 
428
429
430
def on_mount(self) -> None:
    """Initialize previews on mount."""
    self.update_preview()

update_preview()

Update both preview panes.

Source code in sleap_nn/config_generator/tui/screens/export_screen.py 
398
399
400
401
402
403
404
405
406
407
408
def update_preview(self) -> None:
    """Update both preview panes."""
    try:
        self.query_one("#td-centroid-preview", TextArea).text = (
            self._state.to_centroid_yaml()
        )
        self.query_one("#td-ci-preview", TextArea).text = (
            self._state.to_centered_instance_yaml()
        )
    except Exception:
        pass