code-loader 1.0.178__py3-none-any.whl → 1.0.179.dev2__py3-none-any.whl

code_loader/inner_leap_binder/leapbinder_decorators.py

@@ -77,6 +77,13 @@ def store_warning_by_param(
         _PARAM_DEFAULT_DOCS[param_name] = link_to_docs
 
 
+def store_general_warning(*, key: tuple, message: str, link_to_docs: Optional[str] = None) -> None:
+    if key in _STORED_WARNING_KEYS:
+        return
+    _STORED_WARNING_KEYS.add(key)
+    _STORED_WARNINGS.append({"message": message, "link_to_docs": link_to_docs})
+
+
 def _get_param_default_warnings() -> Dict[str, Dict[str, Any]]:
     out: Dict[str, Dict[str, Any]] = {}
     for p, funcs in _PARAM_DEFAULT_FUNCS.items():
@@ -1226,9 +1233,8 @@ def tensorleap_metadata(
         def _validate_result(result):
             supported_result_types = (type(None), int, str, bool, float, dict, np.floating,
                                       np.bool_, np.unsignedinteger, np.signedinteger, np.integer)
-            if isinstance(result, tuple):
-                validate_output_structure(result, func_name=user_function.__name__,
-                                          expected_type_name=supported_result_types)
+            validate_output_structure(result, func_name=user_function.__name__,
+                                      expected_type_name=supported_result_types)
             assert isinstance(result, supported_result_types), \
                 (f'{user_function.__name__}() validation failed: '
                  f'Unsupported return type. Got {type(result)}. should be any of {str(supported_result_types)}')
@@ -1293,8 +1299,20 @@ def tensorleap_custom_latent_space():
 
         def _validate_result(result):
             assert isinstance(result, np.ndarray), \
-                (f'tensorleap_custom_loss validation failed: '
+                (f'tensorleap_custom_latent_space validation failed: '
                  f'The return type should be a numpy array. Got {type(result)}.')
+            if result.ndim > 1:
+                flat_dim = int(np.prod(result.shape))
+                store_general_warning(
+                    key=("tensorleap_custom_latent_space_flatten", tuple(result.shape)),
+                    message=(
+                        f"tensorleap_custom_latent_space returned per-sample shape {tuple(result.shape)} "
+                        f"(ndim={result.ndim}). Tensorleap assumes per-sample shape (d, ...) and will "
+                        f"flatten to ({flat_dim},) before downstream visualization and clustering. "
+                        f"If you want a different aggregation (e.g. global average pooling), do it "
+                        f"inside your function."
+                    ),
+                )
 
         def inner_without_validate(sample_id, preprocess_response):
             global _called_from_inside_tl_decorator
@@ -1978,7 +1996,8 @@ def tensorleap_status_table():
 
     def _print_param_default_warnings():
         data = _get_param_default_warnings()
-        if not data:
+        stored = _get_stored_warnings()
+        if not data and not stored:
             return
 
         print("\nWarnings (Default use. It is recommended to set values explicitly):")
@@ -1992,7 +2011,12 @@ def tensorleap_status_table():
             print(
                 f" ⚠️ Parameter '{param_name}' defaults to {dv} in the following functions: [{funcs}]. "
                 f"For more information, check {docs_part}")
-        print("\nIf this isn’t the intended behaviour, set them explicitly.")
+        for w in stored:
+            docs_link = w.get("link_to_docs")
+            docs_part = f" {_link(docs_link)}" if docs_link else ""
+            print(f" ⚠️ {w['message']}{docs_part}")
+        if data:
+            print("\nIf this isn’t the intended behaviour, set them explicitly.")
 
     def _print_table():
         _print_param_default_warnings()

{code_loader-1.0.178.dist-info → code_loader-1.0.179.dev2.dist-info}/METADATA

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

{code_loader-1.0.178.dist-info → code_loader-1.0.179.dev2.dist-info}/RECORD

@@ -21,7 +21,7 @@ code_loader/experiment_api/utils.py,sha256=XZHtxge12TS4H4-8PjV3sKuhp8Ud6ojAiIzTZ
 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=Xrwx0Kptcz2dmoHoZQ7kyyNmitsvAKoTBngIMBvh--I,37859
-code_loader/inner_leap_binder/leapbinder_decorators.py,sha256=ho-dkBiGZwbFnO9ewmD_GD5qrhX9IMrthZWa3O9Zk9g,99653
+code_loader/inner_leap_binder/leapbinder_decorators.py,sha256=M4DQKAI3PnxzxdjYkssOtbfqMvIT08CJS7LpKbzl4Uw,100896
 code_loader/leaploader.py,sha256=VSSxsU2KxHPo5SzN1bJtRXaz29IE0XNFxgrnAJyG3io,32162
 code_loader/leaploaderbase.py,sha256=NJGaas8S6JeHYSsKkMSutyfcSKdK9jXTic7BcjC5uNc,6303
 code_loader/mixpanel_tracker.py,sha256=U7eUGrPjc-2rgFG7isqosf65tKZkotQ0XKuAML_lIjA,9067
@@ -31,7 +31,7 @@ code_loader/plot_functions/visualize.py,sha256=gsBAYYkwMh7jIpJeDMPS8G4CW-pxwx6Lz
 code_loader/utils.py,sha256=YecipkdTA-VcE9F0RQcY9cFnY8P3AksPnHM2Db7xUSk,3972
 code_loader/visualizers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 code_loader/visualizers/default_visualizers.py,sha256=onRnLE_TXfgLN4o52hQIOOhUcFexGlqJ3xSpQDVLuZM,2604
-code_loader-1.0.178.dist-info/LICENSE,sha256=qIwWjdspQeSMTtnFZBC8MuT-95L02FPvzRUdWFxrwJY,1067
-code_loader-1.0.178.dist-info/METADATA,sha256=vDUil_6cHMsz68G3bzAUSup9G4nX3z96WDFW4EXz5lc,1090
-code_loader-1.0.178.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-code_loader-1.0.178.dist-info/RECORD,,
+code_loader-1.0.179.dev2.dist-info/LICENSE,sha256=qIwWjdspQeSMTtnFZBC8MuT-95L02FPvzRUdWFxrwJY,1067
+code_loader-1.0.179.dev2.dist-info/METADATA,sha256=SwqY8uUIwvKGedEGMdZZMUkMrZiVnrTn09nPGHy4D0c,1095
+code_loader-1.0.179.dev2.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+code_loader-1.0.179.dev2.dist-info/RECORD,,