Merge pull request doccano#1206 from doccano/feature/auto-labeling

[Feature] Auto Labeling Implementation

Author: Hironsan

Pipfile

@@ -43,6 +43,7 @@ pyexcel-xlsx = "*"
 lockfile = "*"
 gunicorn = "*"
 fasteners = "*"
+auto-labeling-pipeline = "*"
 
 [requires]
 python_version = "3.8"

Pipfile.lock

@@ -1,5 +1,5 @@
 from rest_framework import status
-from rest_framework.exceptions import APIException
+from rest_framework.exceptions import APIException, PermissionDenied, ValidationError
 
 
 class FileParseException(APIException):
@@ -10,3 +10,26 @@ class FileParseException(APIException):
     def __init__(self, line_num, line, code=None):
         detail = self.default_detail.format(line_num, line)
         super().__init__(detail, code)
+
+
+class AutoLabelingException(APIException):
+    status_code = status.HTTP_400_BAD_REQUEST
+    default_detail = 'Auto labeling not allowed for the document with labels.'
+
+
+class AutoLabeliingPermissionDenied(PermissionDenied):
+    default_detail = 'You do not have permission to perform auto labeling.' \
+                     'Please ask the project administrators to add you.'
+
+
+class URLConnectionError(ValidationError):
+    default_detail = 'Failed to establish a connection. Please check the URL or network.'
+
+
+class AWSTokenError(ValidationError):
+    default_detail = 'The security token included in the request is invalid.'
+
+
+class SampleDataException(ValidationError):
+    default_detail = 'The response is empty. Maybe the sample data is not appropriate.' \
+                     'Please specify another sample data which returns at least one label.'

app/api/exceptions.py

@@ -0,0 +1,33 @@
+# Generated by Django 3.1.5 on 2021-02-01 06:03
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0004_merge_20210114_1117'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='label',
+            name='suffix_key',
+            field=models.CharField(blank=True, choices=[('0', '0'), ('1', '1'), ('2', '2'), ('3', '3'), ('4', '4'), ('5', '5'), ('6', '6'), ('7', '7'), ('8', '8'), ('9', '9'), ('a', 'a'), ('b', 'b'), ('c', 'c'), ('d', 'd'), ('e', 'e'), ('f', 'f'), ('g', 'g'), ('h', 'h'), ('i', 'i'), ('j', 'j'), ('k', 'k'), ('l', 'l'), ('m', 'm'), ('n', 'n'), ('o', 'o'), ('p', 'p'), ('q', 'q'), ('r', 'r'), ('s', 's'), ('t', 't'), ('u', 'u'), ('v', 'v'), ('w', 'w'), ('x', 'x'), ('y', 'y'), ('z', 'z')], max_length=1, null=True),
+        ),
+        migrations.CreateModel(
+            name='AutoLabelingConfig',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('model_name', models.CharField(max_length=100)),
+                ('model_attrs', models.JSONField(default=dict)),
+                ('template', models.TextField(default='')),
+                ('label_mapping', models.JSONField(default=dict)),
+                ('default', models.BooleanField(default=False)),
+                ('created_at', models.DateTimeField(auto_now_add=True)),
+                ('updated_at', models.DateTimeField(auto_now=True)),
+                ('project', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='auto_labeling_config', to='api.project')),
+            ],
+        ),
+    ]

app/api/migrations/0005_auto_20210201_0603.py

@@ -1,5 +1,6 @@
 import string
 
+from auto_labeling_pipeline.models import RequestModelFactory
 from django.db import models
 from django.dispatch import receiver
 from django.db.models.signals import post_save, pre_delete
@@ -343,3 +344,26 @@ def delete_linked_project(sender, instance, using, **kwargs):
         project = Project.objects.get(pk=projectInstance.pk)
         user.projects.remove(project)
         user.save()
+
+
+class AutoLabelingConfig(models.Model):
+    model_name = models.CharField(max_length=100)
+    model_attrs = models.JSONField(default=dict)
+    template = models.TextField(default='')
+    label_mapping = models.JSONField(default=dict)
+    project = models.ForeignKey(Project, related_name='auto_labeling_config', on_delete=models.CASCADE)
+    default = models.BooleanField(default=False)
+    created_at = models.DateTimeField(auto_now_add=True)
+    updated_at = models.DateTimeField(auto_now=True)
+
+    def __str__(self):
+        return self.model_name
+
+    def clean_fields(self, exclude=None):
+        super().clean_fields(exclude=exclude)
+        try:
+            RequestModelFactory.find(self.model_name)
+        except NameError:
+            raise ValidationError(f'The specified model name {self.model_name} does not exist.')
+        except Exception:
+            raise ValidationError('The attributes does not match the model.')

app/api/models.py

@@ -1,3 +1,4 @@
+from auto_labeling_pipeline.models import RequestModelFactory
 from django.conf import settings
 from django.contrib.auth import get_user_model
 from django.shortcuts import get_object_or_404
