feat(Aplose): Rename "tag" to "label" [ADEV-63]

backend/api/admin/__init__.py

@@ -10,8 +10,8 @@
 from backend.api.models import (
     Dataset,
     DatasetFile,
-    AnnotationSet,
-    AnnotationTag,
+    LabelSet,
+    Label,
     AnnotationCampaign,
     AnnotationTask,
     AnnotationComment,
@@ -59,7 +59,7 @@ class NewItemsForm(forms.ModelForm):
 
 
 class ConfidenceIndicatorAdmin(admin.ModelAdmin):
-    """ConfidenceIndicatorAdmin presentation in DjangoAdmin"""
+    """ConfidenceIndicator presentation in DjangoAdmin"""
 
     list_display = (
         "id",
@@ -152,28 +152,28 @@ class DatasetFileAdmin(admin.ModelAdmin):
     )
 
 
-class AnnotationTagAdmin(admin.ModelAdmin):
-    """AnnotationTag presentation in DjangoAdmin"""
+class LabelAdmin(admin.ModelAdmin):
+    """Label presentation in DjangoAdmin"""
 
     list_display = ["name"]
 
 
-class AnnotationSetAdmin(admin.ModelAdmin):
-    """AnnotationSet presentation in DjangoAdmin"""
+class LabelSetAdmin(admin.ModelAdmin):
+    """LabelSet presentation in DjangoAdmin"""
 
     list_display = (
         "name",
         "desc",
-        "show_tags",
+        "show_labels",
     )
 
-    def show_tags(self, obj):
-        """show_tags"""
-        return get_many_to_many(obj, "tags", "name")
+    def show_labels(self, obj):
+        """show_labels"""
+        return get_many_to_many(obj, "labels", "name")
 
 
 class AnnotationCommentAdmin(admin.ModelAdmin):
-    """AnnotationSet presentation in DjangoAdmin"""
+    """AnnotationComment presentation in DjangoAdmin"""
 
     list_display = (
         "id",
@@ -191,7 +191,7 @@ class AnnotationCampaignAdmin(admin.ModelAdmin):
         "instructions_url",
         "start",
         "end",
-        "annotation_set",
+        "label_set",
         "annotation_scope",
         "owner",
         "show_spectro_configs",
@@ -334,8 +334,8 @@ class SpectroConfigAdmin(admin.ModelAdmin):
 admin.site.register(DatasetType, DatasetTypeAdmin)
 admin.site.register(Dataset, DatasetAdmin)
 admin.site.register(DatasetFile, DatasetFileAdmin)
-admin.site.register(AnnotationTag, AnnotationTagAdmin)
-admin.site.register(AnnotationSet, AnnotationSetAdmin)
+admin.site.register(Label, LabelAdmin)
+admin.site.register(LabelSet, LabelSetAdmin)
 admin.site.register(AnnotationCampaign, AnnotationCampaignAdmin)
 admin.site.register(AnnotationComment, AnnotationCommentAdmin)
 admin.site.register(AnnotationTask, AnnotationTaskAdmin)

backend/api/admin/annotation/result.py

@@ -11,15 +11,15 @@ class AnnotationResultAdmin(admin.ModelAdmin):
         "end_time",
         "start_frequency",
         "end_frequency",
-        "annotation_tag",
+        "label",
         "confidence_indicator",
         "annotation_campaign",
         "dataset_file",
         "annotator",
         "detector_configuration",
     )
     search_fields = (
-        "annotation_tag__name",
+        "label__name",
         "confidence_indicator__label",
         "annotator__username",
         "annotator__first_name",

backend/api/management/commands/seed.py

@@ -13,7 +13,7 @@
     GeoMetadatum,
     AudioMetadatum,
     Dataset,
-    AnnotationSet,
+    LabelSet,
     AnnotationCampaign,
     WindowType,
     ConfidenceIndicator,
@@ -65,7 +65,7 @@ def handle(self, *args, **options):
         self._create_users()
         self._create_metadata()
         self._create_datasets()
-        self._create_annotation_sets()
+        self._create_label_sets()
         self._create_confidence_sets()
         self._create_annotation_campaigns()
         self._create_annotation_results()
@@ -195,33 +195,33 @@ def _create_datasets(self):
         DatasetFile.objects.bulk_create(files)
         SpectroConfig.objects.bulk_create(configs)
 
-    def _create_annotation_sets(self):
-        print(" ###### _create_annotation_sets ######")
+    def _create_label_sets(self):
+        print(" ###### _create_label_set ######")
         sets = [
             {
                 "name": "Test SPM campaign",
-                "desc": "Annotation set made for Test SPM campaign",
-                "tags": ["Mysticetes", "Odoncetes", "Boat", "Rain", "Other"],
+                "desc": "Label set made for Test SPM campaign",
+                "labels": ["Mysticetes", "Odoncetes", "Boat", "Rain", "Other"],
             },
             {
                 "name": "Test DCLDE LF campaign",
-                "desc": "Test annotation set DCLDE LF 2015",
-                "tags": ["Dcall", "40-Hz"],
+                "desc": "Test label set DCLDE LF 2015",
+                "labels": ["Dcall", "40-Hz"],
             },
             {
-                "name": "Big tag set",
-                "desc": "Test annotation set with lots of tags",
-                "tags": set([self.fake.color_name() for _ in range(0, 20)]),
+                "name": "Big label set",
+                "desc": "Test label set with lots of labels",
+                "labels": set([self.fake.color_name() for _ in range(0, 20)]),
             },
         ]
-        self.annotation_sets = []
+        self.label_sets = []
         for seed_set in sets:
-            annotation_set = AnnotationSet.objects.create(
+            label_set = LabelSet.objects.create(
                 name=seed_set["name"], desc=seed_set["desc"]
             )
-            for tag in seed_set["tags"]:
-                annotation_set.tags.create(name=tag)
-            self.annotation_sets.append(annotation_set)
+            for label in seed_set["labels"]:
+                label_set.labels.create(name=label)
+            self.label_sets.append(label_set)
 
     def _create_confidence_sets(self):
         self.confidence_indicator_set = ConfidenceIndicatorSet.objects.create(
@@ -254,7 +254,7 @@ def _create_annotation_campaigns(self):
                 end=timezone.make_aware(datetime.strptime("2010-11-02", "%Y-%m-%d")),
                 instructions_url=self.fake.uri(),
                 annotation_scope=2,
-                annotation_set=AnnotationSet.objects.first(),
+                label_set=LabelSet.objects.first(),
                 confidence_indicator_set=ConfidenceIndicatorSet.objects.first(),
                 owner=self.admin,
             )
@@ -277,7 +277,7 @@ def _create_annotation_campaigns(self):
     def _create_annotation_results(self):
         print(" ###### _create_annotation_results ######")
         campaign = self.campaigns[0]
-        tags = self.annotation_sets[0].tags.values_list("id", flat=True)
+        labels = self.label_sets[0].labels.values_list("id", flat=True)
         for user in self.users:
             done_files = randint(5, max(self.files_nb - 5, 5))
             tasks = campaign.tasks.filter(annotator_id=user.id)[:done_files]
@@ -296,7 +296,7 @@ def _create_annotation_results(self):
                         end_time=start_time + randint(30, 300),
                         start_frequency=start_frequency,
                         end_frequency=start_frequency + randint(2000, 5000),
-                        annotation_tag_id=choice(tags),
+                        label_id=choice(labels),
                         confidence_indicator=choice(self.confidences_indicators),
                         dataset_file_id=task.dataset_file_id,
                         annotator_id=task.annotator_id,
@@ -313,7 +313,7 @@ def _create_comments(self):
             if randint(1, 3) >= 2:
                 comments.append(
                     AnnotationComment(
-                        comment=f"a comment : {result.annotation_tag.name}",
+                        comment=f"a comment : {result.label.name}",
                         annotation_task=AnnotationTask.objects.filter(
                             annotation_campaign_id=result.annotation_campaign_id,
                             dataset_file_id=result.dataset_file_id,

backend/api/migrations/0035_rename_tag_label.py

@@ -0,0 +1,32 @@
+# Generated by Django 3.2.23 on 2024-04-03 12:11
+""" Linked to ADEV-63 ticket"""
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("api", "0034_alter_annotationresult_dataset_file"),
+    ]
+
+    operations = [
+        migrations.RenameModel(
+            old_name="AnnotationTag",
+            new_name="Label",
+        ),
+        migrations.AlterModelTable(
+            name="label",
+            table=None,
+        ),
+        migrations.RenameField(
+            model_name="annotationresult",
+            old_name="annotation_tag",
+            new_name="label",
+        ),
+        migrations.RenameField(
+            model_name="annotationset",
+            old_name="tags",
+            new_name="labels",
+        ),
+    ]

backend/api/migrations/0036_rename_annotationset_labelset.py

@@ -0,0 +1,26 @@
+# Generated by Django 3.2.23 on 2024-04-03 14:25
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("api", "0035_rename_tag_label"),
+    ]
+
+    operations = [
+        migrations.RenameModel(
+            old_name="AnnotationSet",
+            new_name="LabelSet",
+        ),
+        migrations.RenameField(
+            model_name="annotationcampaign",
+            old_name="annotation_set",
+            new_name="label_set",
+        ),
+        migrations.AlterModelTable(
+            name="labelset",
+            table=None,
+        ),
+    ]

backend/api/models/__init__.py

@@ -1,30 +1,35 @@
 """All Django models available"""
 
-from django.contrib.auth import get_user_model
-
-from backend.api.models.datasets import DatasetType, Dataset, DatasetFile
-from backend.api.models.metadata import (
-    AudioMetadatum,
-    GeoMetadatum,
-    SpectroConfig,
-    WindowType,
+from backend.api.models.annotation import (
+    Detector,
+    DetectorConfiguration,
+    AnnotationResult,
+    AnnotationResultValidation,
 )
+
 from backend.api.models.annotations import (
-    ConfidenceIndicator,
-    ConfidenceIndicatorSet,
-    AnnotationTag,
-    AnnotationSet,
     AnnotationCampaign,
+    AnnotationCampaignUsage,
     AnnotationComment,
     AnnotationSession,
     AnnotationTask,
-    AnnotationCampaignUsage,
+    ConfidenceIndicator,
+    ConfidenceIndicatorSet,
+    Label,
+    LabelSet,
 )
-from backend.api.models.annotation import (
-    Detector,
-    DetectorConfiguration,
-    AnnotationResult,
-    AnnotationResultValidation,
+
+from backend.api.models.datasets import (
+    DatasetType,
+    Dataset,
+    DatasetFile,
+)
+
+from backend.api.models.metadata import (
+    AudioMetadatum,
+    GeoMetadatum,
+    SpectroConfig,
+    WindowType,
 )
 
 from .user import User

backend/api/models/annotation/result.py

@@ -8,7 +8,7 @@
 
 class AnnotationResult(models.Model):
     """
-    This table contains the resulting tag associations for specific annotation_tasks
+    This table contains the resulting label associations for specific annotation_tasks
     """
 
     class Meta:
@@ -32,7 +32,7 @@ class Meta:
     start_frequency = models.FloatField(null=True, blank=True)
     end_frequency = models.FloatField(null=True, blank=True)
 
-    annotation_tag = models.ForeignKey("AnnotationTag", on_delete=models.CASCADE)
+    label = models.ForeignKey("Label", on_delete=models.CASCADE)
     confidence_indicator = models.ForeignKey(
         "ConfidenceIndicator", on_delete=models.SET_NULL, null=True, blank=True
     )
@@ -66,7 +66,7 @@ class Meta:
 
 class AnnotationResultValidation(models.Model):
     """
-    This table contains the resulting tag associations for specific annotation_tasks
+    This table contains the resulting label associations for specific annotation_tasks
     """
 
     is_valid = models.BooleanField(null=True, blank=True)