holobench 1.29.0__tar.gz → 1.30.1__tar.gz

holobench-1.30.1/.gitignore

@@ -0,0 +1,180 @@
+#the default directory diskcache uses to store its cache files
+cachedir/
+unique_names/
+
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+hashed_vars_comparison_tmp
+.vscode/active_file.cfg
+test/test_bench_server.html
+.vscode/active_file.cfg
+
+#COLCON
+install/**
+log/**
+# pixi environments
+.pixi
+*.egg-info
+
+managed_context/metadata.json
+test_suite_analysis/metadata.json

{holobench-1.29.0/holobench.egg-info → holobench-1.30.1}/PKG-INFO

@@ -1,38 +1,39 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: holobench
-Version: 1.29.0
+Version: 1.30.1
 Summary: A package for benchmarking the performance of arbitrary functions
-Author-email: Austin Gregg-Smith <blooop@gmail.com>
 Project-URL: Repository, https://github.com/dyson-ai/bencher
 Project-URL: Home, https://github.com/dyson-ai/bencher
 Project-URL: Documentation, https://bencher.readthedocs.io/en/latest/
-Description-Content-Type: text/markdown
+Author-email: Austin Gregg-Smith <blooop@gmail.com>
+License-Expression: MIT
 License-File: LICENSE
-Requires-Dist: holoviews<=1.19.0,>=1.15
-Requires-Dist: numpy<=2.0.0,>=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.4,>=1.3.6
 Requires-Dist: diskcache<=5.6.3,>=5.6
-Requires-Dist: optuna<=3.6.1,>=3.2
-Requires-Dist: xarray<=2024.6.0,>=2023.7
-Requires-Dist: plotly<=5.22.0,>=5.15
+Requires-Dist: holoviews<=1.19.1,>=1.15
+Requires-Dist: hvplot<=0.11.1,>=0.8
+Requires-Dist: matplotlib<=3.9.2,>=3.6.3
+Requires-Dist: moviepy-fix-codec
+Requires-Dist: numpy<=2.1.2,>=1.0
+Requires-Dist: optuna<=4.0.0,>=3.2
+Requires-Dist: pandas<=2.2.3,>=2.0
+Requires-Dist: panel<=1.5.3,>=1.3.6
+Requires-Dist: param<=2.1.1,>=1.13.0
+Requires-Dist: plotly<=5.24.1,>=5.15
+Requires-Dist: scikit-learn<=1.5.2,>=1.2
+Requires-Dist: scoop<=0.7.2.0,>=0.7.0
 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
+Requires-Dist: strenum<=0.4.15,>=0.4.0
+Requires-Dist: xarray<=2024.10.0,>=2023.7
 Provides-Extra: test
-Requires-Dist: black<=24.4.2,>=23; extra == "test"
-Requires-Dist: pylint<=3.2.3,>=2.17.7; extra == "test"
-Requires-Dist: pytest-cov<=5.0.0,>=4.1; extra == "test"
-Requires-Dist: pytest<=8.2.2,>=7.4; extra == "test"
-Requires-Dist: hypothesis<=6.103.2,>=6.82; extra == "test"
-Requires-Dist: ruff<=0.4.10,>=0.0.280; extra == "test"
-Requires-Dist: coverage<=7.5.3,>=7.2.7; extra == "test"
+Requires-Dist: black<=24.10.0,>=23; extra == 'test'
+Requires-Dist: coverage<=7.6.4,>=7.5.4; extra == 'test'
+Requires-Dist: hypothesis<=6.116.0,>=6.104.2; extra == 'test'
+Requires-Dist: pylint<=3.3.1,>=3.2.5; extra == 'test'
+Requires-Dist: pytest-cov<=6.0.0,>=4.1; extra == 'test'
+Requires-Dist: pytest<=8.3.3,>=7.4; extra == 'test'
+Requires-Dist: ruff<=0.7.2,>=0.5.0; extra == 'test'
+Description-Content-Type: text/markdown
 
 # Bencher
  
@@ -44,17 +45,16 @@ Requires-Dist: coverage<=7.5.3,>=7.2.7; extra == "test"
 [![GitHub issues](https://img.shields.io/github/issues/dyson-ai/bencher.svg)](https://GitHub.com/dyson-ai/bencher/issues/)
 [![GitHub pull-requests merged](https://badgen.net/github/merged-prs/dyson-ai/bencher)](https://github.com/dyson-ai/bencher/pulls?q=is%3Amerged)
 [![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/)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/holobench)](https://pypistats.org/packages/holobench)
 [![License](https://img.shields.io/pypi/l/bencher)](https://opensource.org/license/mit/)
-[![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/)
+[![Python](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-blue)](https://www.python.org/downloads/)
 [![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).
+## Install
 
+```bash
+pip install holobench
+```
 
 ## Intro
 
@@ -85,9 +85,43 @@ Bencher is designed to work with stochastic pure functions with no side effects.
             combine latest data with historical data
         
         store the results using the input hash as a key
-    deduce the type of plot based on the input types
+    deduce the type of plot based on the input and output types
     return data and plot
     
-### Example Output
+
+## Demo
+
+if you have [pixi](https://github.com/prefix-dev/pixi/) installed you can run a demo example with:
+
+```bash
+pixi run demo
+```
+
+An example of the type of output bencher produces can be seen here:
 
 https://dyson-ai.github.io/bencher/ 
+
+
+## Examples
+
+Most of the features that are supported are demonstrated in the examples folder.
+
+Start with example_simple_float.py and explore other examples based on your data types:
+- example_float.py: More complex float operations
+- example_float2D.py: 2D float sweeps
+- example_float3D.py: 3D float sweeps 
+- example_categorical.py: Sweeping categorical values (enums)
+- example_strings.py: Sweeping categorical string values
+- example_float_cat.py: Mixing float and categorical values
+- example_image.py: Output images as part of the sweep
+- example_video.py: Output videos as part of the sweep
+- example_filepath.py: Output arbitrary files as part of the sweep
+- and many others
+
+
+## Documentation
+
+API documentation can be found at https://bencher.readthedocs.io/en/latest/
+
+More documentation is needed for the examples and general workflow. 
+

{holobench-1.29.0 → holobench-1.30.1}/README.md

@@ -8,17 +8,16 @@
 [![GitHub issues](https://img.shields.io/github/issues/dyson-ai/bencher.svg)](https://GitHub.com/dyson-ai/bencher/issues/)
 [![GitHub pull-requests merged](https://badgen.net/github/merged-prs/dyson-ai/bencher)](https://github.com/dyson-ai/bencher/pulls?q=is%3Amerged)
 [![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/)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/holobench)](https://pypistats.org/packages/holobench)
 [![License](https://img.shields.io/pypi/l/bencher)](https://opensource.org/license/mit/)
-[![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/)
+[![Python](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-blue)](https://www.python.org/downloads/)
 [![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).
+## Install
 
+```bash
+pip install holobench
+```
 
 ## Intro
 
@@ -49,9 +48,43 @@ Bencher is designed to work with stochastic pure functions with no side effects.
             combine latest data with historical data
         
         store the results using the input hash as a key
-    deduce the type of plot based on the input types
+    deduce the type of plot based on the input and output types
     return data and plot
     
-### Example Output
+
+## Demo
+
+if you have [pixi](https://github.com/prefix-dev/pixi/) installed you can run a demo example with:
+
+```bash
+pixi run demo
+```
+
+An example of the type of output bencher produces can be seen here:
 
 https://dyson-ai.github.io/bencher/ 
+
+
+## Examples
+
+Most of the features that are supported are demonstrated in the examples folder.
+
+Start with example_simple_float.py and explore other examples based on your data types:
+- example_float.py: More complex float operations
+- example_float2D.py: 2D float sweeps
+- example_float3D.py: 3D float sweeps 
+- example_categorical.py: Sweeping categorical values (enums)
+- example_strings.py: Sweeping categorical string values
+- example_float_cat.py: Mixing float and categorical values
+- example_image.py: Output images as part of the sweep
+- example_video.py: Output videos as part of the sweep
+- example_filepath.py: Output arbitrary files as part of the sweep
+- and many others
+
+
+## Documentation
+
+API documentation can be found at https://bencher.readthedocs.io/en/latest/
+
+More documentation is needed for the examples and general workflow. 
+

{holobench-1.29.0 → holobench-1.30.1}/bencher/bencher.py

@@ -628,7 +628,7 @@ class Bench(BenchPlotServer):
                 result_data = np.full(dims_cfg.dims_size, "NAN", dtype=object)
                 data_vars[rv.name] = (dims_cfg.dims_name, result_data)
 
-            elif type(rv) == ResultVec:
+            elif type(rv) is ResultVec:
                 for i in range(rv.size):
                     result_data = np.full(dims_cfg.dims_size, np.nan)
                     data_vars[rv.index_name(i)] = (dims_cfg.dims_name, result_data)
@@ -834,10 +834,10 @@ class Bench(BenchPlotServer):
         """
 
         for rv in bench_res.bench_cfg.result_vars:
-            if type(rv) == ResultVar:
+            if type(rv) is ResultVar:
                 bench_res.ds[rv.name].attrs["units"] = rv.units
                 bench_res.ds[rv.name].attrs["long_name"] = rv.name
-            elif type(rv) == ResultVec:
+            elif type(rv) is ResultVec:
                 for i in range(rv.size):
                     bench_res.ds[rv.index_name(i)].attrs["units"] = rv.units
                     bench_res.ds[rv.index_name(i)].attrs["long_name"] = rv.name

{holobench-1.29.0 → holobench-1.30.1}/bencher/results/optuna_result.py

@@ -178,7 +178,7 @@ class OptunaResult:
             df = self.to_pandas()
             all_vars = []
             for v in self.bench_cfg.all_vars:
-                if type(v) != TimeEvent:
+                if type(v) is not TimeEvent:
                     all_vars.append(v)
 
             print("All vars", all_vars)
@@ -203,8 +203,8 @@ class OptunaResult:
             params = {}
             values = []
             for i in all_vars:
-                if type(i) == TimeSnapshot:
-                    if type(row[1][i.name]) == np.datetime64:
+                if type(i) is TimeSnapshot:
+                    if type(row[1][i.name]) is np.datetime64:
                         params[i.name] = row[1][i.name].timestamp()
                 else:
                     params[i.name] = row[1][i.name]

{holobench-1.29.0 → holobench-1.30.1}/pyproject.toml

@@ -1,31 +1,37 @@
 [project]
 name = "holobench"
-version = "1.29.0"
+version = "1.30.1"
 
 authors = [{ name = "Austin Gregg-Smith", email = "blooop@gmail.com" }]
 description = "A package for benchmarking the performance of arbitrary functions"
 readme = "README.md"
+license = "MIT"
 
 dependencies = [
-  "holoviews>=1.15,<=1.19.0",
-  "numpy>=1.0,<=2.0.0",
-  "param>=1.13.0,<=2.1.0",
-  "hvplot>=0.8,<=0.10.0",
-  "matplotlib>=3.6.3,<=3.9.0",
-  "panel>=1.3.6,<=1.4.4",
+  "holoviews>=1.15,<=1.19.1",
+  "numpy>=1.0,<=2.1.2",
+  "param>=1.13.0,<=2.1.1",
+  "hvplot>=0.8,<=0.11.1",
+  "matplotlib>=3.6.3,<=3.9.2",
+  "panel>=1.3.6,<=1.5.3",
   "diskcache>=5.6,<=5.6.3",
-  "optuna>=3.2,<=3.6.1",
-  "xarray>=2023.7,<=2024.6.0",
-  "plotly>=5.15,<=5.22.0",
+  "optuna>=3.2,<=4.0.0",
+  "xarray>=2023.7,<=2024.10.0",
+  "plotly>=5.15,<=5.24.1",
   "sortedcontainers>=2.4,<=2.4",
-  "pandas>=2.0,<=2.2.2",
+  "pandas>=2.0,<=2.2.3",
   "strenum>=0.4.0,<=0.4.15",
-  "scikit-learn>=1.2,<=1.5.0",
+  "scikit-learn>=1.2,<=1.5.2",
   "str2bool>=1.1,<=1.1",
   "scoop>=0.7.0,<=0.7.2.0",
-  "moviepy>=1.0.3,<=1.0.3",
+  "moviepy-fix-codec",
 ]
 
+[project.urls]
+Repository = "https://github.com/dyson-ai/bencher"
+Home = "https://github.com/dyson-ai/bencher"
+Documentation = "https://bencher.readthedocs.io/en/latest/"
+
 [tool.pixi.project]
 channels = ["conda-forge"]
 platforms = ["linux-64"]
@@ -38,38 +44,38 @@ python = ">=3.10"
 python = "3.10.*"
 [tool.pixi.feature.py311.dependencies]
 python = "3.11.*"
+[tool.pixi.feature.py312.dependencies]
+python = "3.12.*"
+
 
 [tool.pixi.pypi-dependencies]
-holobench = { path = ".",editable=true}
+holobench = { path = ".", editable = true }
 
 [project.optional-dependencies]
 test = [
-  "black>=23,<=24.4.2",
-  "pylint>=2.17.7,<=3.2.3",
-  "pytest-cov>=4.1,<=5.0.0",
-  "pytest>=7.4,<=8.2.2",
-  "hypothesis>=6.82,<=6.103.2",
-  "ruff>=0.0.280,<=0.4.10",
-  "coverage>=7.2.7,<=7.5.3",
+  "black>=23,<=24.10.0",
+  "pylint>=3.2.5,<=3.3.1",
+  "pytest-cov>=4.1,<=6.0.0",
+  "pytest>=7.4,<=8.3.3",
+  "hypothesis>=6.104.2,<=6.116.0",
+  "ruff>=0.5.0,<=0.7.2",
+  "coverage>=7.5.4,<=7.6.4",
 ]
 
-[project.urls]
-Repository = "https://github.com/dyson-ai/bencher"
-Home = "https://github.com/dyson-ai/bencher"
-Documentation = "https://bencher.readthedocs.io/en/latest/"
-
 [build-system]
-requires = ["setuptools"]
-build-backend = "setuptools.build_meta"
+requires = ["hatchling"]
+build-backend = "hatchling.build"
 
-[tool.setuptools.packages.find]
+[tool.hatch.build]
 include = ["bencher"]
 
 # Environments
 [tool.pixi.environments]
-default = { features = ["test"], solve-group = "default" }
-py310 = ["py310", "test"]
-py311 = ["py311", "test"]
+default = {features = ["test"], solve-group = "default" }
+py310 = ["py310","test"]
+py311 = ["py311","test"]
+py312 = ["py312","test"]
+
 
 [tool.pixi.tasks]
 success = "echo Success"
@@ -89,25 +95,21 @@ update-lock-push = { depends_on = ["update-lock", "push"] }
 fix = { depends_on = ["update-lock", "format", "ruff-lint"] }
 fix-commit-push = { depends_on = ["fix", "commit-format", "update-lock-push"] }
 ci-no-cover = { depends_on = ["style", "test"] }
-ci = { depends_on = [
-  "format",
-  "ruff-lint",
-  "check-clean-workspace",
-  "pylint",
-  "coverage",
-  "coverage-report",
-] }
-ci-push = { depends_on = ["format", "ruff-lint", "update-lock", "ci", "push"] }
+ci = { depends_on = ["format","ruff-lint", "pylint", "coverage", "coverage-report"] }
+ci-push = {depends_on=["format","ruff-lint","update-lock","ci","push"]}
 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"
 
+#demos
+demo = "python3 bencher/example/example_image.py"
+
 [tool.pylint]
 extension-pkg-whitelist = ["numpy", "scipy"]
 jobs = 16                                    #detect number of cores
 
 [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"
+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"
 enable = "no-else-return,consider-using-in"
 
 [tool.black]

holobench-1.29.0/MANIFEST.in

@@ -1 +0,0 @@
-recursive-include bencher/ *.py

holobench-1.29.0/PKG-INFO

@@ -1,93 +0,0 @@
-Metadata-Version: 2.1
-Name: holobench
-Version: 1.29.0
-Summary: A package for benchmarking the performance of arbitrary functions
-Author-email: Austin Gregg-Smith <blooop@gmail.com>
-Project-URL: Repository, https://github.com/dyson-ai/bencher
-Project-URL: Home, 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.19.0,>=1.15
-Requires-Dist: numpy<=2.0.0,>=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.4,>=1.3.6
-Requires-Dist: diskcache<=5.6.3,>=5.6
-Requires-Dist: optuna<=3.6.1,>=3.2
-Requires-Dist: xarray<=2024.6.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.3,>=2.17.7; extra == "test"
-Requires-Dist: pytest-cov<=5.0.0,>=4.1; extra == "test"
-Requires-Dist: pytest<=8.2.2,>=7.4; extra == "test"
-Requires-Dist: hypothesis<=6.103.2,>=6.82; extra == "test"
-Requires-Dist: ruff<=0.4.10,>=0.0.280; extra == "test"
-Requires-Dist: coverage<=7.5.3,>=7.2.7; extra == "test"
-
-# Bencher
- 
- ## Continuous Integration Status
-
-[![Ci](https://github.com/dyson-ai/bencher/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/dyson-ai/bencher/actions/workflows/ci.yml?query=branch%3Amain)
-![Read the Docs](https://img.shields.io/readthedocs/bencher)
-[![Codecov](https://codecov.io/gh/dyson-ai/bencher/branch/main/graph/badge.svg?token=Y212GW1PG6)](https://codecov.io/gh/dyson-ai/bencher)
-[![GitHub issues](https://img.shields.io/github/issues/dyson-ai/bencher.svg)](https://GitHub.com/dyson-ai/bencher/issues/)
-[![GitHub pull-requests merged](https://badgen.net/github/merged-prs/dyson-ai/bencher)](https://github.com/dyson-ai/bencher/pulls?q=is%3Amerged)
-[![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-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.  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](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.
-
-The data is stored in a persistent database so that past performance is tracked.
-
-## Assumptions
-
-The input types should also be of one of the basic datatypes (bool, int, float, str, enum, datetime) so that the data can be easily hashed, cached and stored in the database and processed with seaborn and xarray plotting functions. You can use class inheritance to define hierarchical parameter configuration class types that can be reused in a bigger configuration classes.
-
-Bencher is designed to work with stochastic pure functions with no side effects.  It assumes that when the objective function is given the same inputs, it will return the same output +- random noise.  This is because the function must be called multiple times to get a good statistical distribution of it and so each call must not be influenced by anything or the results will be corrupted.
-
-### Pseudocode of bencher
-
-    Enumerate a list of all input parameter combinations
-    for each set of input parameters:
-        pass the inputs to the objective function and store results in the N-D array
-
-        get unique hash for the set of inputs parameters
-        look up previous results for that hash
-        if it exists:
-            load historical data
-            combine latest data with historical data
-        
-        store the results using the input hash as a key
-    deduce the type of plot based on the input types
-    return data and plot
-    
-### Example Output
-
-https://dyson-ai.github.io/bencher/