holobench 1.30.2__py3-none-any.whl → 1.30.3__py3-none-any.whl

bencher/example/example_float3D.py

@@ -1,11 +1,9 @@
 # pylint: disable=duplicate-code
-
 import numpy as np
-
 import bencher as bch
 
 
-class VolumeSample(bch.ParametrizedSweep):
+class VolumeSweep(bch.ParametrizedSweep):
     """A class to represent a 3D point in space."""
 
     x = bch.FloatSweep(
@@ -18,10 +16,6 @@ class VolumeSample(bch.ParametrizedSweep):
         default=0, bounds=[-1.0, 1.0], doc="z coordinate of the sample volume", samples=6
     )
 
-
-class VolumeResult(bch.ParametrizedSweep):
-    """A class to represent the properties of a volume sample."""
-
     value = bch.ResultVar("ul", doc="The scalar value of the 3D volume field")
     occupancy = bch.ResultVar(
         "occupied", doc="If the value is > 0.5 this point is considered occupied"
@@ -32,33 +26,25 @@ class VolumeResult(bch.ParametrizedSweep):
         3, "vec", doc="The same vector field but only showing values in a sphere of radius 0.5"
     )
 
+    def __call__(self, **kwargs) -> dict:
+        """This function takes a 3D point as input and returns distance of that point to the origin."""
+        self.update_params_from_kwargs(**kwargs)
+        self.value = np.linalg.norm(np.array([self.x, self.y, self.z]))  # distance to origin
+        self.occupancy = float(self.value < 0.5)
+        # from https://plotly.com/python/3d-volume-plots/
+        self.interesting = np.sin(np.pi * self.x) * np.cos(np.pi * self.z) * np.sin(np.pi * self.y)
+        self.interesting_vec = [
+            np.sin(np.pi * self.x),
+            np.cos(np.pi * self.z),
+            np.sin(np.pi * self.y),
+        ]
 
