holobench 1.32.0__tar.gz → 1.33.0__tar.gz

{holobench-1.32.0 → holobench-1.33.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: holobench
-Version: 1.32.0
+Version: 1.33.0
 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.32.0 → holobench-1.33.0}/bencher/__init__.py

@@ -64,7 +64,7 @@ from .caching import CachedParams
 from .results.bench_result import BenchResult
 from .results.panel_result import PanelResult
 from .results.holoview_result import ReduceType, HoloviewResult
-from .bench_report import BenchReport
+from .bench_report import BenchReport, GithubPagesCfg
 from .job import Executors
 from .video_writer import VideoWriter, add_image
 from .class_enum import ClassEnum, ExampleEnum

{holobench-1.32.0 → holobench-1.33.0}/bencher/bench_report.py

@@ -4,6 +4,7 @@ import os
 from pathlib import Path
 import tempfile
 from threading import Thread
+from dataclasses import dataclass
 
 import panel as pn
 from bencher.results.bench_result import BenchResult
@@ -11,6 +12,14 @@ from bencher.bench_plot_server import BenchPlotServer
 from bencher.bench_cfg import BenchRunCfg
 
 
+@dataclass
+class GithubPagesCfg:
+    github_user: str
+    repo_name: str
+    folder_name: str = "report"
+    branch_name: str = "gh-pages"
+
+
 class BenchReport(BenchPlotServer):
     def __init__(
         self,
@@ -111,6 +120,39 @@ class BenchReport(BenchPlotServer):
 
         return BenchPlotServer().plot_server(self.bench_name, run_cfg, self.pane)
 
+    def publish_gh_pages(
+        self,
+        github_user: str,
+        repo_name: str,
+        folder_name: str = "report",
+        branch_name: str = "gh-pages",
+    ) -> str:  # pragma: no cover
+        remote = f"https://github.com/{github_user}/{repo_name}.git"
+        publish_url = f"https://{github_user}.github.io/{repo_name}/{folder_name}"
+
+        with tempfile.TemporaryDirectory() as td:
+            directory = td
+            report_path = self.save(
+                directory + f"/{folder_name}/",
+                filename="index.html",
+                in_html_folder=False,
+            )
+            logging.info(f"created report at: {report_path.absolute()}")
+
+            cd_dir = f"cd {directory} &&"
+            # TODO DON'T OVERWRITE EVERYTHING
+            os.system(f"{cd_dir} git init")
+            os.system(f"{cd_dir} git checkout -b {branch_name}")
+            os.system(f"{cd_dir} git add {folder_name}/index.html")
+            os.system(f'{cd_dir} git commit -m "publish {branch_name}"')
+            os.system(f"{cd_dir} git remote add origin {remote}")
+            os.system(f"{cd_dir} git push --set-upstream origin {branch_name} -f")
+
+        logging.info("Published report @")
+        logging.info(publish_url)
+
+        return publish_url
+
     def publish(
         self, remote_callback: Callable, branch_name: str = None, debug: bool = False
     ) -> str:  # pragma: no cover
@@ -155,10 +197,3 @@ class BenchReport(BenchPlotServer):
         logging.info(publish_url)
 
         return publish_url
-
-    # @staticmethod
-    # def publish_github(github_user: str, repo_name: str, branch_name: str) -> Tuple[str, str]:
-    #     return (
-    #         f"https://github.com/{github_user}/{repo_name}.git",
-    #         f"https://github.com/{github_user}/{repo_name}/blob/{branch_name}",
-    #     )

{holobench-1.32.0 → holobench-1.33.0}/bencher/bench_runner.py

@@ -3,7 +3,7 @@ import logging
 from bencher.bench_cfg import BenchRunCfg, BenchCfg
 from bencher.variables.parametrised_sweep import ParametrizedSweep
 from bencher.bencher import Bench
-from bencher.bench_report import BenchReport
+from bencher.bench_report import BenchReport, GithubPagesCfg
 from copy import deepcopy
 
 
@@ -47,7 +47,12 @@ class BenchRunner:
         run_cfg: BenchRunCfg = BenchRunCfg(),
         report: BenchReport = BenchReport(),
     ):
-        return Bench(f"bench_{class_instance.name}", class_instance, run_cfg=run_cfg, report=report)
+        return Bench(
+            f"bench_{class_instance.name}",
+            class_instance,
+            run_cfg=run_cfg,
+            report=report,
+        )
 
     def add_run(self, bench_fn: Benchable) -> None:
         self.bench_fns.append(bench_fn)
@@ -125,7 +130,11 @@ class BenchRunner:
         if save:
             report.save_index()
         if publish and self.publisher is not None:
-            report.publish(remote_callback=self.publisher, debug=debug)
+            if isinstance(self.publisher, GithubPagesCfg):
+                p = self.publisher
+                report.publish_gh_pages(p.github_user, p.repo_name, p.folder_name, p.branch_name)
+            else:
+                report.publish(remote_callback=self.publisher, debug=debug)
         if show:
             self.servers.append(report.show())
 

