rapidata 0.5.0__py3-none-any.whl → 1.0.0__py3-none-any.whl

rapidata/rapidata_client/simple_builders/simple_compare_builders.py

@@ -0,0 +1,86 @@
+from rapidata.service.openapi_service import OpenAPIService
+from rapidata.rapidata_client.metadata.base_metadata import Metadata
+from rapidata.rapidata_client.order.rapidata_order_builder import RapidataOrderBuilder
+from rapidata.rapidata_client.workflow.compare_workflow import CompareWorkflow
+from rapidata.rapidata_client.referee.naive_referee import NaiveReferee
+from rapidata.rapidata_client.selection.validation_selection import ValidationSelection
+from rapidata.rapidata_client.selection.labeling_selection import LabelingSelection
+from rapidata.rapidata_client.selection.base_selection import Selection
+
+class CompareOrderBuilder:
+    def __init__(self, name:str, criteria: str, media_paths: list[list[str]], openapi_service: OpenAPIService):
+        self._order_builder = RapidataOrderBuilder(name=name, openapi_service=openapi_service)
+        self._name = name
+        self._criteria = criteria
+        self._media_paths = media_paths
+        self._responses_required = 10
+        self._metadata = None
+        self._validation_set_id = None
+
+    def responses(self, responses_required: int) -> 'CompareOrderBuilder':
+        """Set the number of resoonses required per matchup/pairing for the comparison order."""
+        self._responses_required = responses_required
+        return self
+    
+    def metadata(self, metadata: list[Metadata]) -> 'CompareOrderBuilder':
+        """Set the metadata for the comparison order. Has to be the same shape as the media paths."""
+        self._metadata = metadata
+        return self
+    
+    def validation_set_id(self, validation_set_id: str) -> 'CompareOrderBuilder':
+        """Set the validation set ID for the comparison order."""
+        self._validation_set_id = validation_set_id
+        return self
+    
+    def create(self, submit: bool = True, max_upload_workers: int = 10):
+        selection: list[Selection] = ([ValidationSelection(amount=1, validation_set_id=self._validation_set_id), LabelingSelection(amount=2)] 
+                     if self._validation_set_id 
+                     else [LabelingSelection(amount=3)])
+        
+        order = (self._order_builder
+            .workflow(
+                CompareWorkflow(
+                    criteria=self._criteria
+                )
+            )
+            .referee(NaiveReferee(required_guesses=self._responses_required))
+            .media(self._media_paths, metadata=self._metadata) # type: ignore
+            .selections(selection)
+            .create(submit=submit, max_workers=max_upload_workers))
+        
+        return order
+
+class CompareMediaBuilder:
+    def __init__(self, name: str, criteria: str, openapi_service: OpenAPIService):
+        self._openapi_service = openapi_service
+        self._name = name
+        self._criteria = criteria
+        self._media_paths = None
+
+    def media(self, media_paths: list[list[str]]) -> CompareOrderBuilder:
+        """Set the media assets for the comparison order by providing the local paths to the files."""
+        self._media_paths = media_paths
+        return self._build()
+    
+    def _build(self) -> CompareOrderBuilder:
+        if self._media_paths is None:
+            raise ValueError("Media paths are required")
+        assert all([len(path) == 2 for path in self._media_paths]), "The media paths must come in pairs for comparison tasks."
+        return CompareOrderBuilder(self._name, self._criteria, self._media_paths, self._openapi_service)
+
+class CompareCriteriaBuilder:
+    def __init__(self, name: str, openapi_service: OpenAPIService):
+        self._openapi_service = openapi_service
+        self._name = name
+        self._criteria = None
+
+    def criteria(self, criteria: str) -> CompareMediaBuilder:
+        """Set the criteria how the images should be compared."""
+        self._criteria = criteria
+        return self._build()
+    
+    def _build(self) -> CompareMediaBuilder:
+        if self._criteria is None:
+            raise ValueError("Criteria are required")
+        return CompareMediaBuilder(self._name, self._criteria, self._openapi_service)
+

