halib 0.2.19__tar.gz → 0.2.21__tar.gz

{halib-0.2.19 → halib-0.2.21}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: halib
-Version: 0.2.19
+Version: 0.2.21
 Summary: Small library for common tasks
 Author: Hoang Van Ha
 Author-email: hoangvanhauit@gmail.com
@@ -56,6 +56,11 @@ Dynamic: summary
 
 ## v0.2.x (Experiment & Core Updates)
 
+### **v0.2.21**
+- ✨ **New Feature:** Added `common.common.pprint_stack_trace` to print stack traces with optional custom messages and force stop capability.
+
+- 🚀 **Improvement:**  `exp.perf.profiler` - allow to export *report dict* as csv files for further analysis
+
 ### **v0.2.19**
 - ✨ **New Feature:** Added `exp.core.param_gen` to facilitate fast generation of parameter combination sweeps (grid search) using YAML configurations.
 

{halib-0.2.19 → halib-0.2.21}/README.md

@@ -2,6 +2,11 @@
 
 ## v0.2.x (Experiment & Core Updates)
 
+### **v0.2.21**
+- ✨ **New Feature:** Added `common.common.pprint_stack_trace` to print stack traces with optional custom messages and force stop capability.
+
+- 🚀 **Improvement:**  `exp.perf.profiler` - allow to export *report dict* as csv files for further analysis
+
 ### **v0.2.19**
 - ✨ **New Feature:** Added `exp.core.param_gen` to facilitate fast generation of parameter combination sweeps (grid search) using YAML configurations.
 

{halib-0.2.19 → halib-0.2.21}/halib/__init__.py

