code-loader 1.0.71__py3-none-any.whl → 1.0.72__py3-none-any.whl

code_loader/contract/datasetclasses.py

@@ -132,7 +132,8 @@ class CustomLossHandler:
 class MetricHandlerData:
     name: str
     arg_names: List[str]
-    direction: Optional[MetricDirection] = MetricDirection.Downward
+    direction: Union[None, MetricDirection, Dict[str, MetricDirection]] = MetricDirection.Downward
+    compute_insights: Union[bool, Dict[str, bool]] = True
 
 
 @dataclass
@@ -171,6 +172,7 @@ class InputHandler(DatasetBaseHandler):
     shape: Optional[List[int]] = None
     channel_dim: Optional[int] = -1
 
+
 @dataclass
 class GroundTruthHandler(DatasetBaseHandler):
     shape: Optional[List[int]] = None

code_loader/contract/visualizer_classes.py

@@ -170,12 +170,13 @@ class LeapHorizontalBar:
     Example:
         body_data = np.random.rand(5).astype(np.float32)
         labels = ['Class A', 'Class B', 'Class C', 'Class D', 'Class E']
-        leap_horizontal_bar = LeapHorizontalBar(body=body_data, labels=labels)
+        gt_data = np.array([0.1, 0.2, 0.3, 0.4, 0.5]).astype(np.float32)
+        leap_horizontal_bar = LeapHorizontalBar(body=body_data, labels=labels, gt=gt_data)
     """
     body: npt.NDArray[np.float32]
     labels: List[str]
-    type: LeapDataType = LeapDataType.HorizontalBar
     gt: Optional[npt.NDArray[np.float32]] = None
+    type: LeapDataType = LeapDataType.HorizontalBar
 
 
     def __post_init__(self) -> None:

code_loader/inner_leap_binder/leapbinder.py

@@ -33,6 +33,7 @@ class LeapBinder:
     setup_container (DatasetIntegrationSetup): Container to hold setup configurations.
     cache_container (Dict[str, Any]): Cache container to store intermediate data.
     """
+
     def __init__(self) -> None:
         self.setup_container = DatasetIntegrationSetup()
         self.cache_container: Dict[str, Any] = {"word_to_index": {}}
@@ -239,23 +240,31 @@ class LeapBinder:
             leap_binder.add_custom_loss(custom_loss_function, name='custom_loss')
         """
         arg_names = inspect.getfullargspec(function)[0]
-        self.setup_container.custom_loss_handlers.append(CustomLossHandler(CustomLossHandlerData(name, arg_names), function))
+        self.setup_container.custom_loss_handlers.append(
+            CustomLossHandler(CustomLossHandlerData(name, arg_names), function))
 
     def add_custom_metric(self,
                           function: Union[CustomCallableInterfaceMultiArgs,
                           CustomMultipleReturnCallableInterfaceMultiArgs,
                           ConfusionMatrixCallableInterfaceMultiArgs],
                           name: str,
-                          direction: Optional[MetricDirection] = MetricDirection.Downward) -> None:
+                          direction: Optional[
+                              Union[MetricDirection, Dict[str, MetricDirection]]] = MetricDirection.Downward,
+                          compute_insights: Union[bool, Dict[str, bool]] = True) -> None:
         """
         Add a custom metric to the setup.
 
         Args:
         function (Union[CustomCallableInterfaceMultiArgs, CustomMultipleReturnCallableInterfaceMultiArgs, ConfusionMatrixCallableInterfaceMultiArgs]): The custom metric function.
         name (str): The name of the custom metric.
-        direction (Optional[MetricDirection]): The direction of the metric, either MetricDirection.Upward or MetricDirection.Downward.
+        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.
             - 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
+
 
 
         Example:
