holobench 1.36.0__py3-none-any.whl → 1.36.1__py3-none-any.whl

bencher/bench_runner.py

@@ -136,7 +136,7 @@ class BenchRunner:
             else:
                 report.publish(remote_callback=self.publisher, debug=debug)
         if show:
-            self.servers.append(report.show())
+            self.servers.append(report.show(self.run_cfg))
 
     def shutdown(self):
         while self.servers:

bencher/example/example_video.py

@@ -78,14 +78,11 @@ class TuringPattern(bch.ParametrizedSweep):
 def example_video(
     run_cfg: bch.BenchRunCfg = bch.BenchRunCfg(), report: bch.BenchReport = bch.BenchReport()
 ) -> bch.Bench:
-    # run_cfg.auto_plot = False
-    # run_cfg.cache_samples = True
-    bench = bch.Bench("example_video", TuringPattern(), run_cfg=run_cfg, report=report)
+    bench = TuringPattern().to_bench(run_cfg, report)
 
     bench.plot_sweep(
         "Turing patterns with different parameters",
-        input_vars=[TuringPattern.param.alpha, TuringPattern.param.beta],
-        # input_vars=[TuringPattern.param.alpha],
+        input_vars=["alpha", "beta"],
         result_vars=[TuringPattern.param.video],
     )
 
@@ -96,14 +93,17 @@ def example_video_tap(
     run_cfg: bch.BenchRunCfg = bch.BenchRunCfg(), report: bch.BenchReport = bch.BenchReport()
 ) -> bch.Bench:  # pragma: no cover
     bench = TuringPattern().to_bench(run_cfg=run_cfg, report=report)
-    res = bench.plot_sweep(
-        input_vars=["alpha", "beta"],
-        # result_vars=["video","score"],
-        # result_vars=["score"],
-        run_cfg=run_cfg,
-    )
+    res = bench.plot_sweep(input_vars=["alpha", "beta"])
 
-    bench.report.append(res.to_video_grid())
+    bench.report.append(res.to_video_grid(result_types=(bch.ResultVideo)))
+
+    res = bench.plot_sweep(input_vars=["alpha"])
+    bench.report.append(
+        res.to_video_grid(
+            result_types=(bch.ResultVideo),
+            compose_method_list=[bch.ComposeType.right],
+        )
+    )
 
     return bench
 

bencher/example/inputs_1D/example_1D.py