@@ -19,11 +19,11 @@ __all__ = [
     "os",
     "pd",
     "plt",
-    "pprint",
     "pprint_box",
     "pprint_local_path",
+    "pprint_stack_trace",
+    "pprint",
     "px",
-    "pprint_local_path",
     "rcolor_all_str",
     "rcolor_palette_all",
     "rcolor_palette",
@@ -32,10 +32,10 @@ __all__ = [
     "rprint",
     "sns",
     "tcuda",
+    "time",
     "timebudget",
     "tqdm",
     "warnings",
-    "time",
 ]
 import warnings
 
@@ -64,7 +64,8 @@ from .common.common import (
     norm_str,
     pprint_box,
     pprint_local_path,
-    tcuda
+    pprint_stack_trace,
+    tcuda,
 )
 
 # for log
@@ -76,7 +77,12 @@ from timebudget import timebudget
 import omegaconf
 from omegaconf import OmegaConf
 from omegaconf.dictconfig import DictConfig
-from .common.rich_color import rcolor_str, rcolor_palette, rcolor_palette_all, rcolor_all_str
+from .common.rich_color import (
+    rcolor_str,
+    rcolor_palette,
+    rcolor_palette_all,
+    rcolor_all_str,
+)
 
 # for visualization
 import seaborn as sns

{halib-0.2.19 → halib-0.2.21}/halib/common/common.py

@@ -1,4 +1,5 @@
 import os
+import sys
 import re
 import arrow
 import importlib
@@ -10,6 +11,8 @@ from rich.console import Console
 from rich.pretty import pprint, Pretty
 
 from pathlib import Path, PureWindowsPath
+from typing import Optional
+from loguru import logger
 
 
 console = Console()
@@ -114,6 +117,32 @@ def linux_to_wins_path(path: str) -> str:
     return str(PureWindowsPath(win_path))
 
 
+DEFAULT_STACK_TRACE_MSG = "Caused by halib.common.common.pprint_stack_trace"
+
+
+def pprint_stack_trace(
+    msg: str = DEFAULT_STACK_TRACE_MSG,
+    e: Optional[Exception] = None,
+    force_stop: bool = False,
+):
+    """
+    Print the current stack trace or the stack trace of an exception.
+    """
+    try:
+        if e is not None:
+            raise e
+        else:
+            raise Exception("pprint_stack_trace called")
+    except Exception as e:
+        # attach the exception trace to a warning
+        global DEFAULT_STACK_TRACE_MSG
+        if len(msg.strip()) == 0:
+            msg = DEFAULT_STACK_TRACE_MSG
+        logger.opt(exception=e).warning(msg)
+        if force_stop:
+            console.rule("[red]Force Stop Triggered in <halib.common.pprint_stack_trace>[/red]")
+            sys.exit(1)
+
 def pprint_local_path(
     local_path: str, get_wins_path: bool = False, tag: str = ""
 ) -> str:

{halib-0.2.19 → halib-0.2.21}/halib/exp/perf/profiler.py

@@ -182,9 +182,9 @@ class zProfiler:
         │   │   │   [278091.230944486, 278091.251378469],
         │   }
         """
-        assert (
-            len(ctx_step_dict.keys()) > 0
-        ), "step_dict must have only one key (step_name) for detail."
+        assert len(ctx_step_dict.keys()) > 0, (
+            "step_dict must have only one key (step_name) for detail."
+        )
         normed_ctx_step_dict = {}
         for step_name, time_list in ctx_step_dict.items():
             if not isinstance(ctx_step_dict[step_name], list):
@@ -246,14 +246,126 @@ class zProfiler:
                 report_dict[ctx_name]["step_dict"]["summary"]["avg_time"][
                     f"avg_{step_name}"
                 ] = avg_time
-            report_dict[ctx_name]["step_dict"]["summary"][
-                "total_avg_time"
-            ] = total_avg_time
+            report_dict[ctx_name]["step_dict"]["summary"]["total_avg_time"] = (
+                total_avg_time
+            )
             report_dict[ctx_name]["step_dict"]["summary"] = dict(
                 sorted(report_dict[ctx_name]["step_dict"]["summary"].items())
             )
         return report_dict
 
+    def get_report_dataframes(self):
+        """
+        Returns two pandas DataFrames containing profiling data.
+
+        Returns:
+            tuple: (df_summary, df_detail)
+                - df_summary: Aggregated stats (Context, Step, Avg, %, Count)
+                - df_detail: Raw duration for every single iteration
+        """
+        try:
+            import pandas as pd
+        except ImportError:
+            logger.error(
+                "Pandas is required for get_pandas_dfs(). Please pip install pandas."
+            )
+            return None, None
+
+        # Get full data structure
+        data = self.get_report_dict(with_detail=True)
+
+        summary_rows = []
+        detail_rows = []
+
+        for ctx_name, ctx_data in data.items():
+            summary = ctx_data["step_dict"]["summary"]
+            detail_dict = ctx_data["step_dict"]["detail"]
+
+            # --- 1. Build Summary Data ---
+            # Iterate keys in 'avg_time' to ensure we capture all steps
+            for avg_key, avg_val in summary["avg_time"].items():
+                step_name = avg_key.replace("avg_", "")
+
+                # Get corresponding percent
+                per_key = f"per_{step_name}"
+                percent_val = summary["percent_time"].get(per_key, 0.0)
+
+                # Get sample count from detail list length
+                count = len(detail_dict.get(step_name, []))
+
+                summary_rows.append(
+                    {
+                        "context_name": ctx_name,
+                        "step_name": step_name,
+                        "avg_time_sec": avg_val,
+                        "percent_total": percent_val,
+                        "sample_count": count,
+                    }
+                )
+
+            # --- 2. Build Detail Data ---
+            for step_name, time_list in detail_dict.items():
+                # time_list format: [(idx, duration), (idx, duration)...]
+                for item in time_list:
+                    if len(item) == 2:
+                        idx, duration = item
+                        detail_rows.append(
+                            {
+                                "context_name": ctx_name,
+                                "step_name": step_name,
+                                "iteration_idx": idx,
+                                "duration_sec": duration,
+                            }
+                        )
+
+        # Create DataFrames
+        df_summary = pd.DataFrame(summary_rows)
+        df_detail = pd.DataFrame(detail_rows)
+
+        # Reorder columns for readability (optional but nice)
+        if not df_summary.empty:
+            df_summary = df_summary[
+                [
+                    "context_name",
+                    "step_name",
+                    "avg_time_sec",
+                    "percent_total",
+                    "sample_count",
+                ]
+            ]
+
+        if not df_detail.empty:
+            df_detail = df_detail[
+                ["context_name", "step_name", "iteration_idx", "duration_sec"]
+            ]
+
+        return df_summary, df_detail
+
+    def get_report_csv_files(self, outdir, tag="profiler"):
+        """
+        Exports profiling data to two CSV files:
+        1. {tag}_summary.csv: Aggregated stats (Avg time, %)
+        2. {tag}_detailed_logs.csv: Raw duration for every iteration
+
+        Args:
+            outdir (str): Directory to save files.
+            tag (str): Optional prefix for filenames.
+        """
+
+        if not os.path.exists(outdir):
+            os.makedirs(outdir)
+        tag_str = f"{tag}_" if tag else ""
+        summary_file = os.path.join(outdir, f"{tag_str}summary.csv")
+        detail_file = os.path.join(outdir, f"{tag_str}detailed_logs.csv")
+
+        df_summary, df_detail = self.get_report_dataframes()
+        if df_summary is not None:
+            df_summary.to_csv(summary_file, index=False, sep=";", encoding="utf-8")
+            logger.info(f"Saved summary CSV to: {summary_file}")
+        if df_detail is not None:
+            df_detail.to_csv(detail_file, index=False, sep=";", encoding="utf-8")
+            logger.info(f"Saved detailed logs CSV to: {detail_file}")
+
     @classmethod
     def plot_formatted_data(
         cls, profiler_data, outdir=None, file_format="png", do_show=False, tag=""
@@ -282,9 +394,13 @@ class zProfiler:
 
             assert n_steps > 0, "No steps found for context: {}".format(ctx)
             # Generate dynamic colors
-            colors = px.colors.sample_colorscale(
-                "Viridis", [i / (n_steps - 1) for i in range(n_steps)]
-            ) if n_steps > 1 else [px.colors.sample_colorscale("Viridis", [0])[0]]
+            colors = (
+                px.colors.sample_colorscale(
+                    "Viridis", [i / (n_steps - 1) for i in range(n_steps)]
+                )
+                if n_steps > 1
+                else [px.colors.sample_colorscale("Viridis", [0])[0]]
+            )
             # pprint(f'{len(colors)} colors generated for {n_steps} steps')
             color_map = dict(zip(step_names, colors))
 
@@ -301,7 +417,7 @@ class zProfiler:
                 go.Bar(
                     x=step_names,
                     y=list(avg_times.values()),
-                    text=[f"{v*1000:.2f} ms" for v in avg_times.values()],
+                    text=[f"{v * 1000:.2f} ms" for v in avg_times.values()],
                     textposition="outside",
                     marker=dict(color=[color_map[s] for s in step_names]),
                     name="",  # unified legend
@@ -345,7 +461,9 @@ class zProfiler:
             # Save figure
             if outdir is not None:
                 file_prefix = ctx if len(tag_str) == 0 else f"{tag_str}_{ctx}"
-                file_path = os.path.join(outdir, f"{file_prefix}_summary.{file_format.lower()}")
+                file_path = os.path.join(
+                    outdir, f"{file_prefix}_summary.{file_format.lower()}"
+                )
                 fig.write_image(file_path)
                 pprint(f"Saved figure to: 🔽")
                 pprint_local_path(file_path)
@@ -368,6 +486,7 @@ class zProfiler:
         return self.plot_formatted_data(
             report, outdir=outdir, file_format=file_format, do_show=do_show, tag=tag
         )
+
     def meta_info(self):
         """
         Print the structure of the profiler's time dictionary.
