holobench 1.3.5__py3-none-any.whl → 1.22.2__py3-none-any.whl

bencher/utils.py

@@ -8,7 +8,8 @@ from colorsys import hsv_to_rgb
 from pathlib import Path
 from uuid import uuid4
 from functools import partial
-from typing import Callable, Any
+from typing import Callable, Any, List
+import param
 
 
 def hmap_canonical_input(dic: dict) -> tuple:
@@ -60,6 +61,9 @@ def get_nearest_coords(dataset: xr.Dataset, collapse_list=False, **kwargs) -> di
 def get_nearest_coords1D(val: Any, coords) -> Any:
     if isinstance(val, (int, float)):
         return min(coords, key=lambda x_: abs(x_ - val))
+    for i in coords:
+        if val == i:
+            return i
     return val
 
 
@@ -94,6 +98,19 @@ def un_camel(camel: str) -> str:
     return capitalise_words(re.sub("([a-z])([A-Z])", r"\g<1> \g<2>", camel.replace("_", " ")))
 
 
+def tabs_in_markdown(regular_str: str, spaces: int = 2) -> str:
+    """Given a string with tabs in the form \t convert the to &ensp; which is a double space in markdown
+
+    Args:
+        regular_str (str): A string with tabs in it
+        spaces (int): the number of spaces per tab
+
+    Returns:
+        str: A string with sets of &nbsp; to represent the tabs in markdown
+    """
+    return regular_str.replace("\t", "".join(["&nbsp;"] * spaces))
+
+
 def int_to_col(int_val, sat=0.5, val=0.95, alpha=-1) -> tuple[float, float, float]:
     """Uses the golden angle to generate colors programmatically with minimum overlap between colors.
     https://martin.ankerl.com/2009/12/09/how-to-create-random-colors-programmatically/
@@ -125,17 +142,17 @@ def color_tuple_to_css(color: tuple[float, float, float]) -> str:
     return f"rgb{(color[0] * 255, color[1] * 255, color[2] * 255)}"
 
 
-def gen_path(filename, folder, suffix):
+def gen_path(filename, folder="generic", suffix=".dat"):
     path = Path(f"cachedir/{folder}/{filename}/")
     path.mkdir(parents=True, exist_ok=True)
     return f"{path.absolute().as_posix()}/{filename}_{uuid4()}{suffix}"
 
 
-def gen_video_path(video_name: str, extension: str = ".webm") -> str:
+def gen_video_path(video_name: str = "vid", extension: str = ".webm") -> str:
     return gen_path(video_name, "vid", extension)
 
 
-def gen_image_path(image_name: str, filetype=".png") -> str:
+def gen_image_path(image_name: str = "img", filetype=".png") -> str:
     return gen_path(image_name, "img", filetype)
 
 
@@ -146,3 +163,24 @@ def callable_name(any_callable: Callable[..., Any]) -> str:
         return any_callable.__name__
     except AttributeError:
         return str(any_callable)
+
+
+def listify(obj) -> list:
+    """Take an object and turn it into a list if its not already a list.  However if the object is none, don't turn it into a list"""
+    if obj is None:
+        return None
+    if isinstance(obj, list):
+        return obj
+    if isinstance(obj, tuple):
+        return list(obj)
+    return [obj]
+
+
+def get_name(var):
+    if isinstance(var, param.Parameter):
+        return var.name
+    return var
+
+
+def params_to_str(param_list: List[param.Parameter]):
+    return [get_name(i) for i in param_list]

bencher/video_writer.py

@@ -1,26 +1,117 @@
-from bencher import gen_video_path, gen_image_path
-from PIL import Image
 import numpy as np
+import moviepy.video.io.ImageSequenceClip
+from pathlib import Path
+from .utils import gen_video_path, gen_image_path
+
+import moviepy
+from moviepy.editor import (
+    VideoFileClip,
+    ImageClip,
+    ImageSequenceClip,
+    clips_array,
+    concatenate_videoclips,
+)
+from PIL import Image, ImageDraw
 
 
 class VideoWriter:
     def __init__(self, filename: str = "vid") -> None:
         self.images = []