{rapidata-0.5.0.dist-info → rapidata-1.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rapidata
-Version: 0.5.0
+Version: 1.0.0
 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.5.0.dist-info → rapidata-1.0.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
-rapidata/__init__.py,sha256=peUT8E9wN_oRzPlp_7nelh5DDbHJMtFZNDnvJhW6KOc,444
-rapidata/api_client/__init__.py,sha256=x3-JQket4rv49nniZY-aS2MDGE2HyxEF3N5LY9IYxYc,21877
+rapidata/__init__.py,sha256=RjXYD9JoaCt45SnKETQNql7GzbRY3yzGirZSQNK26aI,486
+rapidata/api_client/__init__.py,sha256=h5d6E5Xw4b3d8qIO5HBDLzwCKMK_Q_-u1mNJBr2jwpU,22045
 rapidata/api_client/api/__init__.py,sha256=uy9DBb5K6kofik_kEODgcND2VV2-7lSuX8f-LPp7s-o,857
 rapidata/api_client/api/campaign_api.py,sha256=v31gL2TkwJdq8lQ33Ys3I1X5d6P92pgVO9qhpwW6aJI,40382
 rapidata/api_client/api/coco_api.py,sha256=v5xYyQVlAv4ENgihWlji3BkbczQYKxLP0gnxfQLRmkI,24926
@@ -12,19 +12,20 @@ rapidata/api_client/api/order_api.py,sha256=Ki_UbvNHHdpyV3Jz_41Fal_PJ3Ifjv5SF-U4
 rapidata/api_client/api/pipeline_api.py,sha256=j6JLaDmzj3Hv79H3HZLi0a4jURAQmigM2d1PyI9iEDs,33177
 rapidata/api_client/api/rapid_api.py,sha256=wVy2ucEw8nJfNAf_IVAj7u_JViggXtcb1LVTt8ygGts,54311
 rapidata/api_client/api/simple_workflow_api.py,sha256=2jzwmQhaeypcyt6MeyeehSBntCvfhQt1uihMvivFpnE,15417
-rapidata/api_client/api/validation_api.py,sha256=TyAI3025so1MNKYdBUAPYfjrpdax87Fvpmginmpscgo,67763
+rapidata/api_client/api/validation_api.py,sha256=Sqb5ZNYhHe0E1Pm7wx3UrEp_Jaa5FfJunTBO2G_EucA,79581
 rapidata/api_client/api/workflow_api.py,sha256=fl8n31tByZyHJRqIZa1_dpQ7mz_nbWg6P2_KfM8MAxc,94431
 rapidata/api_client/api_client.py,sha256=EDhxAOUc5JFWvFsF1zc726Q7GoEFkuB8uor5SlGx9K4,27503
 rapidata/api_client/api_response.py,sha256=eMxw1mpmJcoGZ3gs9z6jM4oYoZ10Gjk333s9sKxGv7s,652
 rapidata/api_client/configuration.py,sha256=g472vHVPLBotq8EkfSXP4sbp7xnn-3sb8O8BBlRWK1I,15931
 rapidata/api_client/exceptions.py,sha256=eLLd1fxM0Ygf3IIG6aNx9hdy79drst5Cem0UjI_NamM,5978
-rapidata/api_client/models/__init__.py,sha256=ifxZebPyaQtNPPDRU6Wr83mtef-44WVFSE9rvEgNmIk,20479
+rapidata/api_client/models/__init__.py,sha256=2cWi88s-Cu0DYwmfj4vxWFlxW3Vl16K63IsS8VJiWlA,20647
 rapidata/api_client/models/add_campaign_artifact_result.py,sha256=4IvFVS-tLlL6eHsWp-IZ_ul5T30-h3YEwd2B5ioBbgY,2582
-rapidata/api_client/models/add_campaign_model.py,sha256=hTZjiWV-n2EC-BBrhj6bUucPjLtrREbH05oZatizr3U,6858
+rapidata/api_client/models/add_campaign_model.py,sha256=OJzkfvQlrp6j6ffwVShouUCW-MQZw60BGUJpqjbSGs8,6853
 rapidata/api_client/models/add_validation_rapid_model.py,sha256=-HRHMK-o6dgGjUqfsP_woZcFxfN7nuJ-L1CUaK9nihY,4918
 rapidata/api_client/models/add_validation_rapid_model_payload.py,sha256=Ul_xSBMI4jlnbIKPZfyuYJ5x-f-mQik8hYD1ArVKCLw,11092
 rapidata/api_client/models/add_validation_rapid_model_truth.py,sha256=TlaA5RbE2gJquDDm-d7c_fQxvWjYQtiJljZEWgZMWo8,11044
 rapidata/api_client/models/add_validation_rapid_result.py,sha256=rNk2_4CERFNpCq4XExFEb6-9QVwGEJ62nTmpX4_kjXk,2563
+rapidata/api_client/models/add_validation_text_rapid_model.py,sha256=Z7EbM9tfkmIQoVDvFdpqDXkecXQF6ymoAJrkxPFVfRU,4995
 rapidata/api_client/models/admin_order_model.py,sha256=-QBgxsw7MTOYEjwOnKSndJTCWpdx5Os--dY4e6JSW9E,3730
 rapidata/api_client/models/admin_order_model_paged_result.py,sha256=edgeuvJ8yDMjKDB8vYa2YdbO7brdcgj6AMXPQTLeRbc,3494
 rapidata/api_client/models/age_group.py,sha256=k4gm2IPuwxXbU9wTvlat0yMwyz3HJ7tVG3Vqhda-e0g,846
@@ -44,6 +45,8 @@ rapidata/api_client/models/campaign_query_model.py,sha256=jyJVUrxumUmkx_Al4yoLi0
 rapidata/api_client/models/campaign_query_model_paged_result.py,sha256=Aggg5CzXPO6dL-GeSf0RU7WKYelvFagEVq8jaz2MA6g,3518
 rapidata/api_client/models/campaign_status.py,sha256=YizkmOn2a0CUmP6GZ0z1zukiYYCpiENZmOVeIzZ-qTQ,813
 rapidata/api_client/models/campaign_user_filter_model.py,sha256=Jl92xwZPA_qQxeVkxGmT987KTG7Bdbj5zysugricbKo,3028
+rapidata/api_client/models/capped_selection.py,sha256=5lS2TtDYS3LH93dq8nVQiZLLcyfWLe5_vMdSs30sKBc,3761
+rapidata/api_client/models/capped_selection_selections_inner.py,sha256=pIT5w0rtbY2h__5xbsVj0zXEciaNMu7Ctfq1o-YZxjE,9234
 rapidata/api_client/models/classification_metadata.py,sha256=nNvX8m7sRkhxPiLaCtMGdOmW8Q-cw42LFNlYT-i6WIY,3262
 rapidata/api_client/models/classification_metadata_filter_config.py,sha256=Piv8LaeS856jP5SCbXpOAR-zbqVtXQTUtXxdIC6ViB4,3128
 rapidata/api_client/models/classify_payload.py,sha256=UmIU4mE6pR3KdrxEzFTgPTsN0H8YUPiUaZuy2JOTnAE,3104
@@ -83,7 +86,7 @@ rapidata/api_client/models/create_independent_workflow_model.py,sha256=w7lHQXKG1
 rapidata/api_client/models/create_independent_workflow_model_workflow_config.py,sha256=GVVxs9VAmM2hTXWWoqKNXD9E7qRk3CO88YRm1AHxJCI,5845
 rapidata/api_client/models/create_independent_workflow_result.py,sha256=JOhS75mAH-VvarvDDFsycahPlIezVKT1upuqIo93hC0,2719
 rapidata/api_client/models/create_legacy_order_result.py,sha256=BR1XqPKq9QkDe0UytTW6dpihAeNyfCc4C1m0XfY53hQ,2672
-rapidata/api_client/models/create_order_model.py,sha256=iDZn_LR8IBuTcyoJDsBkLyIMmhLCrXl1o3-8rNU3pUE,8909
+rapidata/api_client/models/create_order_model.py,sha256=yILLaONWi3DHDGHgbz2M3MkGN7R1yIKF35XOsjInuaQ,8904
 rapidata/api_client/models/create_order_model_referee.py,sha256=dxQ9SDiBjFIKYjctVNeiuGvjZwzIa0Q8JpW7iRei00I,5748
 rapidata/api_client/models/create_order_model_selections_inner.py,sha256=9p9BJKHN3WhRiu-FwWf421COAxeGmm1KkkyDT7UW5uc,8354
 rapidata/api_client/models/create_order_model_user_filters_inner.py,sha256=2PAJkzMgWavHvaiR5vb1Sk6uPQZkDltiMjeoQAdsU8c,9412
@@ -270,16 +273,21 @@ rapidata/api_client/models/workflow_split_model.py,sha256=zthOSaUl8dbLhLymLK_lrP
 rapidata/api_client/models/workflow_split_model_filter_configs_inner.py,sha256=1Fx9uZtztiiAdMXkj7YeCqt7o6VkG9lKf7D7UP_h088,7447
 rapidata/api_client/models/workflow_state.py,sha256=5LAK1se76RCoozeVB6oxMPb8p_5bhLZJqn7q5fFQWis,850
 rapidata/api_client/rest.py,sha256=zmCIFQC2l1t-KZcq-TgEm3vco3y_LK6vRm3Q07K-xRI,9423
-rapidata/api_client_README.md,sha256=DSG4jdBJPc9wR5WqtW2cBTb7D1Sgptp6nfdPY5KJqbk,35564
-rapidata/rapidata_client/__init__.py,sha256=jR_6x2B4mlqIBvrQRaR4wXJGVAP4QgCWN5aFU0jjcXs,528
+rapidata/api_client_README.md,sha256=TTRICzNTe3a2U9z1c5BAcMdSnUODlBBM5keBeBXv6uk,35978
+rapidata/rapidata_client/__init__.py,sha256=zJ96SlJHI-RX-ut9hJoyOs9vWYGoDEcTqvwbgZOB8j8,577
+rapidata/rapidata_client/assets/__init__.py,sha256=T-XKvMSkmyI8iYLUYDdZ3LrrSInHsGMUY_Tz77hhnlE,240
+rapidata/rapidata_client/assets/base_asset.py,sha256=B2YWH1NgaeYUYHDW3OPpHM_bqawHbH4EjnRCE2BYwiM,298
+rapidata/rapidata_client/assets/media_asset.py,sha256=JU0O_2eNPnHSYpxKjzUq0hdVaHhI0VPw2z1UICkLBLw,846
+rapidata/rapidata_client/assets/multi_asset.py,sha256=laHJt-t29rMtgVYv1j5M6h_CrqWIQlPdjKMTI-jEcWI,1118
+rapidata/rapidata_client/assets/text_asset.py,sha256=a_En6wo0Ubgodl2KpBl1p_SxHSy_qRNme2bA3AtcPbY,516
 rapidata/rapidata_client/config.py,sha256=tQLgN6k_ATOX1GzZh38At2rgBDLStV6rJ6z0vsTTPjg,186
 rapidata/rapidata_client/country_codes/__init__.py,sha256=FB9Dcks44J6C6YBSYmTmNZ71tE130x6NO_3aLJ8fKzQ,40
 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=QDsl7ZCZxuG02yfEpBSphfSDZh_qHz6m5HUCGwZflfw,3205
-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=B9D-uNCo_PO0NCUHju_7dsWtz_KcOmvFIsxUgQ67Q2M,7471
+rapidata/rapidata_client/dataset/rapidata_dataset.py,sha256=Rwt7sM5T74HT7gbtfjmdF9tDaPqHfpMLggIWOsYCgYU,3205
+rapidata/rapidata_client/dataset/rapidata_validation_set.py,sha256=Y7iaThkLxDyHJuKA34rgPkIQ3_8l-hJyZwfomzOyUqk,10096
+rapidata/rapidata_client/dataset/validation_rapid_parts.py,sha256=uzpOZFqQu8bG6vmjcWWUNJPZsRe28OmnyalRE6ry8tk,2317
+rapidata/rapidata_client/dataset/validation_set_builder.py,sha256=VOb0oGBljIM7CK0Xau-Ha5thHXS38d3gMUFieQMfJsA,8134
 rapidata/rapidata_client/feature_flags/__init__.py,sha256=IYkcK_bZCl5RfyQFiWjjUdz4y0jipiW9qfeopq4EjQQ,40
 rapidata/rapidata_client/feature_flags/feature_flags.py,sha256=hcS9YRzpsPWpZfw-3QwSuf2TaVg-MOHBxY788oNqIW4,3957
 rapidata/rapidata_client/metadata/__init__.py,sha256=qMmo4wqScUCAJ6YXRWxvJLmbFA5YRbK39p9_exV1d50,246
@@ -290,18 +298,20 @@ rapidata/rapidata_client/metadata/public_text_metadata.py,sha256=LTiBQHs6izxQ6-C
 rapidata/rapidata_client/metadata/transcription_metadata.py,sha256=THtDEVCON4UlcXHmXrjilaOLHys4TrktUOPGWnXaCcc,631
 rapidata/rapidata_client/order/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rapidata/rapidata_client/order/rapidata_order.py,sha256=DCfw_xH7Ja8KURlJYaxVuX6dM81sUF7HLyX4iTfqqZc,3098
-rapidata/rapidata_client/order/rapidata_order_builder.py,sha256=5B-YNMInGLHNEaARpZ24igdUUdxPvZvscCsuDSqPo9s,8869
-rapidata/rapidata_client/rapidata_client.py,sha256=NsLE6WRrnPFNyCklD0d249XmCoVr_Z_z8HOf-scEnxM,3623
+rapidata/rapidata_client/order/rapidata_order_builder.py,sha256=R_SpEImqwz1U96Ucg3sNzl3KyKpBYtOc98ujozxoc3Y,10968
+rapidata/rapidata_client/rapidata_client.py,sha256=s3TlhYlvMuxcyEDIFDqpwRsP0SIi9b158uIHLUyV1gY,4699
 rapidata/rapidata_client/referee/__init__.py,sha256=Ow9MQsONhF4sX2wFK9jbvSBrpcJgtq3OglIQMkBUdIY,167
 rapidata/rapidata_client/referee/base_referee.py,sha256=bMy7cw0a-pGNbFu6u_1_Jplu0A483Ubj4oDQzh8vu8k,493
 rapidata/rapidata_client/referee/classify_early_stopping_referee.py,sha256=B5wsqKM3_Oc1TU_MFGiIyiXjwK1LcmaVjhzLdaL8Cgw,1797
 rapidata/rapidata_client/referee/naive_referee.py,sha256=KWMLSc73gOdM8YT_ciFhfN7J4eKgtOFphBG9tIra9g0,1179
-rapidata/rapidata_client/selection/__init__.py,sha256=AgTIOelA46yI2UzsjRqrSEyAZ8dIRiO17hbm6Go3TSM,286
+rapidata/rapidata_client/selection/__init__.py,sha256=Lt_VWi0laUJNcqIflczDc0XQqCGBXVYH76lSj2xMvVk,275
 rapidata/rapidata_client/selection/base_selection.py,sha256=Y3HkROPm4I4HLNiR0HuHKpvk236KkRlsoDxQATm_chY,138
-rapidata/rapidata_client/selection/conditional_validation_rapid_selection.py,sha256=BKHMdk6bg7_ekRxvnIJwtL4zqZlL0kNP5-DjFCCCiCc,1355
+rapidata/rapidata_client/selection/conditional_validation_selection.py,sha256=wP7Mf3pTf-7dDxuFc79cJess3M9llreEolvBIp8F8dM,1273
 rapidata/rapidata_client/selection/demographic_selection.py,sha256=BmzMpWS2kNv1-zRLWuZoqpGp6bF5PujhkyEs5UG7X18,439
 rapidata/rapidata_client/selection/labeling_selection.py,sha256=cqDMQEXfQGMmgIvPgGOYgIGaXflV_J7LZsGOsakLXqo,425
 rapidata/rapidata_client/selection/validation_selection.py,sha256=HswzD2SvZZWisNLoGj--0sT_TIK8crYp3xGGndo6aLY,523
+rapidata/rapidata_client/simple_builders/simple_classification_builders.py,sha256=N7r83eqKfiKMcbW5VBES7pCZEu9VXdcANaIxb0Denq8,5421
+rapidata/rapidata_client/simple_builders/simple_compare_builders.py,sha256=JVV6FYyY435Sj-u-xJvNtcmJjmZTWUvEPKiWXjc3COE,4052
 rapidata/rapidata_client/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rapidata/rapidata_client/utils/utils.py,sha256=Fl99gCnh_HnieIp099xEvEv4g2kEIKiFcUp0G2iz6x8,815
 rapidata/rapidata_client/workflow/__init__.py,sha256=nHB6heVVf_A3nhSL0NGapnGqJAL0K9nfOpfyaUM5srw,238
@@ -315,7 +325,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.5.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-rapidata-0.5.0.dist-info/METADATA,sha256=8Y4H6Kq51sUZQRtQSrcBb2XO8MZL81S2lJXKyo3QosQ,961
-rapidata-0.5.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-rapidata-0.5.0.dist-info/RECORD,,
+rapidata-1.0.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+rapidata-1.0.0.dist-info/METADATA,sha256=KOEI7yC4VdEa7msbQJQ_7ypW73a_54rpwKWgFLOJ8Og,961
+rapidata-1.0.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+rapidata-1.0.0.dist-info/RECORD,,