holobench 1.2.0__py3-none-any.whl → 1.2.2__py3-none-any.whl

bencher/example/example_simple_float.py

@@ -26,6 +26,7 @@ def example_1D_float(
         result_vars=[ExampleBenchCfgOut.param.out_sin],
         description=example_1D_float.__doc__,
     )
+
     return bench
 
 

bencher/example/{example_meta.py → meta/example_meta.py}

@@ -78,12 +78,12 @@ class BenchMeta(bch.ParametrizedSweep):
     """This class uses bencher to display the multidimensional types bencher can represent"""
 
     float_vars = bch.IntSweep(
-        default=1, bounds=(0, 3), doc="The number of floating point variables that are swept"
+        default=1, bounds=(0, 4), doc="The number of floating point variables that are swept"
     )
     categorical_vars = bch.IntSweep(
         default=1, bounds=(0, 3), doc="The number of categorical variables that are swept"
     )
-    sample_with_repeats = bch.IntSweep(default=1, bounds=(1, 2))
+    sample_with_repeats = bch.IntSweep(default=1, bounds=(1, 10))
 
     sample_over_time = bch.BoolSweep(default=False)
 
@@ -143,16 +143,16 @@ class BenchMeta(bch.ParametrizedSweep):
 def example_meta(
     run_cfg: bch.BenchRunCfg = bch.BenchRunCfg(), report: bch.BenchReport = bch.BenchReport()
 ) -> bch.Bench:
