rapidata 0.1.23__py3-none-any.whl → 0.1.25__py3-none-any.whl

rapidata/rapidata_client/dataset/rapidata_validation_set.py

@@ -1,3 +1,4 @@
+import os
 from typing import Any
 from rapidata.api_client.models.add_validation_rapid_model import (
     AddValidationRapidModel,
@@ -29,6 +30,7 @@ from rapidata.api_client.models.polygon_payload import PolygonPayload
 from rapidata.api_client.models.polygon_truth import PolygonTruth
 from rapidata.api_client.models.transcription_payload import TranscriptionPayload
 from rapidata.api_client.models.transcription_truth import TranscriptionTruth
+from rapidata.api_client.models.transcription_word import TranscriptionWord
 from rapidata.rapidata_client.metadata.base_metadata import Metadata
 from rapidata.service.openapi_service import OpenAPIService
 
@@ -43,7 +45,7 @@ class RapidataValidationSet:
         self.id = validation_set_id
         self.openapi_service = openapi_service
 
-    def add_validation_rapid(
+    def add_general_validation_rapid(
         self,
         payload: (
             BoundingBoxPayload
@@ -70,15 +72,18 @@ class RapidataValidationSet:
         metadata: list[Metadata],
         media_paths: str | list[str],
         randomCorrectProbability: float,
-    ):
+    ) -> None:
         """Add a validation rapid to the validation set.
 
         Args:
-            payload (BoundingBoxPayload | ClassifyPayload | ComparePayload | FreeTextPayload | LinePayload | LocatePayload | NamedEntityPayload | PolygonPayload | TranscriptionPayload): The payload for the rapid.
-            truths (AttachCategoryTruth | BoundingBoxTruth | CompareTruth | EmptyValidationTruth | LineTruth | LocateBoxTruth | NamedEntityTruth | PolygonTruth | TranscriptionTruth): The truths for the rapid.
+            payload (Union[BoundingBoxPayload, ClassifyPayload, ComparePayload, FreeTextPayload, LinePayload, LocatePayload, NamedEntityPayload, PolygonPayload, TranscriptionPayload]): The payload for the rapid.
+            truths (Union[AttachCategoryTruth, BoundingBoxTruth, CompareTruth, EmptyValidationTruth, LineTruth, LocateBoxTruth, NamedEntityTruth, PolygonTruth, TranscriptionTruth]): The truths for the rapid.
             metadata (list[Metadata]): The metadata for the rapid.
-            media_paths (str | list[str]): The media paths for the rapid.
+            media_paths (Union[str, list[str]]): The media paths for the rapid.
             randomCorrectProbability (float): The random correct probability for the rapid.
+
+        Returns:
+            None
         """
         model = AddValidationRapidModel(
             validationSetId=self.id,
@@ -94,3 +99,137 @@ class RapidataValidationSet:
         self.openapi_service.validation_api.validation_add_validation_rapid_post(
             model=model, files=media_paths if isinstance(media_paths, list) else [media_paths]  # type: ignore
         )
+
+    def add_classify_validation_rapid(
+        self,
+        media_path: str,
+        question: str,
+        categories: list[str],
+        truths: list[str],
+        metadata: list[Metadata] = [],
+    ) -> None:
+        """Add a classify rapid to the validation set.
+
+        Args:
+            media_path (str): The path to the media file.
+            question (str): The question for the rapid.
+            categories (list[str]): The list of categories for the rapid.
+            truths (list[str]): The list of truths for the rapid.
+            metadata (list[Metadata], optional): The metadata for the rapid. Defaults to an empty list.
+
+        Returns:
+            None
+        """
+        payload = ClassifyPayload(
+            _t="ClassifyPayload", possibleCategories=categories, title=question
+        )
+        model_truth = AttachCategoryTruth(
+            correctCategories=truths, _t="AttachCategoryTruth"
+        )
+
+        self.add_general_validation_rapid(
+            payload=payload,
+            truths=model_truth,
+            metadata=metadata,
+            media_paths=media_path,
+            randomCorrectProbability=len(truths) / len(categories),
+        )
+
+    def add_compare_validation_rapid(
+        self,
+        media_paths: list[str],
+        question: str,
+        truth: str,
+        metadata: list[Metadata] = [],
+    ) -> None:
+        """Add a compare rapid to the validation set.
+
+        Args:
+            media_paths (list[str]): The list of media paths for the rapid.
+            question (str): The question for the rapid.
+            truth (str): The path to the truth file.
+            metadata (list[Metadata], optional): The metadata for the rapid. Defaults to an empty list.
+
+        Returns:
+            None
+
+        Raises:
+            ValueError: If the number of media paths is not exactly two.
+            FileNotFoundError: If any of the specified files are not found.
+        """
+        payload = ComparePayload(_t="ComparePayload", criteria=question)
+        # take only last part of truth path
+        truth = os.path.basename(truth)
+        model_truth = CompareTruth(_t="CompareTruth", winnerId=truth)
+
+        if len(media_paths) != 2:
+            raise ValueError("Compare rapid requires exactly two media paths")
+
+        # check that files exist
+        for media_path in media_paths:
+            if not os.path.exists(media_path):
+                raise FileNotFoundError(f"File not found: {media_path}")
+
+        self.add_general_validation_rapid(
+            payload=payload,
+            truths=model_truth,
+            metadata=metadata,
+            media_paths=media_paths,
+            randomCorrectProbability=1 / len(media_paths),
+        )
+
+    def add_transcription_validation_rapid(
+        self,
+        media_path: str,
+        question: str,
+        transcription: list[str],
+        correct_words: list[str],
+        strict_grading: bool | None = None,
+        metadata: list[Metadata] = [],
+    ) -> None:
+        """Add a transcription rapid to the validation set.
+
+        Args:
+            media_path (str): The path to the media file.
+            question (str): The question for the rapid.
+            transcription (list[str]): The transcription for the rapid.
+            correct_words (list[str]): The list of correct words for the rapid.
+            strict_grading (Optional[bool], optional): The strict grading for the rapid. Defaults to None.
+            metadata (list[Metadata], optional): The metadata for the rapid. Defaults to an empty list.
+
+        Returns:
+            None
+
+        Raises:
+            ValueError: If a correct word is not found in the transcription.
+        """
+        transcription_words = [
+            TranscriptionWord(word=word, wordIndex=i)
+            for i, word in enumerate(transcription)
+        ]
+
+        correct_transcription_words = []
+        for word in correct_words:
+            if word not in transcription:
+                raise ValueError(f"Correct word '{word}' not found in transcription")
+            correct_transcription_words.append(
+                TranscriptionWord(word=word, wordIndex=transcription.index(word))
+            )
+
+        payload = TranscriptionPayload(
+            _t="TranscriptionPayload", title=question, transcription=transcription_words
+        )
+
+        model_truth = TranscriptionTruth(
+            _t="TranscriptionTruth",
+            correctWords=correct_transcription_words,
+            strictGrading=strict_grading,
+        )
+
+        self.add_general_validation_rapid(
+            payload=payload,
+            truths=model_truth,
+            metadata=metadata,
+            media_paths=media_path,
+            randomCorrectProbability=len(correct_words) / len(transcription),
+        )

rapidata/rapidata_client/dataset/validation_set_builder.py

@@ -48,7 +48,7 @@ class ValidationSetBuilder:
         )
 
         for rapid_part in self._rapid_parts:
-            validation_set.add_validation_rapid(
+            validation_set.add_general_validation_rapid(
                 payload=rapid_part.payload,
                 truths=rapid_part.truths,
                 metadata=rapid_part.metadata,

rapidata/rapidata_client/feature_flags/feature_flags.py

@@ -22,18 +22,31 @@ class FeatureFlags:
             list[FeatureFlagModel]: A list of FeatureFlagModel objects
                 representing the current feature flags.
         """
-        return [FeatureFlagModel(key=name, value=value) for name, value in self._flags.items()]
+        return [
+            FeatureFlagModel(key=name, value=value)
+            for name, value in self._flags.items()
+        ]
 
-    def alert_on_fast_response(self, value: int):
+    def alert_on_fast_response(self, milliseconds: int):
         """Gives an alert as a pop up on the UI when the response time is less than the threshold.
 
         Args:
-            value (int): The threshold value for fast response alerts.
+            milliseconds (int): if the user responds in less than this time, an alert will be shown.
 
         Returns:
             FeatureFlags: The current FeatureFlags instance for method chaining.
         """
-        self._flags["alert_on_fast_response"] = str(value)
+        if milliseconds < 10:
+            print(
+                f"Warning: Are you sure you want to set the threshold so low ({milliseconds} milliseconds)?"
+            )
+
+        if milliseconds > 30000:
+            print(
+                f"Warning: Are you sure you want to set the threshold so high ({milliseconds/1000} seconds)?"
+            )
+
+        self._flags["alert_on_fast_response"] = str(milliseconds)
         return self
 
     def disable_translation(self, value: bool = True):

{rapidata-0.1.23.dist-info → rapidata-0.1.25.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rapidata
-Version: 0.1.23
+Version: 0.1.25
 Summary: Rapidata package containing the Rapidata Python Client to interact with the Rapidata Web API in an easy way.
 License: Apache-2.0
 Author: Rapidata AG

{rapidata-0.1.23.dist-info → rapidata-0.1.25.dist-info}/RECORD

@@ -223,11 +223,11 @@ rapidata/rapidata_client/country_codes/__init__.py,sha256=Y8qeG2IMjvMGvhaPydq0nh
 rapidata/rapidata_client/country_codes/country_codes.py,sha256=Q0HMX7uHJQDeLCFPP5bq4iYi6pgcDWEcl2ONGhjgoeU,286
 rapidata/rapidata_client/dataset/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rapidata/rapidata_client/dataset/rapidata_dataset.py,sha256=J5jlSIbdswhqXHOq8Qf9gtzVF70cImq9sioDG7S9Mxs,2457
-rapidata/rapidata_client/dataset/rapidata_validation_set.py,sha256=oQUtAF9ouLWg9AXkHXlnbEsPb8w9zxeKTw2YbSIk3ic,4475
+rapidata/rapidata_client/dataset/rapidata_validation_set.py,sha256=YrnUzia9AXgq2z917FtztFxj4fD5EgTWXVPBzLVIujY,9374
 rapidata/rapidata_client/dataset/validation_rapid_parts.py,sha256=SIeQesEXPPOW5kclxYLNWaKllBXHm7DQKBdMU-GXnfc,2104
-rapidata/rapidata_client/dataset/validation_set_builder.py,sha256=_g7acP7lqYMI_5U9q1T6YHuUQ1ZDfZbLJ-QoqsGME4o,7463
+rapidata/rapidata_client/dataset/validation_set_builder.py,sha256=B9D-uNCo_PO0NCUHju_7dsWtz_KcOmvFIsxUgQ67Q2M,7471
 rapidata/rapidata_client/feature_flags/__init__.py,sha256=BNG_NQ4CrrC61fAWliImr8r581pIvegrkepVVbxcBw8,55
-rapidata/rapidata_client/feature_flags/feature_flags.py,sha256=uQrLuH8X5XqBHARMiw6HsIdZuCtSgBAgtTHrNxljkSs,3529
+rapidata/rapidata_client/feature_flags/feature_flags.py,sha256=hcS9YRzpsPWpZfw-3QwSuf2TaVg-MOHBxY788oNqIW4,3957
 rapidata/rapidata_client/metadata/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rapidata/rapidata_client/metadata/base_metadata.py,sha256=BJoZT4lRs94lu7PE3__LcsMINHNDVKRKRART-EKzSaw,217
 rapidata/rapidata_client/metadata/private_text_metadata.py,sha256=VJ_SJwp8OMFZLuUMRWvPeKOySXYJuGr-YgpwuLfTbmo,517
@@ -259,7 +259,7 @@ rapidata/service/local_file_service.py,sha256=pgorvlWcx52Uh3cEG6VrdMK_t__7dacQ_5
 rapidata/service/openapi_service.py,sha256=-vrM2jEzQxr9KAerOYkVhpvMEeHwjzRwm9L_VFyzOT0,1537
 rapidata/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rapidata/utils/image_utils.py,sha256=TldO3eJWG8IhfJjm5MfNGO0mEDm1mQTsRoA0HLU1Uxs,404
-rapidata-0.1.23.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-rapidata-0.1.23.dist-info/METADATA,sha256=KwJViXo2Zd925MIu9HXnXhJr9aNfHXHiLzrUfZENBww,924
-rapidata-0.1.23.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-rapidata-0.1.23.dist-info/RECORD,,
+rapidata-0.1.25.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+rapidata-0.1.25.dist-info/METADATA,sha256=bWrZHRwA8LYarK3LDoP4wLlV4vlDYqMsiuIXemQ6C-s,924
+rapidata-0.1.25.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+rapidata-0.1.25.dist-info/RECORD,,