Skip to content

recommendation

sleap_nn.config_generator.tui.widgets.recommendation

Recommendation panel widget.

Displays pipeline and backbone recommendations based on dataset analysis.

Classes:

Name Description
DatasetStatsPanel

Widget displaying dataset statistics.
QuickSettingsPanel

Widget showing quick summary of current settings.
RecommendationPanel

Widget displaying pipeline recommendation.

DatasetStatsPanel

Bases: Static

Widget displaying dataset statistics.

Shows key statistics about the loaded SLP file including frame count, image dimensions, skeleton info, and instance counts.

Methods:

Name Description
__init__

Initialize with optional stats.
render

Render the stats panel.
update_stats

Update the displayed statistics.
Source code in sleap_nn/config_generator/tui/widgets/recommendation.py 
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
class DatasetStatsPanel(Static):
    """Widget displaying dataset statistics.

    Shows key statistics about the loaded SLP file including
    frame count, image dimensions, skeleton info, and instance counts.
    """

    DEFAULT_CSS = """
    DatasetStatsPanel {
        height: auto;
        padding: 1;
        border: solid $primary;
        margin-bottom: 1;
    }

    DatasetStatsPanel .stats-title {
        text-style: bold;
    }

    DatasetStatsPanel .stats-value {
        color: $primary;
        text-style: bold;
    }

    DatasetStatsPanel .stats-label {
        color: $text-muted;
    }
    """

    def __init__(self, stats=None, **kwargs):
        """Initialize with optional stats.

        Args:
            stats: DatasetStats object to display.
            **kwargs: Additional arguments passed to parent.
        """
        super().__init__(**kwargs)
        self._stats = stats

    def update_stats(self, stats) -> None:
        """Update the displayed statistics.

        Args:
            stats: New DatasetStats object.
        """
        self._stats = stats
        self.refresh()

    def render(self) -> str:
        """Render the stats panel."""
        if self._stats is None:
            return "Dataset Statistics\n" "──────────────────\n" "Loading..."

        stats = self._stats

        # Format channels
        channels = "Grayscale" if stats.is_grayscale else "RGB"

        # Format instances
        if stats.is_single_instance:
            instances = "Single instance"
        else:
            instances = f"Multi-instance (max {stats.max_instances_per_frame})"

        lines = [
            "Dataset Statistics",
            "──────────────────",
            "",
            f"  Frames:     {stats.num_labeled_frames}",
            f"  Videos:     {stats.num_videos}",
            f"  Size:       {stats.max_width} × {stats.max_height}",
            f"  Channels:   {channels}",
            "",
            f"  Skeleton:   {stats.num_nodes} nodes, {stats.num_edges} edges",
            f"  Instances:  {instances}",
            f"  Avg bbox:   {stats.avg_bbox_size:.0f}px",
        ]

        if stats.has_tracks:
            lines.append(f"  Tracks:     {stats.num_tracks}")

        return "\n".join(lines)

__init__(stats=None, **kwargs)

Initialize with optional stats.

Parameters:

Name Type Description Default
stats

DatasetStats object to display.

 None
**kwargs

Additional arguments passed to parent.

 {}
Source code in sleap_nn/config_generator/tui/widgets/recommendation.py 
130
131
132
133
134
135
136
137
138
def __init__(self, stats=None, **kwargs):
    """Initialize with optional stats.

    Args:
        stats: DatasetStats object to display.
        **kwargs: Additional arguments passed to parent.
    """
    super().__init__(**kwargs)
    self._stats = stats

render()

Render the stats panel.

Source code in sleap_nn/config_generator/tui/widgets/recommendation.py 
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
def render(self) -> str:
    """Render the stats panel."""
    if self._stats is None:
        return "Dataset Statistics\n" "──────────────────\n" "Loading..."

    stats = self._stats

    # Format channels
    channels = "Grayscale" if stats.is_grayscale else "RGB"

    # Format instances
    if stats.is_single_instance:
        instances = "Single instance"
    else:
        instances = f"Multi-instance (max {stats.max_instances_per_frame})"

    lines = [
        "Dataset Statistics",
        "──────────────────",
        "",
        f"  Frames:     {stats.num_labeled_frames}",
        f"  Videos:     {stats.num_videos}",
        f"  Size:       {stats.max_width} × {stats.max_height}",
        f"  Channels:   {channels}",
        "",
        f"  Skeleton:   {stats.num_nodes} nodes, {stats.num_edges} edges",
        f"  Instances:  {instances}",
        f"  Avg bbox:   {stats.avg_bbox_size:.0f}px",
    ]

    if stats.has_tracks:
        lines.append(f"  Tracks:     {stats.num_tracks}")

    return "\n".join(lines)

update_stats(stats)

Update the displayed statistics.

