holobench 1.40.0__tar.gz → 1.40.1__tar.gz

{holobench-1.40.0 → holobench-1.40.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: holobench
-Version: 1.40.0
+Version: 1.40.1
 Summary: A package for benchmarking the performance of arbitrary functions
 Project-URL: Repository, https://github.com/dyson-ai/bencher
 Project-URL: Home, https://github.com/dyson-ai/bencher

{holobench-1.40.0 → holobench-1.40.1}/bencher/bench_cfg.py

@@ -8,15 +8,13 @@ from typing import List
 import param
 from str2bool import str2bool
 import panel as pn
-
+from datetime import datetime
 
 from bencher.variables.sweep_base import hash_sha1, describe_variable
 from bencher.variables.time import TimeSnapshot, TimeEvent
 from bencher.variables.results import OptDir
 from bencher.job import Executors
-from datetime import datetime
-
-# from bencher.results.bench_result import BenchResult
+from bencher.results.laxtex_result import to_latex
 
 
 class BenchPlotSrvCfg(param.Parameterized):
@@ -344,13 +342,32 @@ class BenchCfg(BenchRunCfg):
     def inputs_as_str(self) -> List[str]:
         return [i.name for i in self.input_vars]
 
-    def describe_sweep(self, width: int = 800, accordion=True) -> pn.pane.Markdown:
+    def to_latex(self):
+        return to_latex(self)
+
+    def describe_sweep(self, width: int = 800, accordion=True) -> pn.pane.Markdown | pn.Column:
         """Produce a markdown summary of the sweep settings"""
 
+        latex = self.to_latex()
         desc = pn.pane.Markdown(self.describe_benchmark(), width=width)
         if accordion:
-            return pn.Accordion(("Data Collection Parameters", desc))
-        return desc
+            desc = pn.Accordion(("Data Collection Parameters", desc))
+
+        sentence = self.sweep_sentence()
+        if latex is not None:
+            return pn.Column(sentence, latex, desc)
+        return pn.Column(sentence, latex, desc)
+
+    def sweep_sentence(self):
+        inputs = " by ".join([iv.name for iv in self.all_vars])
+
+        all_vars_lens = [len(iv.values()) for iv in reversed(self.all_vars)]
+        if len(all_vars_lens) == 1:
+            all_vars_lens.append(1)
+        result_sizes = "x".join([str(iv) for iv in all_vars_lens])
+        results = ", ".join([rv.name for rv in self.result_vars])
+
+        return f"Sweeping {inputs} to generate a {result_sizes} result dataframe containing {results}. "
 
     def describe_benchmark(self) -> str:
         """Generate a string summary of the inputs and results from a BenchCfg

{holobench-1.40.0 → holobench-1.40.1}/bencher/example/meta/generate_examples.py

@@ -48,7 +48,3 @@ if __name__ == "__main__":
     convert_example_to_jupyter_notebook(
         "/workspaces/bencher/bencher/example/inputs_1D/example_1_in_2_out_repeats.py", "1D"
     )
-
-    convert_example_to_jupyter_notebook(
-        "/workspaces/bencher/bencher/example/example_simple_float.py", "1D"
-    )

{holobench-1.40.0 → holobench-1.40.1}/bencher/example/meta/generate_meta.py

@@ -39,7 +39,7 @@ class BenchMetaGen(bch.ParametrizedSweep):
         inputs_vars_float = [
             "float1",
             "float2",
-            "float3",
+            bch.p("float3", max_level=3),
             "sigma",
         ]
 
@@ -107,10 +107,9 @@ def example_meta(run_cfg: bch.BenchRunCfg = None, report: bch.BenchReport = None
         description="""## All Combinations of Variable Sweeps and Resulting Plots
 This uses bencher to display all the combinations of plots bencher is able to produce""",
         input_vars=[
-            bch.p("float_vars", [0, 1, 2, 3]),
+            bch.p("float_vars", [0, 1]),
             "categorical_vars",
             bch.p("sample_with_repeats", [1, 20]),
-            # "sample_over_time",
         ],
         const_vars=[
             # BenchMeta.param.float_vars.with_const(1),
@@ -119,6 +118,31 @@ This uses bencher to display all the combinations of plots bencher is able to pr
             # BenchMeta.param.sample_over_time.with_const(True),
         ],
     )
+    bench.plot_sweep(
+        title="Meta Bench",
+        description="""## All Combinations of Variable Sweeps and Resulting Plots
+This uses bencher to display all the combinations of plots bencher is able to produce""",
+        input_vars=[
+            bch.p("float_vars", [2, 3]),
+            "categorical_vars",
+        ],
+    )
+
+    #     bench.plot_sweep(
+    #         title="Meta Bench",
+    #         description="""## All Combinations of Variable Sweeps and Resulting Plots
+    # This uses bencher to display all the combinations of plots bencher is able to produce""",
+    #         input_vars=[
+    #             bch.p("float_vars", [2, 3]),
+    #             "categorical_vars",
+    #         ],
+    #         const_vars=[
+    #             dict(level=3)
+    #             # BenchMeta.param.sample_with_repeats.with_const(2),
+    #             # BenchMeta.param.categorical_vars.with_const(2),
+    #             # BenchMeta.param.sample_over_time.with_const(True),
+    #         ],
+    #     )
 
     return bench
 

holobench-1.40.1/bencher/results/laxtex_result.py

@@ -0,0 +1,60 @@
+from __future__ import annotations
+import panel as pn
+from panel.pane import LaTeX
+from typing import Optional
+
+pn.extension("mathjax")
+
+
+def latex_text(var):
+    var_str = str(var)
+    return r"\text{" + var_str.replace("_", " ") + r"} \\"
+
+
+def input_var_to_latex(input_var):
+    vals = input_var.values()
+    displayed_vals = vals
+    if len(vals) > 5:
+        displayed_vals = [vals[i] for i in [0, 1, 0, -2, -1]]
+        displayed_vals[2] = "⋮"
+    v = r"\\ ".join([str(va) for va in displayed_vals])
+
+    latex_str = r"""\begin{array}{c}"""
+    latex_str += latex_text(input_var.name)
+    latex_str += f"{len(vals)}" + r"\times1 \\"
+    latex_str += r"\left[ \begin{array}{c}"
+    latex_str += f"{v} "
+    latex_str += r"\end{array} \right] \end{array}"
+    return latex_str
+
+
+def result_var_to_latex(bench_cfg):
+    latex_str = r"\begin{array}{c}"
+    sizes = [str(len(i.values())) for i in bench_cfg.all_vars]
+    if len(sizes) == 1:
+        sizes.insert(0, "1")
+    sizes_str = r"\times".join(reversed(sizes))
+    latex_str += sizes_str + r"\\ of \\"
+    latex_str += r" \left[\begin{array}{cc}"
+
+    for rv in bench_cfg.result_vars:
+        latex_str += latex_text(rv.name)
+    latex_str += r"\end{array} \right]"
+    latex_str += r"\end{array}"
+    return latex_str
+
+
+def to_latex(bench_cfg) -> Optional[pn.pane.LaTeX]:
+    if len(bench_cfg.all_vars) > 0:
+        latex_str = r"\["
+        for i, iv in enumerate(bench_cfg.all_vars):
+            latex_str += input_var_to_latex(iv)
+            if i != len(bench_cfg.all_vars) - 1:
+                latex_str += r"\bigtimes"
+
+        latex_str += r"\rightarrow\quad"
+        latex_str += result_var_to_latex(bench_cfg)
+        latex_str += r"\]"
+        # underscore represents subscript, so replace underscore with large space character \;
+        return LaTeX(latex_str.replace("_", r"\;"))
+    return None

{holobench-1.40.0 → holobench-1.40.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "holobench"
-version = "1.40.0"
+version = "1.40.1"
 
 authors = [{ name = "Austin Gregg-Smith", email = "blooop@gmail.com" }]
 description = "A package for benchmarking the performance of arbitrary functions"