rapidata 2.42.6__py3-none-any.whl → 2.42.8__py3-none-any.whl

rapidata/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "2.42.6"
+__version__ = "2.42.8"
 
 from .rapidata_client import (
     RapidataClient,
@@ -17,6 +17,7 @@ from .rapidata_client import (
     FreeTextMinimumCharacters,
     NoShuffle,
     PlayVideoUntilTheEnd,
+    MuteVideo,
     CustomSetting,
     AllowNeitherBoth,
     SwapContextInstruction,

rapidata/rapidata_client/__init__.py

@@ -27,6 +27,7 @@ from .settings import (
     CustomSetting,
     AllowNeitherBoth,
     SwapContextInstruction,
+    MuteVideo,
 )
 from .filter import (
     CountryFilter,

rapidata/rapidata_client/benchmark/rapidata_benchmark.py

@@ -1,4 +1,4 @@
-import re
+import pandas as pd
 import urllib.parse
 import webbrowser
 from colorama import Fore
@@ -479,6 +479,33 @@ class RapidataBenchmark:
                 + Fore.RESET
             )
 
+    def get_overall_standings(self, tags: Optional[list[str]] = None) -> pd.DataFrame:
+        """
+        Returns an aggregated elo table of all leaderboards in the benchmark.
+        """
+        with tracer.start_as_current_span("get_overall_standings"):
+            participants = self._openapi_service.benchmark_api.benchmark_benchmark_id_standings_get(
+                benchmark_id=self.id,
+                tags=tags,
+            )
+
+            standings = []
+            for participant in participants.items:
+                standings.append(
+                    {
+                        "name": participant.name,
+                        "wins": participant.wins,
+                        "total_matches": participant.total_matches,
+                        "score": (
+                            round(participant.score, 2)
+                            if participant.score is not None
+                            else None
+                        ),
+                    }
+                )
+
+            return pd.DataFrame(standings)
+
     def __str__(self) -> str:
         return f"RapidataBenchmark(name={self.name}, id={self.id})"
 

rapidata/rapidata_client/filter/user_score_filter.py

@@ -23,12 +23,15 @@ class UserScoreFilter(RapidataFilter, BaseModel):
         This will only show the order to users that have a UserScore of >=0.5 and <=0.9
     """
 
-    lower_bound: float = 0.0
-    upper_bound: float = 1.0
+    lower_bound: float
+    upper_bound: float
     dimension: str | None = None
 
     def __init__(
-        self, lower_bound: float, upper_bound: float, dimension: str | None = None
+        self,
+        lower_bound: float = 0.0,
+        upper_bound: float = 1.0,
+        dimension: str | None = None,
     ):
         super().__init__(
             lower_bound=lower_bound, upper_bound=upper_bound, dimension=dimension

rapidata/rapidata_client/settings/__init__.py

@@ -8,4 +8,5 @@ from .custom_setting import CustomSetting
 from ._rapidata_setting import RapidataSetting
 from .allow_neither_both import AllowNeitherBoth
 from .swap_context_instruction import SwapContextInstruction
+from .mute_video import MuteVideo
 from .rapidata_settings import RapidataSettings

rapidata/rapidata_client/settings/allow_neither_both.py

@@ -12,4 +12,6 @@ class AllowNeitherBoth(RapidataSetting):
     """
 
     def __init__(self, value: bool = True):
+        if not isinstance(value, bool):
+            raise ValueError("The value must be a boolean.")
         super().__init__(key="compare_unsure", value=value)

rapidata/rapidata_client/settings/mute_video.py

@@ -0,0 +1,15 @@
+from rapidata.rapidata_client.settings._rapidata_setting import RapidataSetting
+
+
+class MuteVideo(RapidataSetting):
+    """
+    Mute the video. If this setting is not supplied, the video will not be muted.
+
+    Args:
+        value (bool): Whether to mute the video. Defaults to True.
+    """
+
+    def __init__(self, value: bool = True):
+        if not isinstance(value, bool):
+            raise ValueError("The value must be a boolean.")
+        super().__init__(key="mute_video_asset", value=value)

rapidata/rapidata_client/settings/rapidata_settings.py

@@ -6,6 +6,7 @@ from rapidata.rapidata_client.settings import (
     PlayVideoUntilTheEnd,
     AllowNeitherBoth,
     SwapContextInstruction,
+    MuteVideo,
 )
 
 
@@ -23,6 +24,7 @@ class RapidataSettings:
         play_video_until_the_end (PlayVideoUntilTheEnd): Allows users to only answer once the video has finished playing.
         allow_neither_both (AllowNeitherBoth): Only for compare tasks. If true, the users will be able to select neither or both instead of exclusively one of the options.
         swap_context_instruction (SwapContextInstruction): Swap the place of the context and instruction.
+        mute_video (MuteVideo): Mute the video.
 
     Example:
         ```python
@@ -40,9 +42,10 @@ class RapidataSettings:
     play_video_until_the_end = PlayVideoUntilTheEnd
     allow_neither_both = AllowNeitherBoth
     swap_context_instruction = SwapContextInstruction
+    mute_video = MuteVideo
 
     def __str__(self) -> str:
-        return f"RapidataSettings(alert_on_fast_response={self.alert_on_fast_response}, translation_behaviour={self.translation_behaviour}, free_text_minimum_characters={self.free_text_minimum_characters}, no_shuffle={self.no_shuffle}, play_video_until_the_end={self.play_video_until_the_end}, allow_neither_both={self.allow_neither_both}, swap_context_instruction={self.swap_context_instruction})"
+        return f"RapidataSettings(alert_on_fast_response={self.alert_on_fast_response}, translation_behaviour={self.translation_behaviour}, free_text_minimum_characters={self.free_text_minimum_characters}, no_shuffle={self.no_shuffle}, play_video_until_the_end={self.play_video_until_the_end}, allow_neither_both={self.allow_neither_both}, swap_context_instruction={self.swap_context_instruction}, mute_video={self.mute_video})"
 
     def __repr__(self) -> str:
         return self.__str__()

{rapidata-2.42.6.dist-info → rapidata-2.42.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rapidata
-Version: 2.42.6
+Version: 2.42.8
 Summary: Rapidata package containing the Rapidata Python Client to interact with the Rapidata Web API in an easy way.
 License: Apache-2.0
 License-File: LICENSE

{rapidata-2.42.6.dist-info → rapidata-2.42.8.dist-info}/RECORD

@@ -1,4 +1,4 @@
-rapidata/__init__.py,sha256=rsgNfH2hEqJNu89zai9F2RcA8MnUGP9XS6OX5HM3bKc,857
+rapidata/__init__.py,sha256=Wour_mnWfBvZzS6vyY8wmx-oX9J8ii9a3Z_L8OXca14,872
 rapidata/api_client/__init__.py,sha256=Rh2aAoa6nDv09Z7cpTNdrPotXixBcNN_2VevCDD1goc,37144
 rapidata/api_client/api/__init__.py,sha256=CaZJ54mxbAEzAFd0Cjy0mfiUabD-d_7tqVOgjU4RxZI,1749
 rapidata/api_client/api/asset_api.py,sha256=buYMBGvg5_SLkJ7aG07c7_1rT6TXTCqoLfoV8O2nJhM,34442
@@ -599,7 +599,7 @@ rapidata/api_client/models/workflow_state.py,sha256=5LAK1se76RCoozeVB6oxMPb8p_5b
 rapidata/api_client/models/zip_entry_file_wrapper.py,sha256=-c8uJo-Dd-FGYPLzUR8sHV2waucFoDwEaJ_ztDGW7vc,5830
 rapidata/api_client/rest.py,sha256=rtIMcgINZOUaDFaJIinJkXRSddNJmXvMRMfgO2Ezk2o,10835
 rapidata/api_client_README.md,sha256=0AWEwcE005y5Q8IBzgEWgOa-iwqImdbY99RnQnlei70,63261
-rapidata/rapidata_client/__init__.py,sha256=j9nyFoKDOu8LyV9jcYaOqOL4kAbLf_TYaZkAg20969c,1080
+rapidata/rapidata_client/__init__.py,sha256=5rurgu-1s65Hazm61g-zNishhocWBuG0BuV83EkgBfA,1095
 rapidata/rapidata_client/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rapidata/rapidata_client/api/rapidata_api_client.py,sha256=9385bND7sDuXfmq0AFgea_RrtuT73NA2CWG_9aIoGok,8945
 rapidata/rapidata_client/benchmark/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -608,7 +608,7 @@ rapidata/rapidata_client/benchmark/leaderboard/__init__.py,sha256=47DEQpj8HBSa-_
 rapidata/rapidata_client/benchmark/leaderboard/rapidata_leaderboard.py,sha256=BPNTrKeEGvISdzAe_OpIIUtdX4tYgh_2g9w7YOnytA4,7840
 rapidata/rapidata_client/benchmark/participant/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rapidata/rapidata_client/benchmark/participant/_participant.py,sha256=rrjWkH8MO-Jow0Tpg4ejMmhyD2h-_s1-YzM2Seeu_Z8,5344
-rapidata/rapidata_client/benchmark/rapidata_benchmark.py,sha256=9Xk7WhuD8C7gPv2C4QVR_EdyKlIxjPiddHM6s3-dBT0,19925
+rapidata/rapidata_client/benchmark/rapidata_benchmark.py,sha256=LTRbakqmYFFx3lswj0X3Axv4V3bk-9-cAKJn6ivNUpw,20977
 rapidata/rapidata_client/benchmark/rapidata_benchmark_manager.py,sha256=5f7tLU39wyOt8rc-3MEqVdc6ANmP2j6hfzAupTCbHD0,8870
 rapidata/rapidata_client/config/__init__.py,sha256=AdL9mKlOa_xm3spFKPBBdTYzhioQh7-UvXd6t84wlDk,238
 rapidata/rapidata_client/config/logger.py,sha256=nQl9w6wLdvKGJFqtEQWoUBAlDtvYmo3w4ekIx4sNynI,5518
@@ -653,7 +653,7 @@ rapidata/rapidata_client/filter/not_filter.py,sha256=BfGx3db9tRGrNj6YHXK8tiyVXaz
 rapidata/rapidata_client/filter/or_filter.py,sha256=IabAoq15IhTGQrse_9_DMGCX-lUV_mx3vN4sM3fypA4,1400
 rapidata/rapidata_client/filter/rapidata_filters.py,sha256=B8ptQsaAn1e14Grv8xBYQ4qcU0Vt2VTjEpkk-tyOCTo,2201
 rapidata/rapidata_client/filter/response_count_filter.py,sha256=5vxBWh7VUarIIkfZRscPCDhqOptvar-2GOvbKmiJ6Y8,2199
-rapidata/rapidata_client/filter/user_score_filter.py,sha256=hX-8IT03SqyJ48WAgsYH75mXHHfXtrae7pcGIvfeBKU,1905
+rapidata/rapidata_client/filter/user_score_filter.py,sha256=z2wvyrEWsCCm1I_CbzmjLzK-pDsScWkNWIKB57F_TGU,1930
 rapidata/rapidata_client/order/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rapidata/rapidata_client/order/_rapidata_order_builder.py,sha256=FTJJRCW9KehIlqELOXmKeLhuGcLj9m9ImEU1agOIRa4,16915
 rapidata/rapidata_client/order/dataset/_rapidata_dataset.py,sha256=8EhoRVBxWMbp1mtS56Uogg2dwFC2vySw5hNqTPDTHzM,6345
@@ -678,17 +678,18 @@ rapidata/rapidata_client/selection/rapidata_selections.py,sha256=EdH0DGmDYEkfsAg
 rapidata/rapidata_client/selection/shuffling_selection.py,sha256=uAl3eB_qd_s4tANaFu9zaYSk73pDWvcixYwBCMGEzKc,1362
 rapidata/rapidata_client/selection/static_selection.py,sha256=aKpTZXrA6o2qJFCX7jqbX1BRUuKXcV7RqokoOaBqhZw,669
 rapidata/rapidata_client/selection/validation_selection.py,sha256=K8GviasRlMFSLUZdVqjBaMGIrsShnwuihenG07mci7A,1095
-rapidata/rapidata_client/settings/__init__.py,sha256=UC_6nrhS4q7zqio30-T1dMT9AtFhIfu5g_xhhIeAH1Y,568
+rapidata/rapidata_client/settings/__init__.py,sha256=eHBKWdweEztOtZg5TX4Z5BJyCC90nz-58vaiqjsH8gY,602
 rapidata/rapidata_client/settings/_rapidata_setting.py,sha256=ZiTzyEr9ihFif0av9CroY1KJ4PfFMB_cV_nrvBsG--s,583
 rapidata/rapidata_client/settings/alert_on_fast_response.py,sha256=VYOQ1EfKolYmsNNI4gJPx-_UWFl9dtrroca796jrAZI,1007
-rapidata/rapidata_client/settings/allow_neither_both.py,sha256=c92e3d-TAB7-Isv3O3zPibaGm_Uj2Uy-NhyCzdyhnXM,540
+rapidata/rapidata_client/settings/allow_neither_both.py,sha256=OiRUuuR9xJ8Dtl0hpHiCIHK-SS1vu1GJ_ztnx3Fkhw4,641
 rapidata/rapidata_client/settings/custom_setting.py,sha256=YhVr5uvsp4GT6nXzZqgzbKPrcNlMkRB4alYtFqk_Na4,568
 rapidata/rapidata_client/settings/free_text_minimum_characters.py,sha256=m3C28_OhJNCiy2GKwi9VIXOSamjoHKDZUyVYdYFCWCg,777
 rapidata/rapidata_client/settings/models/__init__.py,sha256=IW7OuWg7xWIwFYrMAOX5N0HGGcqE6fFpgYin3vWRkOU,71
 rapidata/rapidata_client/settings/models/translation_behaviour_options.py,sha256=shbCpoi8bOqIArcZtnBL9ZRvUsyVXwjs3nRj9-uzZw4,472
+rapidata/rapidata_client/settings/mute_video.py,sha256=F8uUfqvhjySNLqC6IVv9QVOa-l-oKaiXfOtn90BTTzQ,500
 rapidata/rapidata_client/settings/no_shuffle.py,sha256=RJKJl76vyakEQ6tyA-06GSo3wF57uxTjF-4f07gK_Gg,674
 rapidata/rapidata_client/settings/play_video_until_the_end.py,sha256=vPtIYql197Q0h6N_TlYuI3AbakBJUmnYUmhoSns9EWc,754
-rapidata/rapidata_client/settings/rapidata_settings.py,sha256=ae_NwycNqvA2q-lnnkDohS8IduG2DBtyqLJlgt3PXBA,2501
+rapidata/rapidata_client/settings/rapidata_settings.py,sha256=ByThJw1df3jEvz8-8a6txxyF2cHINpxXcbaLWpVZCmc,2621
 rapidata/rapidata_client/settings/swap_context_instruction.py,sha256=DLa1CDKIHVWC0VBOYTbb9HZBebzsaIGT_2DHq9I0ovs,712
 rapidata/rapidata_client/settings/translation_behaviour.py,sha256=uEke2WgzrjzRlSROgeyP7v9t5ayFynHzytjIU_gVu3Y,741
 rapidata/rapidata_client/validation/__init__.py,sha256=s5wHVtcJkncXSFuL9I0zNwccNOKpWAqxqUjkeohzi2E,24
@@ -715,7 +716,7 @@ rapidata/service/credential_manager.py,sha256=T3yL4tXVnibRytxjQkOC-ex3kFGQR5KcKU
 rapidata/service/local_file_service.py,sha256=0Q4LdoEtPFKzgXK2oZ1cQ-X7FipakscjGnnBH8dRFRQ,855
 rapidata/service/openapi_service.py,sha256=E2zVagI_ri15PK06ITO_VNKYDJ0VZQG1YQ1T6bEIVsY,5566
 rapidata/types/__init__.py,sha256=NLRuTGbTImRv3yIp8we_oqVvCuBd7TDNVlAzkVGs9oo,6056
-rapidata-2.42.6.dist-info/METADATA,sha256=hGaKKniKHnrpgC3qBq6r1FQbzzk7af7zh9x2-1UY71g,1479
-rapidata-2.42.6.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
-rapidata-2.42.6.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-rapidata-2.42.6.dist-info/RECORD,,
+rapidata-2.42.8.dist-info/METADATA,sha256=VsHfP0Grd0sNyKFng-VDXCUD4sIQsiaNZmP4gbgFFgE,1479
+rapidata-2.42.8.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+rapidata-2.42.8.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+rapidata-2.42.8.dist-info/RECORD,,