Parameters:

Name Type Description Default
stats

New DatasetStats object.

 required
Source code in sleap_nn/config_generator/tui/widgets/recommendation.py 
140
141
142
143
144
145
146
147
def update_stats(self, stats) -> None:
    """Update the displayed statistics.

    Args:
        stats: New DatasetStats object.
    """
    self._stats = stats
    self.refresh()

QuickSettingsPanel

Bases: Static

Widget showing quick summary of current settings.

Provides at-a-glance view of key configuration parameters.

Methods:

Name Description
__init__

Initialize the panel.
render

Render the quick settings panel.
update_settings

Update displayed settings.
Source code in sleap_nn/config_generator/tui/widgets/recommendation.py 
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
class QuickSettingsPanel(Static):
    """Widget showing quick summary of current settings.

    Provides at-a-glance view of key configuration parameters.
    """

    DEFAULT_CSS = """
    QuickSettingsPanel {
        height: auto;
        padding: 1;
        border: solid $surface-lighten-2;
        margin-bottom: 1;
    }

    QuickSettingsPanel .setting-highlight {
        color: $primary;
    }
    """

    def __init__(self, **kwargs):
        """Initialize the panel."""
        super().__init__(**kwargs)
        self._settings = {}

    def update_settings(
        self,
        pipeline: str = "",
        backbone: str = "",
        batch_size: int = 0,
        input_scale: float = 1.0,
        sigma: float = 5.0,
    ) -> None:
        """Update displayed settings.

        Args:
            pipeline: Pipeline type.
            backbone: Backbone architecture.
            batch_size: Batch size.
            input_scale: Input scaling factor.
            sigma: Confidence map sigma.
        """
        self._settings = {
            "pipeline": pipeline,
            "backbone": backbone,
            "batch_size": batch_size,
            "input_scale": input_scale,
            "sigma": sigma,
        }
        self.refresh()

    def render(self) -> str:
        """Render the quick settings panel."""
        if not self._settings:
            return "Current Settings\n" "────────────────\n" "Not configured"

        s = self._settings
        lines = [
            "Current Settings",
            "────────────────",
            f"  Pipeline:   {s['pipeline'] or '-'}",
            f"  Backbone:   {s['backbone'] or '-'}",
            f"  Batch size: {s['batch_size']}",
            f"  Scale:      {s['input_scale']:.2f}",
            f"  Sigma:      {s['sigma']:.1f}",
        ]

        return "\n".join(lines)

__init__(**kwargs)

Initialize the panel.

Source code in sleap_nn/config_generator/tui/widgets/recommendation.py 
204
205
206
207
def __init__(self, **kwargs):
    """Initialize the panel."""
    super().__init__(**kwargs)
    self._settings = {}

render()

Render the quick settings panel.

Source code in sleap_nn/config_generator/tui/widgets/recommendation.py 
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
def render(self) -> str:
    """Render the quick settings panel."""
    if not self._settings:
        return "Current Settings\n" "────────────────\n" "Not configured"

    s = self._settings
    lines = [
        "Current Settings",
        "────────────────",
        f"  Pipeline:   {s['pipeline'] or '-'}",
        f"  Backbone:   {s['backbone'] or '-'}",
        f"  Batch size: {s['batch_size']}",
        f"  Scale:      {s['input_scale']:.2f}",
        f"  Sigma:      {s['sigma']:.1f}",
    ]

    return "\n".join(lines)

update_settings(pipeline='', backbone='', batch_size=0, input_scale=1.0, sigma=5.0)

Update displayed settings.

Parameters:

Name Type Description Default
pipeline str

Pipeline type.

 ''
backbone str

Backbone architecture.

 ''
batch_size int

Batch size.

 0
input_scale float

Input scaling factor.

 1.0
sigma float

Confidence map sigma.

 5.0
Source code in sleap_nn/config_generator/tui/widgets/recommendation.py 
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
def update_settings(
    self,
    pipeline: str = "",
    backbone: str = "",
    batch_size: int = 0,
    input_scale: float = 1.0,
    sigma: float = 5.0,
) -> None:
    """Update displayed settings.

    Args:
        pipeline: Pipeline type.
        backbone: Backbone architecture.
        batch_size: Batch size.
        input_scale: Input scaling factor.
        sigma: Confidence map sigma.
    """
    self._settings = {
        "pipeline": pipeline,
        "backbone": backbone,
        "batch_size": batch_size,
        "input_scale": input_scale,
        "sigma": sigma,
    }
    self.refresh()

RecommendationPanel

Bases: Static

Widget displaying pipeline recommendation.

Shows the recommended pipeline type, backbone architecture, and any warnings or suggestions based on data analysis.

Methods:

Name Description
__init__

Initialize with optional recommendation.
render

