Implement Vetting Workflow (#292)

* Allow Users to Submit Annotations (#281)

* Add settings for vetting

* Model submission status of recording annotations

* Add endpoint to get current user

* Show recording submission status in table view

* Don't filter out noise

The model can predict noise, so sorting it out of the species list can
lead to problems when loading/displaying that value in a list.

* Add endpoint to submit file-level annotations

* Allow submitting file annotations in interface

* Squash migrations

* Indicate when a file has been reviewed

* Format

* Show the current user's submitted label in sidebar

* Disable deletion for non-admin vetters

* Make 403 message more descriptive

* Vetting progress UI (#293)

* Add settings for vetting

* Model submission status of recording annotations

* Add endpoint to get current user

* Show recording submission status in table view

* Don't filter out noise

The model can predict noise, so sorting it out of the species list can
lead to problems when loading/displaying that value in a list.

* Add endpoint to submit file-level annotations

* Allow submitting file annotations in interface

* Squash migrations

* Indicate when a file has been reviewed

* Format

* Show the current user's submitted label in sidebar

* Disable deletion for non-admin vetters

* Make 403 message more descriptive

* Show progress bar for submitted recordings

* Enable showing/hiding submitted recordings

* Toggle submitted recordings in sidebar

* Fix submission bug

* Navigate through unreviewed files (#294)

* Add settings for vetting

* Model submission status of recording annotations

* Add endpoint to get current user

* Show recording submission status in table view

* Don't filter out noise

The model can predict noise, so sorting it out of the species list can
lead to problems when loading/displaying that value in a list.

* Add endpoint to submit file-level annotations

* Allow submitting file annotations in interface

* Squash migrations

* Indicate when a file has been reviewed

* Format

* Show the current user's submitted label in sidebar

* Disable deletion for non-admin vetters

* Make 403 message more descriptive

* Show progress bar for submitted recordings

* Enable showing/hiding submitted recordings

* Toggle submitted recordings in sidebar

* Fix submission bug

* Add button to go to next unreviewed file

* Add function to get next unreviewed recording

* Navigate between unreviewed files

* Display a message when there are no files to review

* Reset selected annotation when recording changes

* Show a user their submitted labels (#295)

* Show submission status and label in sidebar

* Show user submitted label in Recordings view

* Hide detailed metadata in vetting mode (#296)

* In vetting mode, hide detailed metadata fields

* Hide annotation summary in vetting mode

* Show GRTS cell bounding box for vetters

* Indicate pending submissions

* Update title for pulse annotation column

* Hide "my recordings" if non-admins can't upload (#298)

* Hide "my recordings" if non-admins can't upload

* Add missing semicolon

Co-authored-by: Bryon Lewis <61746913+BryonLewis@users.noreply.github.com>

* Hide progress bar for my recordings when needed

---------

Co-authored-by: Bryon Lewis <61746913+BryonLewis@users.noreply.github.com>

* Allow users to add reference materials (#297)

* Allow users to add reference materials

* Model vetting details per user

* Update vetting details from front end

* Use separate component for reference materials

* Add length check and test to API layer

* Swap position of close/save for consistency

* Use correct max length value for vuetify rule

Co-authored-by: Bryon Lewis <61746913+BryonLewis@users.noreply.github.com>

---------

Co-authored-by: Bryon Lewis <61746913+BryonLewis@users.noreply.github.com>

* Vetting workflow feedback (#301)

* Make return type compatable for column definition

* Add scale widget to location map

* Fix casing for kHz

* Fix scrolling in spectrogram sidebar

* Add tooltip to submission status

* Ensure configuration is loaded before column check

* Remove unused setting and remake migrations

* Use tooltip in shared list

---------

Co-authored-by: Bryon Lewis <61746913+BryonLewis@users.noreply.github.com>

Author: naglepuff

bats_ai/api.py

@@ -13,6 +13,7 @@
     RecordingRouter,
     RecordingTagRouter,
     SpeciesRouter,
+    VettingRouter,
 )
 from bats_ai.core.views.nabat import NABatConfigurationRouter, NABatRecordingRouter
 
@@ -46,3 +47,4 @@ def global_auth(request):
 api.add_router('/recording-tag/', RecordingTagRouter)
 api.add_router('/nabat/recording/', NABatRecordingRouter)
 api.add_router('/nabat/configuration/', NABatConfigurationRouter)
+api.add_router('/vetting/', VettingRouter)

bats_ai/core/admin/__init__.py

@@ -17,6 +17,7 @@
 from .species import SpeciesAdmin
 from .spectrogram import SpectrogramAdmin
 from .spectrogram_image import SpectrogramImageAdmin
+from .vetting_details import VettingDetailsAdmin
 
 __all__ = [
     'AnnotationsAdmin',
@@ -32,6 +33,7 @@
     'ConfigurationAdmin',
     'ExportedAnnotationFileAdmin',
     'SpectrogramImageAdmin',
+    'VettingDetailsAdmin',
     # NABat Models
     'NABatRecordingAnnotationAdmin',
     'NABatCompressedSpectrogramAdmin',

bats_ai/core/admin/recording_annotations.py

@@ -14,6 +14,7 @@ class RecordingAnnotationAdmin(admin.ModelAdmin):
         'additional_data',
         'comments',
         'model',
+        'submitted',
     ]
     list_select_related = True
     filter_horizontal = ('species',)  # or filter_vertical

bats_ai/core/admin/vetting_details.py

@@ -0,0 +1,13 @@
+from django.contrib import admin
+
+from bats_ai.core.models import VettingDetails
+
+
+@admin.register(VettingDetails)
+class VettingDetailsAdmin(admin.ModelAdmin):
+    list_display = [
+        'pk',
+        'user',
+        # 'reference_materials',
+    ]
+    search_fields = ('user',)

bats_ai/core/migrations/0025_configuration_mark_annotations_completed_enabled_and_more.py

@@ -0,0 +1,56 @@
+# Generated by Django 4.2.23 on 2026-01-15 18:06
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('core', '0024_delete_image'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='configuration',
+            name='mark_annotations_completed_enabled',
+            field=models.BooleanField(default=False),
+        ),
+        migrations.AddField(
+            model_name='configuration',
+            name='non_admin_upload_enabled',
+            field=models.BooleanField(default=True),
+        ),
+        migrations.AddField(
+            model_name='recordingannotation',
+            name='submitted',
+            field=models.BooleanField(default=False),
+        ),
+        migrations.CreateModel(
+            name='VettingDetails',
+            fields=[
+                (
+                    'id',
+                    models.BigAutoField(
+                        auto_created=True, primary_key=True, serialize=False, verbose_name='ID'
+                    ),
+                ),
+                ('reference_materials', models.TextField(blank=True)),
+                (
+                    'user',
+                    models.OneToOneField(
+                        on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL
+                    ),
+                ),
+            ],
+        ),
+        migrations.AddConstraint(
+            model_name='vettingdetails',
+            constraint=models.CheckConstraint(
+                check=models.Q(('reference_materials__length__lte', 2000)),
+                name='reference_materials_max_2000',
+            ),
+        ),
+    ]

bats_ai/core/models/__init__.py

@@ -11,6 +11,7 @@
 from .species import Species
 from .spectrogram import Spectrogram
 from .spectrogram_image import SpectrogramImage
+from .vetting_details import VettingDetails
 
 __all__ = [
     'Annotations',
@@ -28,4 +29,5 @@
     'ProcessingTaskType',
     'ExportedAnnotationFile',
     'SpectrogramImage',
+    'VettingDetails',
 ]

bats_ai/core/models/configuration.py

@@ -32,6 +32,10 @@ class AvailableColorScheme(models.TextChoices):
     # 18 characters is just enough for "rgb(255, 255, 255)"
     default_spectrogram_background_color = models.CharField(max_length=18, default='rgb(0, 0, 0)')
 
+    # Fields used for community vetting focused deployment of BatAI
+    non_admin_upload_enabled = models.BooleanField(default=True)
+    mark_annotations_completed_enabled = models.BooleanField(default=False)
+
     def save(self, *args, **kwargs):
         # Ensure only one instance of Configuration exists
         if not Configuration.objects.exists() and not self.pk:

bats_ai/core/models/recording_annotation.py

@@ -12,7 +12,8 @@ class RecordingAnnotation(TimeStampedModel, models.Model):
     owner = models.ForeignKey(User, on_delete=models.CASCADE)
     species = models.ManyToManyField(Species)
     comments = models.TextField(blank=True, null=True)
-    model = models.TextField(blank=True, null=True)  # AI Model information if inference used
+    # AI Model information if inference used, else "User Defined"
+    model = models.TextField(blank=True, null=True)
     confidence = models.FloatField(
         default=1.0,
         validators=[
@@ -24,3 +25,4 @@ class RecordingAnnotation(TimeStampedModel, models.Model):
     additional_data = models.JSONField(
         blank=True, null=True, help_text='Additional information about the models/data'
     )
+    submitted = models.BooleanField(default=False)

bats_ai/core/models/vetting_details.py

@@ -0,0 +1,20 @@
+from django.contrib.auth.models import User
+from django.db import models
+from django.db.models import Q
+from django.db.models.functions import Length
+
+models.TextField.register_lookup(Length, 'length')
+
+
+class VettingDetails(models.Model):
+    user = models.OneToOneField(User, on_delete=models.CASCADE)
+    reference_materials = models.TextField(blank=True)
+
+    class Meta:
+        constraints = [
+            models.CheckConstraint(
+                # TODO change to 'condition' in Django v6
+                check=Q(reference_materials__length__lte=2000),
+                name='reference_materials_max_2000',
+            )
+        ]

bats_ai/core/tests/conftest.py

@@ -2,7 +2,9 @@
 from django.test import Client
 import pytest
 
-from .factories import SuperuserFactory, UserFactory
+from bats_ai.core.models import VettingDetails
+
+from .factories import SuperuserFactory, UserFactory, VettingDetailsFactory
 
 
 @pytest.fixture
@@ -32,3 +34,13 @@ def authorized_client(superuser: User) -> Client:
     client = Client()
     client.force_login(user=superuser)
     return client
+
+
+@pytest.fixture
+def vetting_details(user: User) -> VettingDetails:
+    return VettingDetailsFactory(user=user)
+
+
+@pytest.fixture
+def random_user_vetting_details() -> VettingDetails:
+    return VettingDetailsFactory(user=UserFactory())