code-loader 1.0.72.dev5__py3-none-any.whl → 1.0.73__py3-none-any.whl

code_loader/contract/datasetclasses.py

@@ -133,6 +133,7 @@ class MetricHandlerData:
     name: str
     arg_names: List[str]
     direction: Union[None, MetricDirection, Dict[str, MetricDirection]] = MetricDirection.Downward
+    compute_insights: Union[bool, Dict[str, bool]] = True
 
 
 @dataclass
@@ -148,7 +149,7 @@ class RawInputsForHeatmap:
 
 @dataclass
 class SamplePreprocessResponse:
-    sample_ids: np.array
+    sample_ids: Union[npt.NDArray[np.float32], npt.NDArray[np.str_]]
     preprocess_response: PreprocessResponse
 
 

code_loader/inner_leap_binder/leapbinder.py

@@ -258,7 +258,8 @@ class LeapBinder:
                           ConfusionMatrixCallableInterfaceMultiArgs],
                           name: str,
                           direction: Optional[
-                              Union[MetricDirection, Dict[str, MetricDirection]]] = MetricDirection.Downward) -> None:
+                              Union[MetricDirection, Dict[str, MetricDirection]]] = MetricDirection.Downward,
+                          compute_insights: Union[bool, Dict[str, bool]] = True) -> None:
         """
         Add a custom metric to the setup.
 
@@ -267,9 +268,11 @@ class LeapBinder:
         name (str): The name of the custom metric.
         direction (Optional[Union[MetricDirection, Dict[str, MetricDirection]]]): The direction of the metric, either
         MetricDirection.Upward or MetricDirection.Downward, in case custom metric return a dictionary of metrics we can
-        supply a dictionary of directions correspondingly
+        supply a dictionary of directions correspondingly.
             - MetricDirection.Upward: Indicates that higher values of the metric are better and should be maximized.
             - MetricDirection.Downward: Indicates that lower values of the metric are better and should be minimized.
+        compute_insights (Union[bool, Dict[str, bool]]): Whether to compute insights or not. in case custom metric
+        return a dictionary of metrics we can supply a dictionary of values correspondingly
 
 
 
@@ -280,7 +283,8 @@ class LeapBinder:
             leap_binder.add_custom_metric(custom_metric_function, name='custom_metric', direction=MetricDirection.Downward)
         """
         arg_names = inspect.getfullargspec(function)[0]