holobench-1.33.0/bencher/example/example_publish.py

@@ -0,0 +1,31 @@
+"""This file has an example of how to publish a report to github pages"""
+
+import math
+import bencher as bch
+
+
+class SimpleFloat(bch.ParametrizedSweep):
+    theta = bch.FloatSweep(
+        default=0, bounds=[0, math.pi], doc="Input angle", units="rad", samples=30
+    )
+    out_sin = bch.ResultVar(units="v", doc="sin of theta")
+
+    def __call__(self, **kwargs):
+        self.update_params_from_kwargs(**kwargs)
+        self.out_sin = math.sin(self.theta)
+        return super().__call__(**kwargs)
+
+
+if __name__ == "__main__":
+    # publish from report
+    bench = SimpleFloat().to_bench()
+    bench.plot_sweep()
+    bench.report.publish_gh_pages(github_user="blooop", repo_name="reports", folder_name="r5")
+    # TODO DON'T OVERWRITE ^ EXAMPLE WHEN RUNNING CODE BELOW
+
+    # publish from benchrunner
+    bench_r = bch.BenchRunner(
+        "SimpleFloat", publisher=bch.GithubPagesCfg("blooop", "reports", "r6")
+    )
+    bench_r.add_bench(SimpleFloat())
+    bench_r.run(level=3, show=True, publish=True)

{holobench-1.32.0 → holobench-1.33.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "holobench"
-version = "1.32.0"
+version = "1.33.0"
 
 authors = [{ name = "Austin Gregg-Smith", email = "blooop@gmail.com" }]
 description = "A package for benchmarking the performance of arbitrary functions"
@@ -10,23 +10,23 @@ license = "MIT"
 requires-python = ">=3.10,<3.13"
 
 dependencies = [
-  "holoviews>=1.15,<=1.19.1",
-  "numpy>=1.0,<=2.1.3",
-  "param>=1.13.0,<=2.1.1",
-  "hvplot>=0.8,<=0.10.0",
-  "matplotlib>=3.6.3,<=3.9.2",
-  "panel>=1.3.6,<=1.4.5",
-  "diskcache>=5.6,<=5.6.3",
-  "optuna>=3.2,<=4.0.0",
-  "xarray>=2023.7,<=2024.7.0",
-  "plotly>=5.15,<=5.24.1",
-  "sortedcontainers>=2.4,<=2.4",
-  "pandas>=2.0,<=2.2.2",
-  "strenum>=0.4.0,<=0.4.15",
-  "scikit-learn>=1.2,<=1.5.1",
-  "str2bool>=1.1,<=1.1",
-  "scoop>=0.7.0,<=0.7.2.0",
-  "moviepy-fix-codec",
+    "holoviews>=1.15,<=1.19.1",
+    "numpy>=1.0,<=2.1.3",
+    "param>=1.13.0,<=2.1.1",
+    "hvplot>=0.8,<=0.10.0",
+    "matplotlib>=3.6.3,<=3.9.2",
+    "panel>=1.3.6,<=1.4.5",
+    "diskcache>=5.6,<=5.6.3",
+    "optuna>=3.2,<=4.0.0",
+    "xarray>=2023.7,<=2024.7.0",
+    "plotly>=5.15,<=5.24.1",
+    "sortedcontainers>=2.4,<=2.4",
+    "pandas>=2.0,<=2.2.2",
+    "strenum>=0.4.0,<=0.4.15",
+    "scikit-learn>=1.2,<=1.5.1",
+    "str2bool>=1.1,<=1.1",
+    "scoop>=0.7.0,<=0.7.2.0",
+    "moviepy-fix-codec",
 ]
 
 [project.urls]
@@ -54,13 +54,13 @@ holobench = { path = ".", editable = true }
 
 [project.optional-dependencies]
 test = [
-  "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.122.0",
-  "ruff>=0.5.0,<=0.8.1",
-  "coverage>=7.5.4,<=7.6.8",
-  "pre-commit<=4.0.1",
+    "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.122.0",
+    "ruff>=0.5.0,<=0.8.1",
+    "coverage>=7.5.4,<=7.6.8",
+    "pre-commit<=4.0.1",
 ]
 
 #adds support for embedding rerun windows (alpha)
@@ -101,11 +101,11 @@ fix = { depends_on = ["update-lock", "pre-commit", "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",
-  "pylint",
-  "coverage",
-  "coverage-report",
+    "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"
@@ -129,12 +129,12 @@ omit = ["*/test/*", "__init__.py"]
 
 [tool.coverage.report]
 exclude_also = [
-  "def __repr__",
-  "if False:",
-  "if 0:",
-  "raise AssertionError",
-  "raise NotImplementedError",
-  "if __name__ == .__main__.:",
-  "pass",
-  "(_):",
+    "def __repr__",
+    "if False:",
+    "if 0:",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if __name__ == .__main__.:",
+    "pass",
+    "(_):",
 ]