@@ -375,7 +494,7 @@ class zProfiler:
         """
         for ctx_name, ctx_dict in self.time_dict.items():
             with ConsoleLog(f"Context: {ctx_name}"):
-                step_names = list(ctx_dict['step_dict'].keys())
+                step_names = list(ctx_dict["step_dict"].keys())
                 for step_name in step_names:
                     pprint(f"Step: {step_name}")
 

{halib-0.2.19 → halib-0.2.21}/halib.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: halib
-Version: 0.2.19
+Version: 0.2.21
 Summary: Small library for common tasks
 Author: Hoang Van Ha
 Author-email: hoangvanhauit@gmail.com
@@ -56,6 +56,11 @@ Dynamic: summary
 
 ## v0.2.x (Experiment & Core Updates)
 
+### **v0.2.21**
+- ✨ **New Feature:** Added `common.common.pprint_stack_trace` to print stack traces with optional custom messages and force stop capability.
+
+- 🚀 **Improvement:**  `exp.perf.profiler` - allow to export *report dict* as csv files for further analysis
+
 ### **v0.2.19**
 - ✨ **New Feature:** Added `exp.core.param_gen` to facilitate fast generation of parameter combination sweeps (grid search) using YAML configurations.
 

{halib-0.2.19 → halib-0.2.21}/setup.py

@@ -8,7 +8,7 @@ with open("requirements.txt", "r", encoding="utf-8") as f:
 
 setuptools.setup(
     name="halib",
-    version="0.2.19",
+    version="0.2.21",
     author="Hoang Van Ha",
     author_email="hoangvanhauit@gmail.com",
     description="Small library for common tasks",