+        self.image_files = []
+        self.video_files = []
         self.filename = gen_video_path(filename)
 
     def append(self, img):
         self.images.append(img)
 
-    def write(self, bitrate: int = 1500) -> str:
-        import moviepy.video.io.ImageSequenceClip
+    def write(self) -> str:
+        clip = moviepy.video.io.ImageSequenceClip.ImageSequenceClip(
+            self.images, fps=30, with_mask=False, load_images=True
+        )
+        self.write_video_raw(clip)
+        return self.filename
+
+    @staticmethod
+    def create_label(label, width=None, height=14):
+        if width is None:
+            width = len(label) * 8
+        new_img = Image.new("RGB", (width, height), (255, 255, 255))
+        # ImageDraw.Draw(new_img).text((width/2, 0), label, (0, 0, 0),align="center",achor="ms")
+        ImageDraw.Draw(new_img).text((width / 2.0, 0), label, (0, 0, 0), anchor="mt", font_size=12)
+
+        return new_img
+
+    @staticmethod
+    def label_image(path: Path, label, padding=20) -> Path:
+        image = Image.open(path)
+        new_img = VideoWriter.create_label(label, image.size[0], image.size[1] + padding)
+        new_img.paste(image, (0, padding))
+        return new_img
+
+    def append_file(self, filepath, label=None):
+        if label is not None:
+            path = Path(filepath)
+            new_path = path.with_name(path.stem + "_labelled" + path.suffix).as_posix()
+            padding = 20
+            match path.suffix:
+                case ".png" | ".jpg":
+                    image = Image.open(filepath)
+                    new_img = self.create_label(label, image.size[0], image.size[1] + padding)
+                    new_img.paste(image, (0, padding))
+                    new_img.save(new_path)
+                    self.image_files.append(new_path)
+                case ".webm":
+                    import warnings
+
+                    video_clip = VideoFileClip(filepath)
+                    new_img = self.create_label(label, video_clip.w, padding)
+
+                    # Convert PIL image to MoviePy clip
+                    label_clip = ImageClip(np.array(new_img), duration=video_clip.duration)
+
+                    labeled_video_clip = clips_array([[label_clip], [video_clip]])
+
+                    # otherwise ffmpeg complains that the file is not getting read. We don't need the file just the size
+                    with warnings.catch_warnings():
+                        warnings.simplefilter(action="ignore")
+                        labeled_video_clip.write_videofile(new_path, remove_temp=True, logger=None)
+                    self.video_files.append(new_path)
+        else:
+            self.image_files.append(filepath)
+
+    def to_images_sequence(self, images, target_duration: float = 10.0, frame_time=None, **kwargs):
+        target_duration = kwargs.pop("target_duration", target_duration)
+        if isinstance(images, list) and len(images) > 0:
+            if frame_time is None:
+                fps = len(images) / target_duration
+                fps = max(fps, 1)  # never slower that 1 seconds per frame
+                fps = min(fps, 30)
+            else:
+                fps = 1.0 / frame_time
+            return ImageSequenceClip(images, fps=fps, with_mask=False)
+        return None
 
-        # todo
-        # if len(self.images[0.shape) == 2:
-        #     for i in range(len(self.images)):
-        #         self.images[i] = np.expand_dims(self.images[i], 2)
+    def write_png(self, **kwargs):
+        clip = None
+        if len(self.image_files) > 0:
+            clip = self.to_images_sequence(self.image_files, **kwargs)
+        if len(self.video_files) > 0:
+            clip = concatenate_videoclips([VideoFileClip(f) for f in self.video_files])
+        if clip is not None:
+            clip.write_videofile(self.filename)
+            return self.filename
+        return None
 
-        clip = moviepy.video.io.ImageSequenceClip.ImageSequenceClip(self.images, fps=30)
-        clip.write_videofile(self.filename, bitrate=f"{bitrate}k", logger=None)
+    def write_video_raw(self, video_clip: moviepy.video.VideoClip, fps: int = 30) -> str:
+        video_clip.write_videofile(
+            self.filename,
+            codec="libvpx",
+            audio=False,
+            bitrate="0",
+            fps=fps,
+            ffmpeg_params=["-crf", "34"],
+        )
+        video_clip.close()
         return self.filename
 
 

