feat(validate_image): add validate image project & tutorial creation

Author: tnagorra

mapswipe_workers/mapswipe_workers/definitions.py

@@ -137,6 +137,7 @@ class ProjectType(Enum):
     MEDIA_CLASSIFICATION = 5
     DIGITIZATION = 6
     STREET = 7
+    VALIDATE_IMAGE = 10
 
     @property
     def constructor(self):
@@ -149,6 +150,7 @@ def constructor(self):
             FootprintProject,
             MediaClassificationProject,
             StreetProject,
+            ValidateImageProject,
         )
 
         project_type_classes = {
@@ -159,6 +161,7 @@ def constructor(self):
             5: MediaClassificationProject,
             6: DigitizationProject,
             7: StreetProject,
+            10: ValidateImageProject,
         }
         return project_type_classes[self.value]
 
@@ -171,6 +174,7 @@ def tutorial(self):
             CompletenessTutorial,
             FootprintTutorial,
             StreetTutorial,
+            ValidateImageTutorial,
         )
 
         project_type_classes = {
@@ -179,5 +183,6 @@ def tutorial(self):
             3: ChangeDetectionTutorial,
             4: CompletenessTutorial,
             7: StreetTutorial,
+            10: ValidateImageTutorial,
         }
         return project_type_classes[self.value]

mapswipe_workers/mapswipe_workers/firebase/firebase.py

@@ -14,6 +14,7 @@ def save_project_to_firebase(self, project):
         # if a geometry exists in projects we want to delete it.
         # This geometry is not used in clients.
         project.pop("geometry", None)
