[nsys-jax] Add ratio of hidden communication time to total communication time

.github/container/nsys_jax/nsys_jax/analyses/communication.py

@@ -8,6 +8,7 @@
     load_profiler_data,
 )
 from math import sqrt
+from prettytable import PrettyTable
 import pathlib
 from uncertainties import ufloat  # type: ignore
 
@@ -95,6 +96,29 @@ def format_bandwidth(data, collective):
             )
         )
 
+    collective_types = set()
+    summary_data = defaultdict(dict)
+    for collective, df in steady_state.communication.groupby(["Collective"]):
+        collective_types.add(collective)
+        summary_data[collective] = df["DurHiddenMsToDurMs"].mean()
+
+    table = PrettyTable()
+    table.field_names = ["Collective", "Mean HiddenToTotalMs"]
+
+    for collective in collective_types:
+        mean_value = summary_data[collective]
+        table.add_row([collective[0], mean_value])
+    print(table)
+
+    overall_hidden_ms_to_total_ms = (
+        steady_state.communication["ProjDurHiddenMs"].sum()
+        / (
+            steady_state.communication["ProjDurMs"]
+            + steady_state.communication["ProjDurHiddenMs"]
+        ).sum()
+    )
+    print(f"Overall HiddenMs to TotalMs: {overall_hidden_ms_to_total_ms}")
+
 
 if __name__ == "__main__":
     main()

.github/container/nsys_jax/nsys_jax/analysis.py

@@ -331,6 +331,9 @@ def calculate_collective_metrics(
     comm_df["BusBandwidthGBPerSec"] = (
         comm_df["AlgorithmBandwidthGBPerSec"] * comm_df["BusBandwidthCorrection"]
     )
+    comm_df["DurHiddenMsToDurMs"] = comm_df["ProjDurHiddenMs"] / (
+        comm_df["ProjDurMs"] + comm_df["ProjDurHiddenMs"]
+    )
     return comm_df.drop(columns=["BandwidthCorrection", "BusBandwidthCorrection"])
 
 

.github/container/nsys_jax/pyproject.toml

@@ -9,6 +9,7 @@ dependencies = [
   "pyarrow",
   "requests", # for install-protoc
   "uncertainties", # communication analysis recipe
+  "prettytable",
 ]
 requires-python = ">= 3.10"