-        self.setup_container.metrics.append(MetricHandler(MetricHandlerData(name, arg_names, direction), function))
+        metric_handler_data = MetricHandlerData(name, arg_names, direction, compute_insights)
+        self.setup_container.metrics.append(MetricHandler(metric_handler_data, function))
 
     def add_prediction(self, name: str, labels: List[str], channel_dim: int = -1) -> None:
         """

code_loader/inner_leap_binder/leapbinder_decorators.py

@@ -16,7 +16,8 @@ from code_loader.contract.visualizer_classes import LeapImage, LeapImageMask, Le
 
 
 def tensorleap_custom_metric(name: str,
-                             direction: Union[MetricDirection, Dict[str, MetricDirection]] = MetricDirection.Downward):
+                             direction: Union[MetricDirection, Dict[str, MetricDirection]] = MetricDirection.Downward,
+                             compute_insights: Union[bool, Dict[str, bool]] = True):
     def decorating_function(user_function: Union[CustomCallableInterfaceMultiArgs,
     CustomMultipleReturnCallableInterfaceMultiArgs,
     ConfusionMatrixCallableInterfaceMultiArgs]):
@@ -25,7 +26,7 @@ def tensorleap_custom_metric(name: str,
                 raise Exception(f'Metric with name {name} already exists. '
                                 f'Please choose another')
 
-        leap_binder.add_custom_metric(user_function, name, direction)
+        leap_binder.add_custom_metric(user_function, name, direction, compute_insights)
 
         def _validate_input_args(*args, **kwargs) -> None:
             for i, arg in enumerate(args):
@@ -75,6 +76,19 @@ def tensorleap_custom_metric(name: str,
                         (f'tensorleap_custom_metric validation failed: '
                          f'Keys in the return dict should be of type str. Got {type(key)}.')
                     _validate_single_metric(value)
+
+                if isinstance(direction, dict):
+                    for direction_key in direction:
+                        assert direction_key in result, \
+                            (f'tensorleap_custom_metric validation failed: '
+                             f'Keys in the direction mapping should be part of result keys. Got key {direction_key}.')
+
+                if isinstance(compute_insights, dict):
+                    for ci_key in compute_insights:
+                        assert ci_key in result, \
+                            (f'tensorleap_custom_metric validation failed: '
+                             f'Keys in the compute_insights mapping should be part of result keys. Got key {ci_key}.')
+
             else:
                 _validate_single_metric(result)
 

{code_loader-1.0.72.dev5.dist-info → code_loader-1.0.73.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: code-loader
-Version: 1.0.72.dev5
+Version: 1.0.73
 Summary: 
 Home-page: https://github.com/tensorleap/code-loader
 License: MIT

{code_loader-1.0.72.dev5.dist-info → code_loader-1.0.73.dist-info}/RECORD

@@ -1,7 +1,7 @@
 LICENSE,sha256=qIwWjdspQeSMTtnFZBC8MuT-95L02FPvzRUdWFxrwJY,1067
 code_loader/__init__.py,sha256=6MMWr0ObOU7hkqQKgOqp4Zp3I28L7joGC9iCbQYtAJg,241
 code_loader/contract/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-code_loader/contract/datasetclasses.py,sha256=2m9wyF_SO_q3kfrrAELS8rseMX-veeaP-Aof0ZhG_7g,7119
+code_loader/contract/datasetclasses.py,sha256=hmPqgQcXya-8iF2mV06Nc_mJQdLoks7L22Ew9qH01d8,7221
 code_loader/contract/enums.py,sha256=6Lo7p5CUog68Fd31bCozIuOgIp_IhSiPqWWph2k3OGU,1602
 code_loader/contract/exceptions.py,sha256=jWqu5i7t-0IG0jGRsKF4DjJdrsdpJjIYpUkN1F4RiyQ,51
 code_loader/contract/responsedataclasses.py,sha256=RSx9m_R3LawhK5o1nAcO3hfp2F9oJYtxZr_bpP3bTmw,4005
@@ -19,14 +19,14 @@ code_loader/experiment_api/types.py,sha256=MY8xFARHwdVA7p4dxyhD60ShmttgTvb4qdp1o
 code_loader/experiment_api/utils.py,sha256=XZHtxge12TS4H4-8PjV3sKuhp8Ud6ojAiIzTZJEqBqc,3304
 code_loader/experiment_api/workingspace_config_utils.py,sha256=DLzXQCg4dgTV_YgaSbeTVzq-2ja_SQw4zi7LXwKL9cY,990
 code_loader/inner_leap_binder/__init__.py,sha256=koOlJyMNYzGbEsoIbXathSmQ-L38N_pEXH_HvL7beXU,99
-code_loader/inner_leap_binder/leapbinder.py,sha256=-fryKzD8T8K2EgrOsR5NryabP8_1k_m3POLwhYIA_8I,26708
-code_loader/inner_leap_binder/leapbinder_decorators.py,sha256=ebMxknpKMW-dE8Erq0fFq4RrE5E_Jfx9IvmRRZSdhlc,20813
+code_loader/inner_leap_binder/leapbinder.py,sha256=0l9zjlF27tZwg6SnpyqVoAAgf9QHQcKpR9lg7vho2Xw,27065
+code_loader/inner_leap_binder/leapbinder_decorators.py,sha256=B-XSw4xYF39kMPnMTRNKMYFg09whnfl7VSbcx195VG8,21626
 code_loader/leaploader.py,sha256=he1c46jQNrCBEBq03gQDS0WVxiX7nlGAE9_9hLagxQc,24973
 code_loader/leaploaderbase.py,sha256=VH0vddRmkqLtcDlYPCO7hfz1_VbKo43lUdHDAbd4iJc,4198
 code_loader/utils.py,sha256=aw2i_fqW_ADjLB66FWZd9DfpCQ7mPdMyauROC5Nd51I,2197
 code_loader/visualizers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 code_loader/visualizers/default_visualizers.py,sha256=Ffx5VHVOe5ujBOsjBSxN_aIEVwFSQ6gbhTMG5aUS-po,2305
-code_loader-1.0.72.dev5.dist-info/LICENSE,sha256=qIwWjdspQeSMTtnFZBC8MuT-95L02FPvzRUdWFxrwJY,1067
-code_loader-1.0.72.dev5.dist-info/METADATA,sha256=IuNmOiTSxEC2A_-cCOc06mXUHiZPaf-Wg71eT28YGJE,854
-code_loader-1.0.72.dev5.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-code_loader-1.0.72.dev5.dist-info/RECORD,,
+code_loader-1.0.73.dist-info/LICENSE,sha256=qIwWjdspQeSMTtnFZBC8MuT-95L02FPvzRUdWFxrwJY,1067
+code_loader-1.0.73.dist-info/METADATA,sha256=d7-FSiS0YvfmoWlJZyqlf644v1SuNGf-_MfunY5KYcA,849
+code_loader-1.0.73.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+code_loader-1.0.73.dist-info/RECORD,,