holobench-1.22.2.data/data/share/bencher/package.xml

@@ -0,0 +1,33 @@
+<?xml version="1.0"?>
+<package format="3">
+  <name>bencher</name>
+  <version>0.1.0</version>
+  <description>A package for benchmarking the performance of arbitrary functions</description>
+  <maintainer email="austin.gregg-smith@dyson.com">Austin Gregg-Smith</maintainer>
+  <license>MIT</license>
+
+  <depend>python3-diskcache</depend>  
+  
+  <depend>python3-pandas</depend>  
+  <depend>python3-seaborn</depend>
+  <depend>python3-matplotlib</depend>
+  <depend>python3-numpy</depend>
+  <depend>python3-pytest</depend>
+  <depend>python3-hypothesis</depend>
+  <depend>xarray</depend>  
+  <depend>python3-zarr</depend>    
+  <depend>python3-param</depend>
+  <depend>python3-panel</depend>
+  <depend>python3-hvplot</depend>
+  <depend>python3-optuna</depend> 
+  <depend>python3-plotly</depend> 
+
+  <!-- TO REMOVE WHEN WE UPGRADE TO PYTHON 3.11, This is in the standard library for python>=3.11 -->
+  <depend>strenum</depend>
+
+  <test_depend>python3-pytest-cov</test_depend>
+  
+  <export>
+    <build_type>ament_python</build_type>
+  </export>
+</package>

holobench-1.22.2.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Dyson AI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{holobench-1.3.5.dist-info → holobench-1.22.2.dist-info}/METADATA

@@ -1,37 +1,38 @@
 Metadata-Version: 2.1
 Name: holobench
-Version: 1.3.5
+Version: 1.22.2
 Summary: A package for benchmarking the performance of arbitrary functions
 Author-email: Austin Gregg-Smith <blooop@gmail.com>
-Requires-Python: >=3.10
-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.1
-Requires-Dist: matplotlib>=3.6.3,<=3.8.2
-Requires-Dist: panel>=1.3.6,<=1.3.6
-Requires-Dist: diskcache>=5.6,<=5.6.3
-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.4
-Requires-Dist: strenum>=0.4.0,<=0.4.15
-Requires-Dist: scikit-learn>=1.2,<=1.3.2
-Requires-Dist: str2bool>=1.1,<=1.1
-Requires-Dist: scoop>=0.7.0,<=0.7.2.0
-Requires-Dist: moviepy>=1.0.3,<=1.0.3
-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.4 ; 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: Repository, https://github.com/dyson-ai/bencher
 Project-URL: Home, https://github.com/dyson-ai/bencher
-Project-URL: Source, https://github.com/dyson-ai/bencher
+Project-URL: Documentation, https://bencher.readthedocs.io/en/latest/
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: holoviews <=1.18.3,>=1.15
+Requires-Dist: numpy <=1.26.4,>=1.0
+Requires-Dist: param <=2.1.0,>=1.13.0
+Requires-Dist: hvplot <=0.10.0,>=0.8
+Requires-Dist: matplotlib <=3.9.0,>=3.6.3
+Requires-Dist: panel <=1.4.3,>=1.3.6
+Requires-Dist: diskcache <=5.6.3,>=5.6
+Requires-Dist: optuna <=3.6.1,>=3.2
+Requires-Dist: xarray <=2024.5.0,>=2023.7
+Requires-Dist: plotly <=5.22.0,>=5.15
+Requires-Dist: sortedcontainers <=2.4,>=2.4
+Requires-Dist: pandas <=2.2.2,>=2.0
+Requires-Dist: strenum <=0.4.15,>=0.4.0
+Requires-Dist: scikit-learn <=1.5.0,>=1.2
+Requires-Dist: str2bool <=1.1,>=1.1
+Requires-Dist: scoop <=0.7.2.0,>=0.7.0
+Requires-Dist: moviepy <=1.0.3,>=1.0.3
 Provides-Extra: test