@@ -6,7 +7,7 @@
 from rest_framework.exceptions import ValidationError
 
 
-from .models import Label, Project, Document, RoleMapping, Role, Comment
+from .models import Label, Project, Document, RoleMapping, Role, Comment, AutoLabelingConfig
 from .models import TextClassificationProject, SequenceLabelingProject, Seq2seqProject, Speech2textProject
 from .models import DocumentAnnotation, SequenceAnnotation, Seq2seqAnnotation, Speech2textAnnotation
 
@@ -241,3 +242,37 @@ def get_rolename(cls, instance):
     class Meta:
         model = RoleMapping
         fields = ('id', 'user', 'role', 'username', 'rolename')
+
+
+class AutoLabelingConfigSerializer(serializers.ModelSerializer):
+
+    class Meta:
+        model = AutoLabelingConfig
+        fields = ('id', 'model_name', 'model_attrs', 'template', 'label_mapping', 'default')
+        read_only_fields = ('created_at', 'updated_at')
+
+    def validate_model_name(self, value):
+        try:
+            RequestModelFactory.find(value)
+        except NameError:
+            raise serializers.ValidationError(f'The specified model name {value} does not exist.')
+        return value
+
+    def valid_label_mapping(self, value):
+        if isinstance(value, dict):
+            return value
+        else:
+            raise serializers.ValidationError(f'The {value} is not a dictionary. Please specify it as a dictionary.')
+
+    def validate(self, data):
+        try:
+            RequestModelFactory.create(data['model_name'], data['model_attrs'])
+        except Exception:
+            model = RequestModelFactory.find(data['model_name'])
+            schema = model.schema()
+            required_fields = ', '.join(schema['required']) if 'required' in schema else ''
+            raise serializers.ValidationError(
+                'The attributes does not match the model.'
+                'You need to correctly specify the required fields: {}'.format(required_fields)
+            )
+        return data

app/api/serializers.py

@@ -11,6 +11,9 @@
 from .views import TextUploadAPI, TextDownloadAPI, CloudUploadAPI
 from .views import StatisticsAPI
 from .views import RoleMappingList, RoleMappingDetail, Roles
+from .views import AutoLabelingTemplateListAPI, AutoLabelingTemplateDetailAPI
+from .views import AutoLabelingConfigList, AutoLabelingConfigDetail, AutoLabelingConfigTest, AutoLabelingAnnotation
+from .views import AutoLabelingConfigParameterTest, AutoLabelingTemplateTest, AutoLabelingMappingTest
 
 urlpatterns = [
     path('health', Health.as_view(), name='health'),
@@ -52,6 +55,51 @@
          RoleMappingList.as_view(), name='rolemapping_list'),
     path('projects/<int:project_id>/roles/<int:rolemapping_id>',
          RoleMappingDetail.as_view(), name='rolemapping_detail'),
+    path(
+        route='projects/<int:project_id>/auto-labeling-templates',
+        view=AutoLabelingTemplateListAPI.as_view(),
+        name='auto_labeling_templates'
+    ),
+    path(
+        route='projects/<int:project_id>/auto-labeling-templates/<str:option_name>',
+        view=AutoLabelingTemplateDetailAPI.as_view(),
+        name='auto_labeling_template'
+    ),
+    path(
+        route='projects/<int:project_id>/auto-labeling-configs',
+        view=AutoLabelingConfigList.as_view(),
+        name='auto_labeling_configs'
+    ),
+    path(
+        route='projects/<int:project_id>/auto-labeling-configs/<int:config_id>',
+        view=AutoLabelingConfigDetail.as_view(),
+        name='auto_labeling_config'
+    ),
+    path(
+        route='projects/<int:project_id>/auto-labeling-config-testing',
+        view=AutoLabelingConfigTest.as_view(),
+        name='auto_labeling_config_test'
+    ),
+    path(
+        route='projects/<int:project_id>/docs/<int:doc_id>/auto-labeling',
+        view=AutoLabelingAnnotation.as_view(),
+        name='auto_labeling_annotation'
+    ),
+    path(
+        route='auto-labeling-parameter-testing',
+        view=AutoLabelingConfigParameterTest.as_view(),
+        name='auto_labeling_parameter_testing'
+    ),
+    path(
+        route='projects/<int:project_id>/auto-labeling-template-testing',
+        view=AutoLabelingTemplateTest.as_view(),
+        name='auto_labeling_template_test'
+    ),
+    path(
+        route='projects/<int:project_id>/auto-labeling-mapping-testing',
+        view=AutoLabelingMappingTest.as_view(),
+        name='auto_labeling_mapping_test'
+    )
 ]
 
 # urlpatterns = format_suffix_patterns(urlpatterns, allowed=['json', 'xml'])