@@ -34,27 +34,9 @@ def example_1D_float_repeats(
     """This example shows how to sample a 1 dimensional float variable and plot the result of passing that parameter sweep to the benchmarking function"""
 
     bench = Example1D().to_bench(run_cfg, report)
-    # bench.plot_sweep(pass_repeat=True,plot_callbacks=False)
-
-    # res = bench.get_result()
     bench.run_cfg = bch.BenchRunCfg(repeats=4)
-    # bench.plot_sweep(pass_repeat=True, plot_callbacks=False)
     bench.plot_sweep(pass_repeat=True)
 
-    res = bench.get_result()
-    bench.report.append(res.to_curve())
-    # bench.report.append(hv.Table(res.to_hv_dataset(bch.ReduceType.MINMAX)))
-    # bench.report.append(res.to_curve() + res.to_scatter_jitter(override=True))
-    # bench.report.append(res.to_line())
-    bench.report.append(res.to_scatter_jitter(override=True))
-    # bench.report.append(res.to_error_bar())
-    # bench.report.append(res.to_explorer())
-    # bench.report.append(res.to_error_bar()
-
-    # bench.report.append(res.to_dataset())
-    # bench.report.append(res.to_xarray().hvplot.plot(kind="andrews_curves"))
-    # print(res.to_xarray())
-    # bench.report.append()
     return bench
 
 

bencher/job.py

@@ -36,7 +36,10 @@ class JobFuture:
         self.res = res
         self.future = future
         # either a result or a future needs to be passed
-        assert self.res is not None or self.future is not None
+        assert (
+            self.res is not None or self.future is not None
+        ), "make sure you are returning a dict or super().__call__(**kwargs) from your __call__ function"
+
         self.cache = cache
 
     def result(self):

bencher/results/composable_container/composable_container_video.py

@@ -100,7 +100,7 @@ class ComposableContainerVideo(ComposableContainerBase):
         print("rc", render_cfg)
         _, frame_duration = self.calculate_duration(float(len(self.container)), render_cfg)
         out = None
-        print(f"using compose type{render_cfg.compose_method}")
+        print(f"using compose type: {render_cfg.compose_method}")
         max_duration = 0.0
 
         for i in range(len(self.container)):
@@ -129,8 +129,8 @@ class ComposableContainerVideo(ComposableContainerBase):
             # case ComposeType.overlay:
             #     for i in range(len(self.container)):
             #         self.container[i].alpha = 1./len(self.container)
-            #     out = CompositeVideoClip(self.container, bg_color=render_args.background_col)
-            #     out.duration = fps
+            #     out = CompositeVideoClip(self.container, bg_color=render_cfg.background_col)
+            #     # out.duration = fps
             case _:
                 raise RuntimeError("This compose type is not supported")
 

bencher/results/video_summary.py

@@ -39,6 +39,7 @@ class VideoSummaryResult(BenchResultBase):
         pane_collection: pn.pane = None,
         time_sequence_dimension=0,
         target_duration: float = None,
+        compose_method_list: List = None,
         **kwargs,
     ) -> Optional[pn.panel]:
         """Returns the results compiled into a video
@@ -47,6 +48,7 @@ class VideoSummaryResult(BenchResultBase):
             result_var (Parameter, optional): The result var to plot. Defaults to None.
             result_types (tuple, optional): The types of result var to convert to video. Defaults to (ResultImage,).
             collection (pn.pane, optional): If there are multiple results, use this collection to stack them. Defaults to pn.Row().
+            compose_method_list (List: optional): Defines how each of the dimensions is composed in the video. ie, concatenate the videos horizontally, vertically, sequentially or alpha overlay. Seee bch.ComposeType for the options.
 
         Returns:
             Optional[pn.panel]: a panel pane with a video of all results concatenated together
@@ -74,6 +76,7 @@ class VideoSummaryResult(BenchResultBase):
                             rv,
                             time_sequence_dimension=time_sequence_dimension,
                             target_duration=target_duration,
+                            compose_method_list=compose_method_list,
                             **kwargs,
                         )
                     )
@@ -88,6 +91,7 @@ class VideoSummaryResult(BenchResultBase):
         time_sequence_dimension=0,
         video_controls: VideoControls = None,
         target_duration: float = None,
+        compose_method_list: List = None,
         **kwargs,
     ):
         cvc = self._to_video_panes_ds(
@@ -100,6 +104,7 @@ class VideoSummaryResult(BenchResultBase):
             result_var=result_var,
             final=True,
             reverse=reverse,
+            compose_method_list=compose_method_list,
             target_duration=target_duration,
             **kwargs,
         )

{holobench-1.36.0.dist-info → holobench-1.36.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: holobench
-Version: 1.36.0
+Version: 1.36.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.36.0.dist-info → holobench-1.36.1.dist-info}/RECORD

@@ -2,12 +2,12 @@ bencher/__init__.py,sha256=hWfQxlvuHRsFK4ZPCpRXo3nDzQB52JOUoi67wcnhopE,1890
 bencher/bench_cfg.py,sha256=gEpF1J4RAxCQPSkI8npKfhw-o3-8cw80TjiWK7As5WE,18417
 bencher/bench_plot_server.py,sha256=nvGTr981XgWELqV7yID91j6V1UIPGtKilzxHcNWaZ6Q,4196
 bencher/bench_report.py,sha256=ikMSHceyc8cYFH-sIza167DH-H-_iiTYDm2TmusUHDc,7515
-bencher/bench_runner.py,sha256=5yHE3yN7EJOmjQgeS8VLI3zHE8QjUYva9TsNg2pnQgQ,6519
+bencher/bench_runner.py,sha256=xoeXt8gcEhx5nAFsKBs8RmdkEyXUOyFd8mrEXyIxj3U,6531
 bencher/bencher.py,sha256=-vbZIzBr2IYYG7be5Hh8IZgIGUysTxoxQUV6xUToH14,35437
 bencher/caching.py,sha256=AusaNrzGGlj5m6zcwcqnTn55Mam2mQdF--oqelO806M,1627
 bencher/class_enum.py,sha256=kYHW9qKkKcNdwaXizZL-fTptS_DUEGv4c88yCehk3gc,1492
 bencher/flask_server.py,sha256=uMhMaySUki5StC-r_TXb4KTVqAiffyqfH7UzQidFqSw,831
-bencher/job.py,sha256=oicKfCrVrNjjjlUV3e5qMOmhkQ8BBJMHkepOabiOy1U,6095
+bencher/job.py,sha256=smSRLLZNxFSuAo7mA3m_lzHc2opjNf-DjzszsCn4ENU,6216
 bencher/optuna_conversions.py,sha256=an-LfPsQXyyvhIZnG8Wl1RQVYMvJj7WOi3YNqoUnuxQ,5356
 bencher/utils.py,sha256=DP2GJP28nSEihvZwiV1Rl7YJ5NTrRt2zBLs46eQ37hQ,9887
 bencher/utils_rerun.py,sha256=E1itolYJMjmtBE5qcSotiS20I-dobVnjznsTRvZaV0s,1212
@@ -49,7 +49,7 @@ bencher/example/example_simple_float.py,sha256=5l3O6DzS1AV9LdpN_HfYxR-rvheXoRtWQ
 bencher/example/example_simple_float2d.py,sha256=xsVOLO6AtMi9_fybpS_JZnhev5f11YuYWHrAOzJw2dI,1033
 bencher/example/example_strings.py,sha256=vStjrvfezNz7115iRtuwy0i7Gbu6w8mu-oHNfKNLNog,1570
 bencher/example/example_time_event.py,sha256=e6R-a6ZPe-ePiWoNvN3YuSQK-Y2HOGntsjCm_SPon28,2159
-bencher/example/example_video.py,sha256=pwcKM8H31GmzeJNe90d7fNB-GU562M0dnAXDVk8xu28,3949
+bencher/example/example_video.py,sha256=QnEaMOt7taHVKD_t3EZ60aCTkVdt2hhJ2bDH2fNparg,3897
 bencher/example/example_workflow.py,sha256=00QnUuViMfX_PqzqkXmg1wPX6yAq7IS7mCL_RFKwrMM,6806
 bencher/example/experimental/example_bokeh_plotly.py,sha256=3jUKh8eKIAlpklKnp8UopIHhUDw1A0_5CwjeyTzbi7o,846
 bencher/example/experimental/example_hover_ex.py,sha256=qszw4FkIfqQkVviPSpmUoFOoi6PGotGbsc7Ojyx8EtU,1052
@@ -61,7 +61,7 @@ bencher/example/experimental/example_template.py,sha256=XdIVS9RtLdE5GNnerWiZMXvP
 bencher/example/experimental/example_updates.py,sha256=rF4UgWY-CW6ohNtOpQklTuwbwVRvEM5j6edZOiMkspQ,1835
 bencher/example/experimental/example_vector.py,sha256=3o_1dA4dc2HL6uIEvDAcvLPVJB8jgkq1QZ3BQIL-LEo,3118
 bencher/example/inputs_0D/example_0D.py,sha256=WgelKMVahagrLpCByosqh4bHC58BXJ4-AO7zqgjNjH8,1225
-bencher/example/inputs_1D/example_1D.py,sha256=JzUz6jk2N03u-0meJBB6oLA_Ud_h8CSrLIwdIVZJePY,2119
+bencher/example/inputs_1D/example_1D.py,sha256=aT_4mtYNSN49qMG51jgW9X3NSGGC_GrGpgUNG6i0NZ8,1315
 bencher/example/meta/example_meta.py,sha256=XBpfu47z86vz8QSZjLA1uWltoRZSej7W48nveFKqj5w,5564
 bencher/example/meta/example_meta_cat.py,sha256=FMBT0yMPJJo0pmUYVtlq64R6qn_EXEt74xYAsK6HQag,641
 bencher/example/meta/example_meta_float.py,sha256=D71oiFqGauLvqTxv2BC4CJOwHIdpvq8FdCBVejwZ4Do,624
@@ -84,12 +84,12 @@ bencher/results/optuna_result.py,sha256=QtZ4TGRun7gJoFVUjEyXKPF5yakwOSXrqEXQVJdJ
 bencher/results/panel_result.py,sha256=lXOtfhWKSspf53Wgm94DTiVD3rliieHQW96sOdu5UYk,1336
 bencher/results/plotly_result.py,sha256=wkgfL38qJp6RviekXBYpNPeU4HCf0nbtKDAhu5QZhUg,2132
 bencher/results/video_result.py,sha256=E3fAxXctRVxiRyamadpKCMXanM5TTqw1tEYICS2LDLs,1146
-bencher/results/video_summary.py,sha256=ECMVnm1L58n3KHrFuy4Cm9T6aUjsOL_YHm0ncLfW4IU,8343
+bencher/results/video_summary.py,sha256=-YUAkSZhS65a5ULGqyi9vPP-3nhIv9miogM2XLKr0iI,8782
 bencher/results/composable_container/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bencher/results/composable_container/composable_container_base.py,sha256=gmlQl3NQ3LWIfH15neLoZMNos6hbu3SklslfcFDAacA,2778
 bencher/results/composable_container/composable_container_dataframe.py,sha256=ZbFaQSo4UsRxY8NUdJPjNFW3_kzlm8jtWuoLf8y_t8U,1789
 bencher/results/composable_container/composable_container_panel.py,sha256=HrOoeGB0y0jGQcxcci_M82ftsvklLkJgo-4SjDBJCks,1232
-bencher/results/composable_container/composable_container_video.py,sha256=EHY2TIQM5ualrh_or-wzyErPWm25CaYdSdMotqo5wCo,7104
+bencher/results/composable_container/composable_container_video.py,sha256=X6XxBNDglnNLjQ4QrhxJ8W3Re_aLeTZKKVsbjjJ3av8,7107
 bencher/variables/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bencher/variables/inputs.py,sha256=vxpVKhbM8inYiiHcatJLGl0zg9boMYKJRtLVc32YGpY,6730
 bencher/variables/parametrised_sweep.py,sha256=fxjKOQ2x5xuCyi0kO1_XS9bXiib1bjThhvpulZPeyv8,7802
@@ -97,7 +97,7 @@ bencher/variables/results.py,sha256=Wq14e8rAj5mcK22325wcaeTMjgZ6JuduqceAHItHFY8,
 bencher/variables/sweep_base.py,sha256=gfEhKvsb16ZLbe38JewZqu0AMOHpsqwRbZbt-aCg9Bc,6258
 bencher/variables/time.py,sha256=zcRS5p4ZkFjMta9nZMEuWv86rLnPkUSqyO69QwI5q3E,3142
 resource/bencher,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-holobench-1.36.0.dist-info/METADATA,sha256=COF3grcndXLYtfHqqetyZwjyE86PZb7d1QAYrce1yh0,6600
-holobench-1.36.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-holobench-1.36.0.dist-info/licenses/LICENSE,sha256=dSHXTdRY4Y7qGFMv63UksV700iff7iE-p7GGs6Sbnvo,1065
-holobench-1.36.0.dist-info/RECORD,,
+holobench-1.36.1.dist-info/METADATA,sha256=tVg9fYHfBnnb7xlVW_UEikyH2hSOtf2pbrUT1i_K9e4,6600
+holobench-1.36.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+holobench-1.36.1.dist-info/licenses/LICENSE,sha256=dSHXTdRY4Y7qGFMv63UksV700iff7iE-p7GGs6Sbnvo,1065
+holobench-1.36.1.dist-info/RECORD,,