+Requires-Dist: black <=24.4.2,>=23 ; extra == 'test'
+Requires-Dist: pylint <=3.2.2,>=2.17.7 ; extra == 'test'
+Requires-Dist: pytest-cov <=5.0.0,>=4.1 ; extra == 'test'
+Requires-Dist: pytest <=8.2.1,>=7.4 ; extra == 'test'
+Requires-Dist: hypothesis <=6.102.6,>=6.82 ; extra == 'test'
+Requires-Dist: ruff <=0.4.5,>=0.3 ; extra == 'test'
+Requires-Dist: coverage <=7.5.2,>=7.2.7 ; extra == 'test'
 
 # Bencher
  
@@ -45,14 +46,21 @@ Provides-Extra: test
 [![PyPI](https://img.shields.io/pypi/v/holobench)](https://pypi.org/project/holobench/)
 [![GitHub release](https://img.shields.io/github/release/dyson-ai/bencher.svg)](https://GitHub.com/dyson-ai/bencher/releases/)
 [![License](https://img.shields.io/pypi/l/bencher)](https://opensource.org/license/mit/)
-[![Python](https://img.shields.io/badge/python-3.10%20%7C%203.11-blue)](https://www.python.org/downloads/release/python-310/)
+[![Python](https://img.shields.io/badge/python-3.10-blue)](https://www.python.org/downloads/release/python-310/)
+[![Python](https://img.shields.io/badge/python-3.11-blue)](https://www.python.org/downloads/release/python-311/)
+[![Pixi Badge](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/prefix-dev/pixi/main/assets/badge/v0.json)](https://pixi.sh)
+
+## Badges
+
+### Pixi Badge
+The Pixi badge indicates that this project is optimized for performance and follows best practices as evaluated by the Pixi tool. For more information, visit [Pixi](https://pixi.sh).
 
 
 ## Intro
 
-Bencher is a tool to make it easy to benchmark the interactions between the input parameters to your algorithm and its resulting performance on a set of metrics.
+Bencher is a tool to make it easy to benchmark the interactions between the input parameters to your algorithm and its resulting performance on a set of metrics.  It calculates the [cartesian product](https://en.wikipedia.org/wiki/Cartesian_product) of a set of variables
 
-Parameters for bencher are defined using the param library https://param.holoviz.org/ as a config class with extra metadata that describes the bounds of the search space you want to measure.  You must define a benchmarking function that accepts an instance of the config class and return a dictionary with string metric names and float values.
+Parameters for bencher are defined using the [param](https://param.holoviz.org/) library  as a config class with extra metadata that describes the bounds of the search space you want to measure.  You must define a benchmarking function that accepts an instance of the config class and return a dictionary with string metric names and float values.
 
 Parameters are benchmarked by passing in a list N parameters, and an N-Dimensional tensor is returned.   You can optionally sample each point multiple times to get back a distribution and also track its value over time.  By default the data will be plotted automatically based on the types of parameters you are sampling (e.g, continous, discrete), but you can also pass in a callback to customize plotting.
 

holobench-1.22.2.dist-info/RECORD

@@ -0,0 +1,20 @@
+bencher/__init__.py,sha256=G37hQHeemdNYZUaN5BYds5v8AFLzVM1KIAkpUcrk2To,1321
+bencher/bench_cfg.py,sha256=8rvJyeQXalZmYF8Lb-NKb9RFJs0w08k9ogcZSR1rhgs,18413
+bencher/bench_plot_server.py,sha256=D00_SOrHa2IT8zAjwetoNL6tEiHSHvXnbea9iElCLVk,4195
+bencher/bench_report.py,sha256=jh3T_q9KByZDeMPMf0KNJojZukxRzkfaYGeuWQU8MKM,10528
+bencher/bench_runner.py,sha256=F4DN1YSFXnUAGO17tJ6DZDyEu7QBgvTyqn8G_iCd36c,6165
+bencher/bencher.py,sha256=SmdjwFEdjNkPTVeoG6oXLRM8LOobZLVN90LSAsHCS5E,33299
+bencher/caching.py,sha256=AusaNrzGGlj5m6zcwcqnTn55Mam2mQdF--oqelO806M,1627
+bencher/class_enum.py,sha256=kYHW9qKkKcNdwaXizZL-fTptS_DUEGv4c88yCehk3gc,1492
+bencher/job.py,sha256=swa0VwrZf41v7qNjreVDIYUU6r_dfuLipPZbg_w5x7c,6089
+bencher/optuna_conversions.py,sha256=DAa1DBXJ5EvTGiPyzuDTovQSjKVpMZ2sdwEXThlXJVU,5288
+bencher/utils.py,sha256=MXoJxtpBOf82-iiZBdWBSz6U0AqoUImQK1rXlmwWzF4,6125
+bencher/video_writer.py,sha256=v0yXr7PV0rYWTWqVWBZkXFD3N_ExrZHHHkbEXcXK5bc,4512
+bencher/worker_job.py,sha256=FREi0yWQACFmH86R1j-LH72tALEFkKhLDmmoGQY9Jh4,1571
+holobench-1.22.2.data/data/share/ament_index/resource_index/packages/bencher,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+holobench-1.22.2.data/data/share/bencher/package.xml,sha256=HxWM9qIEiLbE60tG0aKsS7q3UaSKDyCMD4-1nYw8vOs,1045
+holobench-1.22.2.dist-info/LICENSE,sha256=dSHXTdRY4Y7qGFMv63UksV700iff7iE-p7GGs6Sbnvo,1065
+holobench-1.22.2.dist-info/METADATA,sha256=MVUNJCVjAdZG72Is39V08gCnGUgqZl9iSpPonIbdIzk,5613
+holobench-1.22.2.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+holobench-1.22.2.dist-info/top_level.txt,sha256=rkP5-F_W08mOD-25ZPkt0HJsHxedb2EiRcRA7IP6Ceg,8
+holobench-1.22.2.dist-info/RECORD,,

{holobench-1.3.5.dist-info → holobench-1.22.2.dist-info}/WHEEL

@@ -1,4 +1,5 @@
 Wheel-Version: 1.0
-Generator: flit 3.9.0
+Generator: bdist_wheel (0.43.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
+

holobench-1.22.2.dist-info/top_level.txt

@@ -0,0 +1 @@
+bencher

bencher/example/benchmark_data.py

@@ -1,200 +0,0 @@
-"""This file contains an example of how to define benchmarking parameters sweeps. Categorical values are defined as enums and passed to EnumSweep classes, other types of sweeps are defined by their respective classes.
-
-You can define a subclass which contains an input configuration which can be passed to a function in a type safe way. You can combine the subclass with a higher level class which contains more configuation parameters.  This is to help manage the complexity of large configuration/parameter spaces. 
-"""
-
-import math
-import random
-from enum import auto
-
-from strenum import StrEnum
-
-
-from bencher.variables.inputs import IntSweep, FloatSweep, StringSweep, EnumSweep, BoolSweep
-from bencher.variables.results import ResultVar, OptDir
-
-from bencher.variables.parametrised_sweep import ParametrizedSweep
-
-
-class PostprocessFn(StrEnum):
-    """Apply a postprocessing step to the data"""
-
-    absolute = auto()  # return the abs of the output data
-    negate = auto()  # return the negative of the output data
-
-
-class NoiseDistribution(StrEnum):
-    """A categorical variable describing the types of random noise"""
-
-    uniform = auto()  # uniform random noiase
-    gaussian = auto()  # gaussian noise
-    lognorm = auto()  # lognorm noise
-
-
-class NoiseCfg(ParametrizedSweep):
-    """A class for storing the parameters for generating various types of noise"""
-
-    noisy = BoolSweep(
-        default=False, doc="Optionally add random noise to the output of the function"
-    )
-
-    noise_distribution = EnumSweep(NoiseDistribution, doc=NoiseDistribution.__doc__)
-
-    sigma = FloatSweep(
-        default=1,
-        bounds=[0, 10],
-        doc="The standard deviation of the noise",
-        units="v",
-    )
-
-
-def calculate_noise(config: NoiseCfg) -> float:
-    """Generate a float value based on a noise distribution and scale
-
-    Args:
-        config (NoiseCfg): see NoiseCfg type
-
-    Returns:
-        float: a noisy float value
-    """
-
-    noise = 0.0
-    if config.noisy:
-        match config.noise_distribution:
-            case NoiseDistribution.uniform:
-                noise = random.uniform(0, config.sigma)
-            case NoiseDistribution.gaussian:
-                noise = random.gauss(0, config.sigma)
-            case NoiseDistribution.lognorm:
-                noise = random.lognormvariate(0, config.sigma)
-
-    return noise
-
-
-class ExampleBenchCfgIn(NoiseCfg):
-    """A class for representing a set of configuration options for the example worker. This class inherits from NoiseCfg so it also stores all its values as well."""
-
-    theta = FloatSweep(default=0, bounds=[0, math.pi], doc="Input angle", units="rad", samples=30)
-    offset = FloatSweep(default=0, bounds=[0, 0.3], doc="dc offset", units="v", samples=30)
-    postprocess_fn = EnumSweep(PostprocessFn)
-
-
-class ExampleBenchCfgOut(ParametrizedSweep):
-    out_sin = ResultVar(units="v", direction=OptDir.minimize, doc="sin of theta with some noise")
-    out_cos = ResultVar(units="v", direction=OptDir.minimize, doc="cos of theta with some noise")
-    out_bool = ResultVar(units="%", doc="sin > 0.5")
-
-
-def negate_fn(fn_input: float):
-    """returns the negative of the input
-
-    Args:
-        fn_input (float): any float value
-
-    Returns:
-        float: negative of the input
-    """
-    return -fn_input
-
-
-def bench_function(cfg: ExampleBenchCfgIn) -> ExampleBenchCfgOut:
-    """Takes an ExampleBenchCfgIn and returns a ExampleBenchCfgOut output"""
-    out = ExampleBenchCfgOut()
-    noise = calculate_noise(cfg)
-
-    postprocess_fn = abs if cfg.postprocess_fn == PostprocessFn.absolute else negate_fn
-
-    out.out_sin = postprocess_fn(cfg.offset + math.sin(cfg.theta) + noise)
-    out.out_cos = postprocess_fn(cfg.offset + math.cos(cfg.theta) + noise)
-
-    out.out_bool = out.out_sin > 0.5
-    return out
-
-
-class ExampleBenchCfg(ParametrizedSweep):
-    theta = FloatSweep(default=0, bounds=[0, math.pi], doc="Input angle", units="rad", samples=30)
-    offset = FloatSweep(default=0, bounds=[0, 0.3], doc="dc offset", units="v", samples=30)
-    postprocess_fn = EnumSweep(PostprocessFn)
-
-    noisy = BoolSweep(
-        default=False, doc="Optionally add random noise to the output of the function"
-    )
-    noise_distribution = EnumSweep(NoiseDistribution, doc=NoiseDistribution.__doc__)
-    sigma = FloatSweep(
-        default=1,
-        bounds=[0, 10],
-        doc="The standard deviation of the noise",
-        units="v",
-    )
-
-    out_sin = ResultVar(units="v", direction=OptDir.minimize, doc="sin of theta with some noise")
-    out_cos = ResultVar(units="v", direction=OptDir.minimize, doc="cos of theta with some noise")
-    out_bool = ResultVar(units="%", doc="sin > 0.5")
-
-    def __call__(self, **kwwargs) -> dict:
-        self.update_params_from_kwargs(**kwwargs)
-
-        noise = self.calculate_noise()
-        postprocess_fn = abs if self.postprocess_fn == PostprocessFn.absolute else negate_fn
-
-        self.out_sin = postprocess_fn(self.offset + math.sin(self.theta) + noise)
-        self.out_cos = postprocess_fn(self.offset + math.cos(self.theta) + noise)
-        self.out_bool = self.out_sin > 0.5
-        return self.get_results_values_as_dict()
-
-    def calculate_noise(self):
-        noise = 0.0
-        if self.noisy:
-            match self.noise_distribution:
-                case NoiseDistribution.uniform:
-                    noise = random.uniform(0, self.sigma)
-                case NoiseDistribution.gaussian:
-                    noise = random.gauss(0, self.sigma)
-                case NoiseDistribution.lognorm:
-                    noise = random.lognormvariate(0, self.sigma)
-
-        return noise
-
-
-def call(**kwargs) -> dict:
-    return ExampleBenchCfg().__call__(**kwargs)
-
-
-class AllSweepVars(ParametrizedSweep):
-    """A class containing all the sweep types, This class is used for unit testing how the configuration classes are serialised and hashed"""
-
-    var_float = FloatSweep(default=5, bounds=(0, 10), units="m/s")
-    var_int = IntSweep(default=3, bounds=[0, 4])
-    var_int_big = IntSweep(default=0, bounds=[0, 100], samples=3)
-    var_bool = BoolSweep()
-    var_string = StringSweep(["string1", "string2"])
-    var_enum = EnumSweep(PostprocessFn)
-
-    result = ResultVar()
-
-    def __call__(self, **kwargs) -> dict:
-        self.update_params_from_kwargs(**kwargs)
-        self.result = self.var_float + self.var_int
-        return self.get_results_values_as_dict()
-
-
-class SimpleBenchClass(ParametrizedSweep):
-    var1 = IntSweep(default=0, bounds=[0, 2])
-
-    result = ResultVar()
-
-    def __call__(self, **kwargs) -> dict:
-        self.update_params_from_kwargs(**kwargs)
-        self.result = self.var1
-        return self.get_results_values_as_dict()
-
-
-class SimpleBenchClassFloat(ParametrizedSweep):
-    var1 = FloatSweep(bounds=[0, 100])
-
-    result = ResultVar()
-
-    def __call__(self, **kwargs) -> dict:
-        self.update_params_from_kwargs(**kwargs)
-        self.result = self.var1
-        return self.get_results_values_as_dict()

bencher/example/example_all.py

@@ -1,45 +0,0 @@
-import bencher as bch
-
-from bencher.example.example_categorical import example_categorical
-from bencher.example.example_floats import example_floats
-from bencher.example.example_floats2D import example_floats2D
-from bencher.example.example_pareto import example_pareto
-from bencher.example.example_simple_cat import example_1D_cat
-from bencher.example.example_simple_float import example_1D_float
-from bencher.example.example_float_cat import example_float_cat
-from bencher.example.example_time_event import example_time_event
-from bencher.example.example_float3D import example_floats3D
-
-from bencher.example.example_custom_sweep import example_custom_sweep
-from bencher.example.example_holosweep import example_holosweep
-from bencher.example.example_holosweep_tap import example_holosweep_tap
-
-from bencher.example.optuna.example_optuna import optuna_rastrigin
-from bencher.example.example_sample_cache import example_sample_cache
-
-# from bencher.example.example_workflow import example_floats2D_workflow, example_floats3D_workflow
-
-
-if __name__ == "__main__":
-    run_cfg = bch.BenchRunCfg()
-    run_cfg.overwrite_sample_cache = True
-    bench_runner = bch.BenchRunner("bencher_examples", run_cfg=run_cfg)
-
-    bench_runner.add_run(example_categorical)
-    bench_runner.add_run(example_floats)
-    bench_runner.add_run(example_floats2D)
-    bench_runner.add_run(example_floats3D)
-    bench_runner.add_run(example_1D_cat)
-    bench_runner.add_run(example_1D_float)
-    bench_runner.add_run(example_pareto)
-    bench_runner.add_run(example_float_cat)
-    bench_runner.add_run(example_time_event)
-    bench_runner.add_run(example_custom_sweep)
-    bench_runner.add_run(example_holosweep)
-    bench_runner.add_run(example_holosweep_tap)
-    bench_runner.add_run(optuna_rastrigin)
-    bench_runner.add_run(example_sample_cache)
-
-    # bench_runner.run(level=2, show=True, grouped=True)
-
-    bench_runner.run(level=4, show=True, grouped=True, save=False)