Render the recommendation panel.
update_recommendation

Update the displayed recommendation.

Attributes:

Name Type Description
recommendation Optional[ConfigRecommendation]

Get the current recommendation.
Source code in sleap_nn/config_generator/tui/widgets/recommendation.py 
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
89
90
91
92
93
94
95
96
97
98
class RecommendationPanel(Static):
    """Widget displaying pipeline recommendation.

    Shows the recommended pipeline type, backbone architecture,
    and any warnings or suggestions based on data analysis.
    """

    DEFAULT_CSS = """
    RecommendationPanel {
        height: auto;
        padding: 1;
        border: solid $secondary;
        margin-bottom: 1;
    }

    RecommendationPanel .rec-title {
        text-style: bold;
    }

    RecommendationPanel .rec-pipeline {
        color: $success;
        text-style: bold;
    }

    RecommendationPanel .rec-backbone {
        color: $primary;
    }

    RecommendationPanel .rec-warning {
        color: $warning;
    }
    """

    def __init__(self, recommendation: Optional[ConfigRecommendation] = None, **kwargs):
        """Initialize with optional recommendation.

        Args:
            recommendation: Initial recommendation to display.
            **kwargs: Additional arguments passed to parent.
        """
        super().__init__(**kwargs)
        self._recommendation = recommendation

    def update_recommendation(self, rec: ConfigRecommendation) -> None:
        """Update the displayed recommendation.

        Args:
            rec: New recommendation to display.
        """
        self._recommendation = rec
        self.refresh()

    @property
    def recommendation(self) -> Optional[ConfigRecommendation]:
        """Get the current recommendation."""
        return self._recommendation

    def render(self) -> str:
        """Render the recommendation panel."""
        if self._recommendation is None:
            return "Recommendation\n" "──────────────\n" "Analyzing..."

        rec = self._recommendation
        lines = [
            "Recommendation",
            "──────────────",
            f"Pipeline: {rec.pipeline.recommended}",
            f"  {rec.pipeline.reason}",
            "",
            f"Backbone: {rec.backbone}",
            f"  {rec.backbone_reason}",
        ]

        if rec.pipeline.alternatives:
            lines.append("")
            lines.append("Alternatives:")
            for alt in rec.pipeline.alternatives[:2]:  # Show top 2 alternatives
                lines.append(f"  • {alt}")

        if rec.pipeline.warnings:
            lines.append("")
            lines.append("Warnings:")
            for w in rec.pipeline.warnings:
                lines.append(f"  ⚠ {w}")

        return "\n".join(lines)

recommendation property

Get the current recommendation.

__init__(recommendation=None, **kwargs)

Initialize with optional recommendation.

Parameters:

Name Type Description Default
recommendation Optional[ConfigRecommendation]

Initial recommendation to display.

 None
**kwargs

Additional arguments passed to parent.

 {}
Source code in sleap_nn/config_generator/tui/widgets/recommendation.py 
46
47
48
49
50
51
52
53
54
def __init__(self, recommendation: Optional[ConfigRecommendation] = None, **kwargs):
    """Initialize with optional recommendation.

    Args:
        recommendation: Initial recommendation to display.
        **kwargs: Additional arguments passed to parent.
    """
    super().__init__(**kwargs)
    self._recommendation = recommendation

render()

Render the recommendation panel.

Source code in sleap_nn/config_generator/tui/widgets/recommendation.py 
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
def render(self) -> str:
    """Render the recommendation panel."""
    if self._recommendation is None:
        return "Recommendation\n" "──────────────\n" "Analyzing..."

    rec = self._recommendation
    lines = [
        "Recommendation",
        "──────────────",
        f"Pipeline: {rec.pipeline.recommended}",
        f"  {rec.pipeline.reason}",
        "",
        f"Backbone: {rec.backbone}",
        f"  {rec.backbone_reason}",
    ]

    if rec.pipeline.alternatives:
        lines.append("")
        lines.append("Alternatives:")
        for alt in rec.pipeline.alternatives[:2]:  # Show top 2 alternatives
            lines.append(f"  • {alt}")

    if rec.pipeline.warnings:
        lines.append("")
        lines.append("Warnings:")
        for w in rec.pipeline.warnings:
            lines.append(f"  ⚠ {w}")

    return "\n".join(lines)

update_recommendation(rec)

Update the displayed recommendation.

Parameters:

Name Type Description Default
rec ConfigRecommendation

New recommendation to display.

 required
Source code in sleap_nn/config_generator/tui/widgets/recommendation.py 
56
57
58
59
60
61
62
63
def update_recommendation(self, rec: ConfigRecommendation) -> None:
    """Update the displayed recommendation.

    Args:
        rec: New recommendation to display.
    """
    self._recommendation = rec
    self.refresh()