-    bench = bch.Bench("bench_meta", BenchMeta(), report=report, run_cfg=run_cfg)
+    bench = BenchMeta().to_bench(run_cfg, report)
 
     bench.plot_sweep(
         title="Meta Bench",
         description="""## All Combinations of Variable Sweeps and Resulting Plots
 This uses bencher to display all the combinatios of plots bencher is able to produce""",
         input_vars=[
-            BenchMeta.param.float_vars,
+            BenchMeta.param.float_vars.with_sample_values([0, 1, 2, 3]),
             BenchMeta.param.categorical_vars,
-            BenchMeta.param.sample_with_repeats,
+            BenchMeta.param.sample_with_repeats.with_sample_values([1, 2]),
             # BenchMeta.param.sample_over_time,
         ],
         const_vars=[

bencher/example/meta/example_meta_cat.py

@@ -0,0 +1,25 @@
+import bencher as bch
+from bencher.example.meta.example_meta import BenchMeta
+
+
+def example_meta_cat(
+    run_cfg: bch.BenchRunCfg = bch.BenchRunCfg(), report: bch.BenchReport = bch.BenchReport()
+) -> bch.Bench:
+    bench = BenchMeta().to_bench(run_cfg, report)
+
+    bench.plot_sweep(
+        title="Sweeping Categorical Variables",
+        input_vars=[
+            BenchMeta.param.categorical_vars.with_sample_values([1, 2, 3]),
+            BenchMeta.param.sample_with_repeats.with_sample_values([1, 2]),
+        ],
+        const_vars=[
+            BenchMeta.param.float_vars.with_const(0),
+        ],
+    )
+
+    return bench
+
+
+if __name__ == "__main__":
+    example_meta_cat().report.show()

bencher/example/meta/example_meta_float.py

@@ -0,0 +1,23 @@
+import bencher as bch
+from bencher.example.meta.example_meta import BenchMeta
+
+
+def example_meta_float(
+    run_cfg: bch.BenchRunCfg = bch.BenchRunCfg(), report: bch.BenchReport = bch.BenchReport()
+) -> bch.Bench:
+    bench = BenchMeta().to_bench(run_cfg, report)
+
+    bench.plot_sweep(
+        title="Sweeping Floating Point Variables",
+        input_vars=[BenchMeta.param.float_vars.with_sample_values([1, 2, 3, 4])],
+        const_vars=[
+            BenchMeta.param.categorical_vars.with_const(0),
+            BenchMeta.param.level.with_const(3),
+        ],
+    )
+
+    return bench
+
+
+if __name__ == "__main__":
+    example_meta_float().report.show()

bencher/example/{example_meta_levels.py → meta/example_meta_levels.py}

@@ -1,11 +1,11 @@
 import bencher as bch
-from bencher.example.example_meta import BenchMeta
+from bencher.example.meta.example_meta import BenchMeta
 
 
 def example_meta_levels(
     run_cfg: bch.BenchRunCfg = bch.BenchRunCfg(), report: bch.BenchReport = bch.BenchReport()
 ) -> bch.Bench:
-    bench = bch.Bench("bench_meta", BenchMeta(), report=report, run_cfg=run_cfg)
+    bench = BenchMeta().to_bench(run_cfg, report)
 
     bench.plot_sweep(
         title="Using Levels to define sample density",

bencher/results/bench_result_base.py

@@ -4,7 +4,6 @@ from enum import Enum, auto
 import xarray as xr
 from param import Parameter
 import holoviews as hv
-import numpy as np
 from functools import partial
 from bencher.utils import int_to_col, color_tuple_to_css
 
@@ -59,37 +58,39 @@ class BenchResultBase(OptunaResult):
             hv.Dataset: results in the form of a holoviews dataset
         """
 
+        if reduce == ReduceType.NONE:
+            kdims = [i.name for i in self.bench_cfg.all_vars]
+            return hv.Dataset(self.to_dataset(reduce, result_var), kdims=kdims)
+        return hv.Dataset(self.to_dataset(reduce, result_var))
+
+    def to_dataset(
+        self, reduce: ReduceType = ReduceType.AUTO, result_var: ResultVar = None
+    ) -> xr.Dataset:
+        """Generate a summarised xarray dataset.
+
+        Args:
+            reduce (ReduceType, optional): Optionally perform reduce options on the dataset.  By default the returned dataset will calculate the mean and standard devation over the "repeat" dimension so that the dataset plays nicely with most of the holoviews plot types.  Reduce.Sqeeze is used if there is only 1 repeat and you want the "reduce" variable removed from the dataset. ReduceType.None returns an unaltered dataset. Defaults to ReduceType.AUTO.
+
+        Returns:
+            xr.Dataset: results in the form of an xarray dataset
+        """
         if reduce == ReduceType.AUTO:
             reduce = ReduceType.REDUCE if self.bench_cfg.repeats > 1 else ReduceType.SQUEEZE
 
-        vdims = [r.name for r in self.bench_cfg.result_vars]
-        kdims = [i.name for i in self.bench_cfg.all_vars]
-
         ds = self.ds if result_var is None else self.ds[result_var.name]
+
         match (reduce):
             case ReduceType.REDUCE:
-                # if result_var
-                vdims = []
-                non_sum = []
-                for r in self.bench_cfg.result_vars:
-                    if isinstance(r, ResultVar):
-                        vdims.append(r.name)
-                    else:
-                        non_sum.append(r.name)
-
-                ds_num = ds.drop_vars(non_sum)
-                return hv.Dataset(ds_num, kdims=kdims, vdims=vdims).reduce(
-                    ["repeat"], np.mean, np.std
-                )
+                ds_reduce_mean = ds.mean(dim="repeat", keep_attrs=True)
+                ds_reduce_std = ds.std(dim="repeat", keep_attrs=True)
+
+                for v in ds_reduce_mean.data_vars:
+                    ds_reduce_mean[f"{v}_std"] = ds_reduce_std[v]
+                return ds_reduce_mean
             case ReduceType.SQUEEZE:
-                return hv.Dataset(ds.squeeze(drop=True), vdims=vdims)
+                return ds.squeeze(drop=True)
             case _:
-                return hv.Dataset(ds, kdims=kdims, vdims=vdims)
-
-    def to_dataset(
-        self, reduce: ReduceType = ReduceType.AUTO, result_var: ResultVar = None
-    ) -> xr.Dataset:
-        return self.to_hv_dataset(reduce=reduce, result_var=result_var).data
+                return ds
 
     def get_optimal_vec(
         self,

bencher/variables/parametrised_sweep.py

@@ -16,6 +16,7 @@ from bencher.variables.results import (
     ResultContainer,
     ResultReference,
 )
+
 from uuid import uuid4
 
 
@@ -206,3 +207,13 @@ class ParametrizedSweep(Parameterized):
 
     def gen_image_path(self, image_name: str, filetype=".png") -> str:
         return self.gen_path(image_name, "img", filetype)
+
+    def to_bench(self, run_cfg=None, report=None, name: str = None):
+        from bencher import Bench
+
+        assert isinstance(self, ParametrizedSweep)
+
+        if name is None:
+            name = self.name
+
+        return Bench(name, self, run_cfg=run_cfg, report=report)

{holobench-1.2.0.dist-info → holobench-1.2.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: holobench
-Version: 1.2.0
+Version: 1.2.2
 Summary: A package for benchmarking the performance of arbitrary functions
 Author-email: Austin Gregg-Smith <blooop@gmail.com>
 Requires-Python: >=3.10
@@ -8,14 +8,14 @@ Description-Content-Type: text/markdown
 Requires-Dist: holoviews>=1.15,<=1.18.1
 Requires-Dist: numpy>=1.0,<=1.26.2
 Requires-Dist: param>=1.13.0,<=2.0.1
-Requires-Dist: hvplot>=0.8,<=0.9.0
+Requires-Dist: hvplot>=0.8,<=0.9.1
 Requires-Dist: panel>=1.2.3,<1.4
 Requires-Dist: diskcache>=5.6,<=5.6.3
-Requires-Dist: optuna>=3.2,<=3.4.0
-Requires-Dist: xarray>=2023.7,<=2023.11.0
+Requires-Dist: optuna>=3.2,<=3.5.0
+Requires-Dist: xarray>=2023.7,<=2023.12.0
 Requires-Dist: plotly>=5.15,<=5.18.0
 Requires-Dist: sortedcontainers>=2.4,<=2.4
-Requires-Dist: pandas>=2.0,<=2.1.3
+Requires-Dist: pandas>=2.0,<=2.1.4
 Requires-Dist: strenum>=0.4.0,<=0.4.15
 Requires-Dist: seaborn>=0.12.1,<=0.13.0
 Requires-Dist: scikit-learn>=1.2,<=1.3.2
@@ -23,13 +23,13 @@ Requires-Dist: str2bool>=1.1,<=1.1
 Requires-Dist: mortgage>=1.0.5,<=1.0.5
 Requires-Dist: scoop>=0.7.0,<=0.7.2.0
 Requires-Dist: ffmpeg-downloader>=0.3.0,<=0.3.0
-Requires-Dist: black>=23,<=23.11.0 ; extra == "test"
-Requires-Dist: pylint>=2.16,<=3.0.2 ; extra == "test"
+Requires-Dist: black>=23,<=23.12.1 ; extra == "test"
+Requires-Dist: pylint>=2.16,<=3.0.3 ; extra == "test"
 Requires-Dist: pytest-cov>=4.1,<=4.1 ; extra == "test"
 Requires-Dist: pytest>=7.4,<=7.4.3 ; extra == "test"
-Requires-Dist: hypothesis>=6.82,<=6.91.0 ; extra == "test"
-Requires-Dist: ruff>=0.0.280,<=0.1.6 ; extra == "test"
-Requires-Dist: coverage>=7.2.7,<=7.3.2 ; extra == "test"
+Requires-Dist: hypothesis>=6.82,<=6.92.2 ; extra == "test"
+Requires-Dist: ruff>=0.0.280,<=0.1.9 ; extra == "test"
+Requires-Dist: coverage>=7.2.7,<=7.4.0 ; extra == "test"
 Project-URL: Home, https://github.com/dyson-ai/bencher
 Project-URL: Source, https://github.com/dyson-ai/bencher
 Provides-Extra: test

{holobench-1.2.0.dist-info → holobench-1.2.2.dist-info}/RECORD

@@ -23,15 +23,13 @@ bencher/example/example_holosweep_objects.py,sha256=vHuAtkM1VrJelHOazn_SJfzxNywK
 bencher/example/example_holosweep_tap.py,sha256=3ayQ0bTj_XWP_92ifQJAhe1whwPAj_xWHPkzC7fvqAY,4540
 bencher/example/example_image.py,sha256=xB1Y3J1kkOaJV--SXAEU3pfhZtXUo1oSIcfT1N9L-OE,2734
 bencher/example/example_levels.py,sha256=rpSNB571yfMnT7iO66Ds-DPGHWzOTM9FLMNfSetJdHY,6896
-bencher/example/example_meta.py,sha256=MAoaOMueLEi7QLY5iQwRjeIJvGhSBo2pOTYCgKh8zUc,5704
-bencher/example/example_meta_levels.py,sha256=6qR36qVJ6WBXLm9OJU01BGiT-Se9zi2OPlSh_xS-SdI,1449
 bencher/example/example_pareto.py,sha256=yyAg8Vb-5sgsS6LkYKT7T5Evcfg69FlCqCakUippSmU,2687
 bencher/example/example_sample_cache.py,sha256=7gf1BJ63VAgdqNuNXkbL9-jeTeC3kXA_PY9yG3ulTz0,4200
 bencher/example/example_sample_cache_context.py,sha256=IAUBbL78QM20R8evaq7L8I-xPxFDFykF1Gk1y2Ru1W0,4063
 bencher/example/example_simple.py,sha256=Nn2ixNx29jbgvwH2K5vDGhSFcqKLMNaP1occPxhHoU0,11703
 bencher/example/example_simple_bool.py,sha256=36KMSHyXZhzS1cp2TZnDLn7-GpShLdQ7mycuT0M3le8,1247
 bencher/example/example_simple_cat.py,sha256=YFccE84g37U2M3ByWYIcGNLXWdW_ktJbbZvGL0D6oHA,1759
-bencher/example/example_simple_float.py,sha256=ZI0L66Ff6DD2QPLGxpqDrOBfdD_f2W5Dft_FfqTWFpI,1322
+bencher/example/example_simple_float.py,sha256=X4vsH0F4fZAoO0EKB1xIzFMY0f0Wyk8LV2plPlSEsbI,1323
 bencher/example/example_strings.py,sha256=BdsEZgLT9mOxLkBKNHz2XpPwwe4SzNTdjnY1WVlOmNM,1570
 bencher/example/example_time_event.py,sha256=y1vpK7UDrObEu0Z1x3e4OQzvGCQ7pF5GZvpKLegMbYk,2158
 bencher/example/example_video.py,sha256=ZvmaJUnIw-0v8nInbUrpv6qtp1HXEGLHrGiffPwzGWU,3389
@@ -45,6 +43,10 @@ bencher/example/experimental/example_streams.py,sha256=rrTmcmxDlirGoyTbJ4LT4fBIA
 bencher/example/experimental/example_template.py,sha256=XdIVS9RtLdE5GNnerWiZMXvP7n17lzuc_YTLqJTwb6Q,1172
 bencher/example/experimental/example_updates.py,sha256=rF4UgWY-CW6ohNtOpQklTuwbwVRvEM5j6edZOiMkspQ,1835
 bencher/example/experimental/example_vector.py,sha256=3o_1dA4dc2HL6uIEvDAcvLPVJB8jgkq1QZ3BQIL-LEo,3118
+bencher/example/meta/example_meta.py,sha256=OpresXooPvkSVI3mfExqiATyGvd3o5x-dmIjhTH5Zf4,5734
+bencher/example/meta/example_meta_cat.py,sha256=YKVUiZ7M1tFFYgUTVQZeOe-1bnmxOjLdWy3nmCoyEe0,693
+bencher/example/meta/example_meta_float.py,sha256=GjfO1HfbCb0zscZ83U3PpD8QNffnsx1ZVC5I3hrJJd8,653
+bencher/example/meta/example_meta_levels.py,sha256=HNkb7Qej3rlf3blp2XoV-Od4c6sgRoM9aIQnBI5hv9I,1423
 bencher/example/mortgage/example_investment.py,sha256=agWmuFAt3fDimGAcgJBNIQO0OBA1w0ssotuyvWaKREQ,2025
 bencher/example/mortgage/example_mortgage.py,sha256=I4LD7BD8sxCYoDsgG5BynN3rRiyDAZqGcZySz94qYD0,2355
 bencher/example/mortgage/example_mortgage_simulator.py,sha256=OXFYYBYqgXdO_IHsf_cELqWqi_CCGfKnaZ9gUrF5cgA,8663
@@ -58,16 +60,16 @@ bencher/plotting/plot_filter.py,sha256=Zff02hEcRffiqDEoXUHVZQJK5kW4HbMxe2GYCrxI8
 bencher/plotting/plt_cnt_cfg.py,sha256=BkiAsgHm35Mqb5OsjULGVK0Q6pGZ0WSsJxxwSOrbaQs,3124
 bencher/results/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bencher/results/bench_result.py,sha256=O0RxxUoudT43zukIKEmwaj8Q156UrEfwyj8NGFFwI0c,2797
-bencher/results/bench_result_base.py,sha256=8_cLabvqWh0cm5xLyFMwE71FOxRbWTMOEpfUbm13dJc,12997
+bencher/results/bench_result_base.py,sha256=2Ds1KKCv17vMJ7cJwwmmWPPsUde2augP466jxtUuvZs,13378
 bencher/results/holoview_result.py,sha256=h-Q48m2dkHLPmvHnxmREpzt7MzQ-6iYLWrURDdLPjOw,21310
 bencher/results/optuna_result.py,sha256=704l1eFJUQGTmnTaj2pIJ9ocRehLgu4PwMYmJU2rY9w,12399
 bencher/results/panel_result.py,sha256=Fkp7eWt7lzmnM5R6MdEsBeyGg7CEJmlSEHWzNujcIUc,3479
 bencher/results/plotly_result.py,sha256=vny-HPyWIWzsLWQaOvMswtgVDub9bgQzqcartlFCqjI,2368
 bencher/variables/inputs.py,sha256=5yN45tet1cPyok6R_XD8xn1FZB5OUUp_TWWF2wIVVdg,6247
-bencher/variables/parametrised_sweep.py,sha256=fhKX4-LInKzZEb1VsGqkZ8XymNJTSGVx3e5ZoNCA5o8,7205
+bencher/variables/parametrised_sweep.py,sha256=q633o5zFY7P0ZeHX4G3AW3jYBfwoqLZZoUeibcln1u0,7483
 bencher/variables/results.py,sha256=yXdLjfGPSerWhipw_GDZJpBB8KQgCqcdreb8WjIeah8,5119
 bencher/variables/sweep_base.py,sha256=I1LEeG1y5Jsw0a-Ik03t0tSzcfENht2GmBECJ3KNs28,6559
 bencher/variables/time.py,sha256=Le7s8_oUYJD4wCqwQw-a_FRDpYQOi8CqMbGYsBF07jg,2860
-holobench-1.2.0.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
-holobench-1.2.0.dist-info/METADATA,sha256=EsC9x6fwiTqxlQZ6vcx5yc_D5XscdISfsewUbaoksF4,4991
-holobench-1.2.0.dist-info/RECORD,,
+holobench-1.2.2.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
+holobench-1.2.2.dist-info/METADATA,sha256=WHKNMDGXx8amGQvMSfJ17lxr4jMPjXaxZjG55M348cU,4991
+holobench-1.2.2.dist-info/RECORD,,