+        # FIXME: We might need to pop images
         # save project
         self.ref.update({f"v2/projects/{project['projectId']}": project})
         logger.info(
@@ -82,6 +83,7 @@ def save_tutorial_to_firebase(
         tutorialDict.pop("raw_tasks", None)
         tutorialDict.pop("examplesFile", None)
         tutorialDict.pop("tutorial_tasks", None)
+        tutorialDict.pop("images", None)
 
         if not tutorial.projectId or tutorial.projectId == "":
             raise CustomError(

mapswipe_workers/mapswipe_workers/project_types/__init__.py

@@ -1,6 +1,8 @@
 from .arbitrary_geometry.digitization.project import DigitizationProject
 from .arbitrary_geometry.footprint.project import FootprintProject
 from .arbitrary_geometry.footprint.tutorial import FootprintTutorial
+from .validate_image.project import ValidateImageProject
+from .validate_image.tutorial import ValidateImageTutorial
 from .media_classification.project import MediaClassificationProject
 from .street.project import StreetProject
 from .street.tutorial import StreetTutorial
@@ -21,6 +23,8 @@
     "MediaClassificationProject",
     "FootprintProject",
     "FootprintTutorial",
+    "ValidateImageProject",
+    "ValidateImageTutorial",
     "DigitizationProject",
     "StreetProject",
     "StreetTutorial",

mapswipe_workers/mapswipe_workers/project_types/validate_image/__init__.py

@@ -0,0 +1,111 @@
+from mapswipe_workers.definitions import logger
+import math
+from typing import Dict, List
+from dataclasses import dataclass
+from mapswipe_workers.firebase.firebase import Firebase
+from mapswipe_workers.firebase_to_postgres.transfer_results import (
+    results_to_file,
+    save_results_to_postgres,
+    truncate_temp_results,
+)
+from mapswipe_workers.project_types.project import BaseGroup, BaseProject
+from mapswipe_workers.generate_stats.project_stats import (
+    get_statistics_for_integer_result_project,
+)
+
+
+@dataclass
+class ValidateImageGroup(BaseGroup):
+    pass
+
+
+@dataclass
+class ValidateImageTask:
+    # TODO(tnagorra): We need to check if fileName should be saved on project
+    # NOTE: We do not need to add projectId and groupId so we are not extending BaseTask
+
+    # NOTE: taskId is the sourceIdentifier
+    taskId: str
+
+    fileName: str
+    url: str
+
+    # NOTE: This is not required but required by the base class
+    geometry: str
+
+
+class ValidateImageProject(BaseProject):
+    def __init__(self, project_draft):
+        super().__init__(project_draft)
+        self.groups: Dict[str, ValidateImageGroup] = {}
+        self.tasks: Dict[str, List[ValidateImageTask]] = (
+            {}
+        )  # dict keys are group ids
+
+        # NOTE: This is a standard structure defined on manager dashboard.
+        # It's derived from other formats like COCO.
+        # The transfromation is done in manager dashboard.
+        self.images = project_draft["images"]
+
+    def save_tasks_to_firebase(self, projectId: str, tasks: dict):
+        firebase = Firebase()
+        firebase.save_tasks_to_firebase(projectId, tasks, useCompression=False)
+
+    @staticmethod
+    def results_to_postgres(results: dict, project_id: str, filter_mode: bool):
+        """How to move the result data from firebase to postgres."""
+        results_file, user_group_results_file = results_to_file(results, project_id)
+        truncate_temp_results()
+        save_results_to_postgres(results_file, project_id, filter_mode)
+        return user_group_results_file
+
+    @staticmethod
+    def get_per_project_statistics(project_id, project_info):
+        """How to aggregate the project results."""
+        return get_statistics_for_integer_result_project(
+            project_id, project_info, generate_hot_tm_geometries=False
+        )
+
+    def validate_geometries(self):
+        pass
+
+    def save_to_files(self, project):
+        """We do not have any geometry so we pass here"""
+        pass
+
+    def create_groups(self):
+        self.numberOfGroups = math.ceil(len(self.images) / self.groupSize)
+        for group_index in range(self.numberOfGroups):
+            self.groups[f"g{group_index + 100}"] = ValidateImageGroup(
+                projectId=self.projectId,
+                groupId=f"g{group_index + 100}",
+                progress=0,
+                finishedCount=0,
+                requiredCount=0,
+                numberOfTasks=self.groupSize,
+            )
+        logger.info(
+            f"{self.projectId} - create_groups - created groups dictionary"
+        )
+
+    def create_tasks(self):
+        if len(self.groups) == 0:
+            raise ValueError("Groups needs to be created before tasks can be created.")
+        for group_id, group in self.groups.items():
+            self.tasks[group_id] = []
+            for i in range(self.groupSize):
+                # FIXME: We should try not to mutate values
+                image_metadata = self.images.pop()
+                task = ValidateImageTask(
+                    taskId=image_metadata["sourceIdentifier"],
+                    fileName=image_metadata["fileName"],
+                    url=image_metadata["url"],
+                    geometry="",
+                )
+                self.tasks[group_id].append(task)
+
+                # list now empty? if usual group size is not reached
+                # the actual number of tasks for the group is updated
+                if not self.images:
+                    group.numberOfTasks = i + 1
+                    break

mapswipe_workers/mapswipe_workers/project_types/validate_image/project.py

@@ -0,0 +1,77 @@
+from dataclasses import dataclass
+
+from mapswipe_workers.definitions import logger
+from mapswipe_workers.firebase.firebase import Firebase
+from mapswipe_workers.project_types.validate_image.project import ValidateImageGroup, ValidateImageTask
+from mapswipe_workers.project_types.tutorial import BaseTutorial
+
+
+@dataclass
+class ValidateImageTutorialTask(ValidateImageTask):
+    # TODO(tnagorra): Check if we need projectId and groupId in tutorial task
+    projectId: str
+    groupId: str
+    referenceAnswer: int
+    screen: int
+
+
+class ValidateImageTutorial(BaseTutorial):
+
+    def __init__(self, tutorial_draft):
+        # this will create the basis attributes
+        super().__init__(tutorial_draft)
+
+        self.groups = dict()
+        self.tasks = dict()
+        self.images = tutorial_draft["images"]
+
+    def create_tutorial_groups(self):
+        """Create group for the tutorial based on provided examples in images."""
+
+        # NOTE: The groupId must be a numeric 101. It's hardcoded in save_tutorial_to_firebase
+        group = ValidateImageGroup(
+            groupId=101,
+            projectId=self.projectId,
+            numberOfTasks=len(self.images),
+            progress=0,
+            finishedCount=0,
+            requiredCount=0,
+        )
+        self.groups[101] = group
+
+        logger.info(
+            f"{self.projectId} - create_tutorial_groups - created groups dictionary"
+        )
+
+    def create_tutorial_tasks(self):
+        """Create the tasks dict based on provided examples in geojson file."""
+        task_list = []
+        for image_metadata in self.images:
+            image_metadata = ValidateImageTutorialTask(
+                projectId=self.projectId,
+                groupId=101,
+                taskId=image_metadata["sourceIdentifier"],
+                fileName=image_metadata["fileName"],
+                url=image_metadata["url"],
+                geometry="",
+                referenceAnswer=image_metadata["referenceAnswer"],
+                screen=image_metadata["screen"],
+            )
+            task_list.append(image_metadata)
+
+        if task_list:
+            self.tasks[101] = task_list
+        else:
+            logger.info(f"group in project {self.projectId} is not valid.")
+
+        logger.info(
+            f"{self.projectId} - create_tutorial_tasks - created tasks dictionary"
+        )
+
+    def save_tutorial(self):
+        firebase = Firebase()
+        firebase.save_tutorial_to_firebase(
+            self, self.groups, self.tasks, useCompression=False
+        )
+        logger.info(self.tutorialDraftId)
+        firebase.drop_tutorial_draft(self.tutorialDraftId)