-def bench_fn(point: VolumeSample) -> VolumeResult:
-    """This function takes a 3D point as input and returns distance of that point to the origin.
+        if self.occupancy:
+            self.interesting_vec_and_occ = self.interesting_vec
+        else:
+            self.interesting_vec_and_occ = [0, 0, 0]
 
-    Args:
-        point (VolumeSample): Sample point
-
-    Returns:
-        VolumeResult: Value at that point
-    """
-    output = VolumeResult()
-    output.value = np.linalg.norm(np.array([point.x, point.y, point.z]))  # distance to origin
-    output.occupancy = float(output.value < 0.5)
-    # from https://plotly.com/python/3d-volume-plots/
-    output.interesting = np.sin(np.pi * point.x) * np.cos(np.pi * point.z) * np.sin(np.pi * point.y)
-    output.interesting_vec = [
-        np.sin(np.pi * point.x),
-        np.cos(np.pi * point.z),
-        np.sin(np.pi * point.y),
-    ]
-
-    if output.occupancy:
-        output.interesting_vec_and_occ = output.interesting_vec
-    else:
-        output.interesting_vec_and_occ = [0, 0, 0]
-
-    return output
+        return super().__call__()
 
 
 def example_floats3D(
@@ -72,21 +58,15 @@ def example_floats3D(
     Returns:
         Bench: results of the parameter sweep
     """
-    bench = bch.Bench(
-        "Bencher_Example_Floats",
-        bench_fn,
-        VolumeSample,
-        run_cfg=run_cfg,
-        report=report,
-    )
+    bench = VolumeSweep().to_bench(run_cfg=run_cfg, report=report)
 
     bench.plot_sweep(
         title="Float 3D Example",
-        input_vars=[VolumeSample.param.x, VolumeSample.param.y, VolumeSample.param.z],
+        input_vars=["x", "y", "z"],
         result_vars=[
-            VolumeResult.param.value,
-            VolumeResult.param.occupancy,
-            VolumeResult.param.interesting,
+            "value",
+            "occupancy",
+            "interesting",
         ],
         description="""This example shows how to sample 3 floating point variables and plot a volumetric representation of the results.  The benchmark function returns the distance to the origin""",
         post_description="Here you can see concentric shells as the value of the function increases with distance from the origin. The occupancy graph should show a sphere with radius=0.5",
@@ -97,5 +77,5 @@ def example_floats3D(
 
 if __name__ == "__main__":
     ex_run_cfg = bch.BenchRunCfg()
-    ex_run_cfg.level = 3
+    ex_run_cfg.level = 6
     example_floats3D(ex_run_cfg).report.show()

{holobench-1.30.2.dist-info → holobench-1.30.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: holobench
-Version: 1.30.2
+Version: 1.30.3
 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
@@ -13,12 +13,12 @@ Requires-Dist: holoviews<=1.19.1,>=1.15
 Requires-Dist: hvplot<=0.10.0,>=0.8
 Requires-Dist: matplotlib<=3.9.2,>=3.6.3
 Requires-Dist: moviepy-fix-codec
-Requires-Dist: numpy<=2.1.0,>=1.0
+Requires-Dist: numpy<=2.1.3,>=1.0
 Requires-Dist: optuna<=4.0.0,>=3.2
 Requires-Dist: pandas<=2.2.2,>=2.0
 Requires-Dist: panel<=1.4.5,>=1.3.6
 Requires-Dist: param<=2.1.1,>=1.13.0
-Requires-Dist: plotly<=5.24.0,>=5.15
+Requires-Dist: plotly<=5.24.1,>=5.15
 Requires-Dist: scikit-learn<=1.5.1,>=1.2
 Requires-Dist: scoop<=0.7.2.0,>=0.7.0
 Requires-Dist: sortedcontainers<=2.4,>=2.4

{holobench-1.30.2.dist-info → holobench-1.30.3.dist-info}/RECORD

@@ -23,7 +23,7 @@ bencher/example/example_custom_sweep2.py,sha256=6RBiyVVaxAh5Aul85DfYA5P-lwhwW3Bb
 bencher/example/example_dataframe.py,sha256=aGSdMnsRvRC2dgkUVmzEJz5yo6k1lPjsUM6gFShNcRI,1792
 bencher/example/example_docs.py,sha256=aUi33O543JBPoOGlpHaY2eA74GR7cHH_6-hcC8xf3z0,1174
 bencher/example/example_filepath.py,sha256=O3VO9rWAXB_1tagVSvxhiSMjcTkgZe2duw7W17ij7po,827
-bencher/example/example_float3D.py,sha256=pwi3YlDad3NL4IrfMK2V5yV1CRpqfmUO-zUnGmVYxDs,3425
+bencher/example/example_float3D.py,sha256=Ya9zIfUZmbqV6GZrRjcV44uMnKeKgG6RrLBsky0P5LY,3066
 bencher/example/example_float_cat.py,sha256=nQDBWYRVZrJW5ABIizqcD6mXswHWSdEDzM-FeYFqYqY,3821
 bencher/example/example_floats.py,sha256=HcQgfwldTVeFBmBTMtZ0yRy17ZJ4cfJeI_t8TxY2iOI,4269
 bencher/example/example_floats2D.py,sha256=D0kljoUCinMKCEW-Zg-cQ8sYu_yPCZqzKJ9tRtt-Ono,3697
@@ -89,7 +89,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.30.2.dist-info/METADATA,sha256=xFu1ubVzZcmc0ydMa4H6bWHxVZ_GAmM_dAkUGSABbwg,6360
-holobench-1.30.2.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-holobench-1.30.2.dist-info/licenses/LICENSE,sha256=dSHXTdRY4Y7qGFMv63UksV700iff7iE-p7GGs6Sbnvo,1065
-holobench-1.30.2.dist-info/RECORD,,
+holobench-1.30.3.dist-info/METADATA,sha256=Hcm68cVxVMskIezkmj2E74MsOo37QZYg-OB9V5kX3so,6360
+holobench-1.30.3.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+holobench-1.30.3.dist-info/licenses/LICENSE,sha256=dSHXTdRY4Y7qGFMv63UksV700iff7iE-p7GGs6Sbnvo,1065
+holobench-1.30.3.dist-info/RECORD,,