holobench 1.36.0__tar.gz → 1.36.2__tar.gz

{holobench-1.36.0 → holobench-1.36.2}/.gitignore

@@ -179,3 +179,7 @@ log/**
 managed_context/metadata.json
 test_suite_analysis/metadata.json
 *.rrd
+docs/builtdocs*
+docs/jupyter_execute*
+thumbnails/
+docs/autoapi/*

{holobench-1.36.0 → holobench-1.36.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: holobench
-Version: 1.36.0
+Version: 1.36.2
 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 → holobench-1.36.2}/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:

{holobench-1.36.0 → holobench-1.36.2}/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
 

{holobench-1.36.0 → holobench-1.36.2}/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
 
 

{holobench-1.36.0 → holobench-1.36.2}/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):

{holobench-1.36.0 → holobench-1.36.2}/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")
 

{holobench-1.36.0 → holobench-1.36.2}/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 → holobench-1.36.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "holobench"
-version = "1.36.0"
+version = "1.36.2"
 
 authors = [{ name = "Austin Gregg-Smith", email = "blooop@gmail.com" }]
 description = "A package for benchmarking the performance of arbitrary functions"
@@ -52,6 +52,27 @@ python = "3.12.*"
 [tool.pixi.pypi-dependencies]
 holobench = { path = ".", editable = true }
 
+# Define a consolidated docs feature with all dependencies
+[tool.pixi.feature.docs.dependencies]
+python = "3.10.*"
+firefox = ">=134.0,<135"         # Conda package
+geckodriver = "*"                # Conda package
+sphinx = "*"
+gtk3 = "*"
+python-chromedriver-binary = "*"
+
+[tool.pixi.feature.docs.pypi-dependencies]
+# All Python documentation dependencies
+pydata-sphinx-theme = "*"
+sphinx-rtd-theme = "*"
+sphinxcontrib-napoleon = "*"
+sphinx-autoapi = "*"
+nbsite = "==0.8.7"
+jupyter_bokeh = "*"
+selenium = "*"
+chromedriver_binary = "*"
+ipykernel = "*"
+
 [project.optional-dependencies]
 test = [
     "pylint>=3.2.5,<=3.3.3",
@@ -63,6 +84,7 @@ test = [
     "pre-commit<=4.0.1",
 ]
 
+
 #adds support for embedding rerun windows (alpha)
 rerun = ["rerun-sdk==0.21.0", "rerun-notebook", "flask", "flask-cors"]
 
@@ -75,7 +97,7 @@ include = ["bencher"]
 
 # Environments
 [tool.pixi.environments]
-default = { features = ["test", "rerun"], solve-group = "default" }
+default = { features = ["test", "rerun", "docs"], solve-group = "default" }
 py310 = ["py310", "test", "rerun"]
 py311 = ["py311", "test", "rerun"]
 py312 = ["py312", "test", "rerun"]
@@ -112,13 +134,18 @@ clear-pixi = "rm -rf .pixi pixi.lock"
 setup-git-merge-driver = "git config merge.ours.driver true"
 update-from-template-repo = "./scripts/update_from_template.sh"
 
+docs = "rm -rf docs/builtdocs; rm -rf docs/jupyter_execute; sphinx-build -b html docs docs/builtdocs"
+
+
 #demos
 demo = "python3 bencher/example/example_image.py"
 demo_rerun = "python3 bencher/example/example_rerun.py"
 
+
 [tool.pylint]
 extension-pkg-whitelist = ["numpy", "scipy"]
 jobs = 16                                    #detect number of cores
+ignore-paths = "docs/*"
 
 [tool.pylint.'MESSAGES CONTROL']
 disable = "C,logging-fstring-interpolation,line-too-long,fixme,missing-module-docstring,too-many-instance-attributes,too-few-public-methods,too-many-arguments,too-many-locals,too-many-branches,too-many-statements,use-dict-literal,duplicate-code,too-many-public-methods,too-many-nested-blocks,cyclic-import,too-many-positional-arguments"