rapidata 1.8.3__py3-none-any.whl → 2.44.4__py3-none-any.whl

rapidata/rapidata_client/dataset/validation_set_builder.py

@@ -1,324 +0,0 @@
-import os
-from rapidata.api_client.models.attach_category_truth import AttachCategoryTruth
-from rapidata.api_client.models.classify_payload import ClassifyPayload
-from rapidata.api_client.models.compare_payload import ComparePayload
-from rapidata.api_client.models.compare_truth import CompareTruth
-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.assets.media_asset import MediaAsset
-from rapidata.rapidata_client.assets.multi_asset import MultiAsset
-from rapidata.rapidata_client.assets.text_asset import TextAsset
-from rapidata.rapidata_client.dataset.rapidata_validation_set import (
-    RapidataValidationSet,
-)
-from rapidata.rapidata_client.dataset.validation_rapid_parts import ValidatioRapidParts
-from rapidata.rapidata_client.metadata.base_metadata import Metadata
-from rapidata.service.openapi_service import OpenAPIService
-
-from rapidata.rapidata_client.dataset.rapid_builders.rapids import (
-    Rapid, 
-    ClassificationRapid,
-    CompareRapid,
-    TranscriptionRapid
-)
-from deprecated import deprecated
-
-
-class ValidationSetBuilder:
-    """The ValidationSetBuilder is used to build a validation set.
-    Give the validation set a name and then add classify, compare, or transcription rapid parts to it.
-    Get a `ValidationSetBuilder` by calling [`rapi.new_validation_set()`](../rapidata_client.md/#rapidata.rapidata_client.rapidata_client.RapidataClient.new_validation_set).
-    """
-
-    def __init__(self, name: str, openapi_service: OpenAPIService):
-        """
-        Initialize the ValidationSetBuilder.
-
-        Args:
-            name (str): The name of the validation set.
-            openapi_service (OpenAPIService): An instance of OpenAPIService to interact with the API.
-        """
-        self.name = name
-        self.openapi_service = openapi_service
-        self.validation_set_id: str | None = None
-        self._rapid_parts: list[ValidatioRapidParts] = []
-
-    def create(self) -> RapidataValidationSet:
-        """Create the validation set by executing all HTTP requests. This should be the last method called on the builder.
-
-        Returns:
-            RapidataValidationSet: A RapidataValidationSet instance.
-
-        Raises:
-            ValueError: If the validation set creation fails.
-        """
-        result = (
-            self.openapi_service.validation_api.validation_create_validation_set_post(
-                name=self.name
-            )
-        )
-        self.validation_set_id = result.validation_set_id
-
-        if self.validation_set_id is None:
-            raise ValueError("Failed to create validation set")
-
-        validation_set = RapidataValidationSet(
-            validation_set_id=self.validation_set_id,
-            openapi_service=self.openapi_service,
-            name=self.name,
-        )
-
-        for rapid_part in self._rapid_parts:
-            validation_set.add_general_validation_rapid(
-                payload=rapid_part.payload,
-                truths=rapid_part.truths,
-                metadata=rapid_part.metadata,
-                asset=rapid_part.asset,
-                randomCorrectProbability=rapid_part.randomCorrectProbability,
-            )
-
-        return validation_set
-    
-    def add_rapid(self, rapid: Rapid):
-        """Add a rapid to the validation set.
-        To create the Rapid, use the RapidataClient.rapid_builder instance.
-
-        Args:
-            rapid (Rapid): The rapid to add to the validation set.
-        """
-        if not isinstance(rapid, Rapid):
-            raise ValueError("This method only accepts Rapid instances")
-        
-        if isinstance(rapid, ClassificationRapid):
-            self._add_classify_rapid(rapid.asset, rapid.question, rapid.options, rapid.truths, rapid.metadata)
-
-        if isinstance(rapid, CompareRapid):
-            self._add_compare_rapid(rapid.asset, rapid.criteria, rapid.truth, rapid.metadata)
-
-        if isinstance(rapid, TranscriptionRapid):
-            self._add_transcription_rapid(rapid.asset, rapid.instruction, rapid.transcription, rapid.truths, rapid.strict_grading)
-
-        return self
-
-    @deprecated("Use add_rapid instead")
-    def add_classify_rapid(
-        self,
-        asset: MediaAsset | TextAsset,
-        question: str,
-        categories: list[str],
-        truths: list[str],
-        metadata: list[Metadata] = [],
-    ):
-        """Add a classify rapid to the validation set.
-
-        Args:
-            asset (MediaAsset | TextAsset): The asset for the rapid.
-            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:
-            ValidationSetBuilder: The ValidationSetBuilder instance.
-
-        Raises:
-            ValueError: If the lengths of categories and truths are inconsistent.
-        """
-        self._add_classify_rapid(asset, question, categories, truths, metadata)
-
-        return self
-    
-    def _add_classify_rapid(
-        self,
-        asset: MediaAsset | TextAsset,
-        question: str,
-        categories: list[str],
-        truths: list[str],
-        metadata: list[Metadata] = [],
-    ):
-        """Add a classify rapid to the validation set.
-
-        Args:
-            asset (MediaAsset | TextAsset): The asset for the rapid.
-            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:
-            ValidationSetBuilder: The ValidationSetBuilder instance.
-
-        Raises:
-            ValueError: If the lengths of categories and truths are inconsistent.
-        """
-        payload = ClassifyPayload(
-            _t="ClassifyPayload", possibleCategories=categories, title=question
-        )
-        model_truth = AttachCategoryTruth(
-            correctCategories=truths, _t="AttachCategoryTruth"
-        )
-
-        self._rapid_parts.append(
-            ValidatioRapidParts(
-                question=question,
-                payload=payload,
-                truths=model_truth,
-                metadata=metadata,
-                randomCorrectProbability=len(truths) / len(categories),
-                asset=asset,
-            )
-        )
-
-    @deprecated("Use add_rapid instead")
-    def add_compare_rapid(
-        self,
-        asset: MultiAsset,
-        question: str,
-        truth: str,
-        metadata: list[Metadata] = [],
-    ):
-        """Add a compare rapid to the validation set.
-
-        Args:
-            asset (MultiAsset): The assets for the rapid.
-            question (str): The question for the rapid.
-            truth (str): The truth identifier for the rapid.
-            metadata (list[Metadata], optional): The metadata for the rapid. Defaults to an empty list.
-
-        Returns:
-            ValidationSetBuilder: The ValidationSetBuilder instance.
-
-        Raises:
-            ValueError: If the number of assets is not exactly two.
-        """
-        self._add_compare_rapid(asset, question, truth, metadata)
-
-        return self
-    
-    def _add_compare_rapid(
-        self,
-        asset: MultiAsset,
-        criteria: str,
-        truth: str,
-        metadata: list[Metadata] = [],
-    ):
-        """Add a compare rapid to the validation set.
-
-        Args:
-            asset (MultiAsset): The assets for the rapid.
-            criteria (str): The criteria for the comparison.
-            truth (str): The truth identifier for the rapid.
-            metadata (list[Metadata], optional): The metadata for the rapid. Defaults to an empty list.
-
-        Returns:
-            ValidationSetBuilder: The ValidationSetBuilder instance.
-
-        Raises:
-            ValueError: If the number of assets is not exactly two.
-        """
-        payload = ComparePayload(_t="ComparePayload", criteria=criteria)
-        # take only last part of truth path
-        truth = os.path.basename(truth)
-        model_truth = CompareTruth(_t="CompareTruth", winnerId=truth)
-
-        if len(asset) != 2:
-            raise ValueError("Compare rapid requires exactly two media paths")
-
-        self._rapid_parts.append(
-            ValidatioRapidParts(
-                question=criteria,
-                payload=payload,
-                truths=model_truth,
-                metadata=metadata,
-                randomCorrectProbability=1 / len(asset),
-                asset=asset,
-            )
-        )
-
-    @deprecated("Use add_rapid instead")
-    def add_transcription_rapid(
-        self,
-        asset: MediaAsset | TextAsset,
-        question: str,
-        transcription: str,
-        truths: list[int],
-        strict_grading: bool | None = None,
-        metadata: list[Metadata] = [],
-    ):
-        """Add a transcription rapid to the validation set.
-
-        Args:
-            asset (MediaAsset | TextAsset): The asset for the rapid.
-            question (str): The question for the rapid.
-            transcription (list[str]): The transcription for the rapid.
-            truths (list[int]): The list of indices of the true word selections.
-            strict_grading (bool | None, optional): The strict grading for the rapid. Defaults to None.
-            metadata (list[Metadata], optional): The metadata for the rapid.
-
-        Returns:
-            ValidationSetBuilder: The ValidationSetBuilder instance.
-
-        Raises:
-            ValueError: If a correct word is not found in the transcription.
-        """
-        self._add_transcription_rapid(asset, question, transcription, truths, strict_grading, metadata)
-
-        return self
-    
-    def _add_transcription_rapid(
-        self,
-        asset: MediaAsset | TextAsset,
-        question: str,
-        transcription: str,
-        truths: list[int],
-        strict_grading: bool | None = None,
-        metadata: list[Metadata] = [],
-    ):
-        """Add a transcription rapid to the validation set.
-
-        Args:
-            asset (MediaAsset | TextAsset): The asset for the rapid.
-            question (str): The question for the rapid.
-            transcription (list[str]): The transcription for the rapid.
-            truths (list[int]): The list of indices of the true word selections.
-            strict_grading (bool | None, optional): The strict grading for the rapid. Defaults to None.
-            metadata (list[Metadata], optional): The metadata for the rapid.
-
-        Returns:
-            ValidationSetBuilder: The ValidationSetBuilder instance.
-
-        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.split())
-        ]
-
-        true_words = []
-        for idx in truths:
-            if idx > len(transcription_words) - 1:
-                raise ValueError(f"Index {idx} is out of bounds")
-            true_words.append(transcription_words[idx])
-
-        payload = TranscriptionPayload(
-            _t="TranscriptionPayload", title=question, transcription=transcription_words
-        )
-
-        model_truth = TranscriptionTruth(
-            _t="TranscriptionTruth",
-            correctWords=true_words,
-            strictGrading=strict_grading,
-        )
-
-        self._rapid_parts.append(
-            ValidatioRapidParts(
-                question=question,
-                asset=asset,
-                payload=payload,
-                truths=model_truth,
-                metadata=metadata,
-                randomCorrectProbability = 1 / len(transcription_words),
-            )
-        )

rapidata/rapidata_client/filter/base_filter.py

@@ -1,9 +0,0 @@
-from abc import abstractmethod
-from typing import Any
-
-
-class Filter:
-
-    @abstractmethod
-    def to_model(self) -> Any:
-        pass

rapidata/rapidata_client/metadata/__init__.py

@@ -1,5 +0,0 @@
-from .base_metadata import Metadata
-from .private_text_metadata import PrivateTextMetadata
-from .public_text_metadata import PublicTextMetadata
-from .prompt_metadata import PromptMetadata
-from .transcription_metadata import TranscriptionMetadata

rapidata/rapidata_client/metadata/base_metadata.py

@@ -1,12 +0,0 @@
-from abc import abstractmethod
-from typing import Any
-
-
-class Metadata:
-
-    def __init__(self, identifier: str):
-        self._identifier = identifier
-
-    @abstractmethod
-    def to_model(self) -> Any:
-        pass

rapidata/rapidata_client/metadata/private_text_metadata.py

@@ -1,16 +0,0 @@
-from rapidata.api_client.models.private_text_metadata_input import (
-    PrivateTextMetadataInput,
-)
-from rapidata.rapidata_client.metadata.base_metadata import Metadata
-
-
-class PrivateTextMetadata(Metadata):
-
-    def __init__(self, text: str, identifier: str = "private_text"):
-        super().__init__(identifier=identifier)
-        self._text = text
-
-    def to_model(self):
-        return PrivateTextMetadataInput(
-            _t="PrivateTextMetadataInput", identifier=self._identifier, text=self._text
-        )

rapidata/rapidata_client/metadata/prompt_metadata.py

@@ -1,17 +0,0 @@
-from rapidata.rapidata_client.metadata.base_metadata import Metadata
-from rapidata.api_client.models.prompt_metadata_input import PromptMetadataInput
-
-
-class PromptMetadata(Metadata):
-
-    def __init__(self, prompt: str, identifier: str = "prompt"):
-        super().__init__(identifier=identifier)
-
-        if not isinstance(prompt, str):
-            raise ValueError("Prompt must be a string")
-        
-        self._prompt = prompt
-    
-
-    def to_model(self):
-        return PromptMetadataInput(_t="PromptMetadataInput", identifier=self._identifier, prompt=self._prompt)

rapidata/rapidata_client/metadata/public_text_metadata.py

@@ -1,16 +0,0 @@
-from rapidata.api_client.models.public_text_metadata_input import (
-    PublicTextMetadataInput,
-)
-from rapidata.rapidata_client.metadata.base_metadata import Metadata
-
-
-class PublicTextMetadata(Metadata):
-
-    def __init__(self, text: str, identifier: str = "public_text"):
-        super().__init__(identifier=identifier)
-        self._text = text
-
-    def to_model(self):
-        return PublicTextMetadataInput(
-            _t="PublicTextMetadataInput", identifier=self._identifier, text=self._text
-        )

rapidata/rapidata_client/metadata/transcription_metadata.py

@@ -1,19 +0,0 @@
-from rapidata.api_client.models.transcription_metadata_input import (
-    TranscriptionMetadataInput,
-)
-from rapidata.rapidata_client.metadata.base_metadata import Metadata
-
-
-class TranscriptionMetadata(Metadata):
-
-    def __init__(self, transcription: str, identifier: str = "transcription"):
-        super().__init__(identifier=identifier)
-        self.identifier = identifier
-        self.transcription = transcription
-
-    def to_model(self):
-        return TranscriptionMetadataInput(
-            _t="TranscriptionMetadataInput",
-            identifier=self.identifier,
-            transcription=self.transcription,
-        )