@@ -265,7 +274,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:
         """
@@ -377,7 +387,8 @@ class LeapBinder:
             custom_layer.kernel_index = kernel_index
 
         if use_custom_latent_space and not hasattr(custom_layer, custom_latent_space_attribute):
-            raise Exception(f"{custom_latent_space_attribute} function has not been set for custom layer: {custom_layer.__name__}")
+            raise Exception(
+                f"{custom_latent_space_attribute} function has not been set for custom layer: {custom_layer.__name__}")
 
         init_args = inspect.getfullargspec(custom_layer.__init__)[0][1:]
         call_args = inspect.getfullargspec(custom_layer.call)[0][1:]
@@ -490,7 +501,3 @@ class LeapBinder:
 
     def set_batch_size_to_validate(self, batch_size: int) -> None:
         self.batch_size_to_validate = batch_size
-
-
-
-

code_loader/inner_leap_binder/leapbinder_decorators.py

@@ -1,6 +1,6 @@
 # mypy: ignore-errors
 
-from typing import Optional, Union, Callable, List
+from typing import Optional, Union, Callable, List, Dict
 
 import numpy as np
 import numpy.typing as npt
@@ -15,18 +15,18 @@ from code_loader.contract.visualizer_classes import LeapImage, LeapImageMask, Le
     LeapHorizontalBar, LeapImageWithBBox, LeapImageWithHeatmap
 
 
-def tensorleap_custom_metric(name: str, direction: Optional[MetricDirection] = MetricDirection.Downward):
-    def decorating_function(
-            user_function: Union[CustomCallableInterfaceMultiArgs,
-            CustomMultipleReturnCallableInterfaceMultiArgs,
-            ConfusionMatrixCallableInterfaceMultiArgs]
-    ):
+def tensorleap_custom_metric(name: str,
+                             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]):
         for metric_handler in leap_binder.setup_container.metrics:
             if metric_handler.metric_handler_data.name == name:
                 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):
@@ -76,6 +76,19 @@ def tensorleap_custom_metric(name: str, direction: Optional[MetricDirection] = M
                         (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)
 
@@ -356,15 +369,15 @@ def tensorleap_custom_loss(name: str):
                                                                f'Element #{y} of list should be a numpy array. Got {type(elem)}.')
                 else:
                     assert isinstance(arg, valid_types), (f'tensorleap_custom_loss validation failed: '
-                                                        f'Argument #{i} should be a numpy array. Got {type(arg)}.')
+                                                          f'Argument #{i} should be a numpy array. Got {type(arg)}.')
             for _arg_name, arg in kwargs.items():
                 if isinstance(arg, list):
                     for y, elem in enumerate(arg):
-                        assert isinstance(elem,valid_types), (f'tensorleap_custom_loss validation failed: '
-                                                             f'Element #{y} of list should be a numpy array. Got {type(elem)}.')
+                        assert isinstance(elem, valid_types), (f'tensorleap_custom_loss validation failed: '
+                                                               f'Element #{y} of list should be a numpy array. Got {type(elem)}.')
                 else:
                     assert isinstance(arg, valid_types), (f'tensorleap_custom_loss validation failed: '
-                                                        f'Argument #{_arg_name} should be a numpy array. Got {type(arg)}.')
+                                                          f'Argument #{_arg_name} should be a numpy array. Got {type(arg)}.')
 
         def _validate_result(result):
             assert isinstance(result, valid_types), \

{code_loader-1.0.71.dist-info → code_loader-1.0.72.dist-info}/METADATA

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

{code_loader-1.0.71.dist-info → code_loader-1.0.72.dist-info}/RECORD

@@ -1,11 +1,11 @@
 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=L_fSdSvf-eKoez2uBJ8VjfrKedEP0szNOPvaUvsWeRQ,6973
+code_loader/contract/datasetclasses.py,sha256=vnxcit0LKNdXAMQi4EhjDiUpwsavAw2YMcEwNwmCsJo,7063
 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
-code_loader/contract/visualizer_classes.py,sha256=WpO5KF4FMGGMgsF1vIs7nbVev_Mr5-VE9XPakDk87zM,14092
+code_loader/contract/visualizer_classes.py,sha256=m31lg2P2QJs3Reqr6-N1AlVhH3RxPr772Jw3LuIVCVM,14177
 code_loader/default_losses.py,sha256=NoOQym1106bDN5dcIk56Elr7ZG5quUHArqfP5-Nyxyo,1139
 code_loader/default_metrics.py,sha256=v16Mrt2Ze1tXPgfKywGVdRSrkaK4CKLNQztN1UdVqIY,5010
 code_loader/experiment_api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -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=o57Pj-iY61-OBuTjK-jYUKCJ0g2pPWbbqitv_e75Bps,25959
-code_loader/inner_leap_binder/leapbinder_decorators.py,sha256=S4XHoC4GVicUIhM0UAAsQ6qVmztD52L-Uxa-6OcZptA,20780
+code_loader/inner_leap_binder/leapbinder.py,sha256=qBpN_hNANcXi6ilPBauBBWSmMt3tl4Ha5JkLe1dPzjE,26571
+code_loader/inner_leap_binder/leapbinder_decorators.py,sha256=B-XSw4xYF39kMPnMTRNKMYFg09whnfl7VSbcx195VG8,21626
 code_loader/leaploader.py,sha256=GWlpvgSsCWevP2BwwFBKTImQeDgHAQg1lMU9bqFMwRw,22315
 code_loader/leaploaderbase.py,sha256=aHlqWDZRacIdBefeB9goYVnpApaNN2FT24uPIWKkCeQ,3090
 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.71.dist-info/LICENSE,sha256=qIwWjdspQeSMTtnFZBC8MuT-95L02FPvzRUdWFxrwJY,1067
-code_loader-1.0.71.dist-info/METADATA,sha256=5tErPPtvKSmWqVro-YKhWqz6CbGT4z-8KNVYZdDqtGY,849
-code_loader-1.0.71.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-code_loader-1.0.71.dist-info/RECORD,,
+code_loader-1.0.72.dist-info/LICENSE,sha256=qIwWjdspQeSMTtnFZBC8MuT-95L02FPvzRUdWFxrwJY,1067
+code_loader-1.0.72.dist-info/METADATA,sha256=YRI0I_t6gfDnauY5w93AZSY1aAILsGSJujWfEFxErY4,849
+code_loader-1.0.72.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+code_loader-1.0.72.dist-info/RECORD,,

{code_loader-1.0.71.dist-info → code_loader-1.0.72.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.9.1
+Generator: poetry-core 1.9.0
 Root-Is-Purelib: true
 Tag: py3-none-any