holobench 1.32.0__py3-none-any.whl → 1.33.1__py3-none-any.whl

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

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}",
-    #     )

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())
 

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.dist-info → holobench-1.33.1.dist-info}/METADATA

@@ -1,43 +1,44 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: holobench
-Version: 1.32.0
+Version: 1.33.1
 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
 Project-URL: Documentation, https://bencher.readthedocs.io/en/latest/
 Author-email: Austin Gregg-Smith <blooop@gmail.com>
-License: MIT
+License-Expression: MIT
+License-File: LICENSE
 Requires-Python: <3.13,>=3.10
 Requires-Dist: diskcache<=5.6.3,>=5.6
-Requires-Dist: holoviews<=1.19.1,>=1.15
+Requires-Dist: holoviews<=1.20.0,>=1.15
 Requires-Dist: hvplot<=0.10.0,>=0.8
-Requires-Dist: matplotlib<=3.9.2,>=3.6.3
+Requires-Dist: matplotlib<=3.10.0,>=3.6.3
 Requires-Dist: moviepy-fix-codec
-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: numpy<=2.2.1,>=1.0
+Requires-Dist: optuna<=4.1.0,>=3.2
+Requires-Dist: pandas<=2.2.3,>=2.0
+Requires-Dist: panel<=1.5.5,>=1.3.6
+Requires-Dist: param<=2.2.0,>=1.13.0
 Requires-Dist: plotly<=5.24.1,>=5.15
-Requires-Dist: scikit-learn<=1.5.1,>=1.2
+Requires-Dist: scikit-learn<=1.6.0,>=1.2
 Requires-Dist: scoop<=0.7.2.0,>=0.7.0
 Requires-Dist: sortedcontainers<=2.4,>=2.4
 Requires-Dist: str2bool<=1.1,>=1.1
 Requires-Dist: strenum<=0.4.15,>=0.4.0
-Requires-Dist: xarray<=2024.7.0,>=2023.7
+Requires-Dist: xarray<=2024.11.0,>=2023.7
 Provides-Extra: rerun
 Requires-Dist: flask; extra == 'rerun'
 Requires-Dist: flask-cors; extra == 'rerun'
 Requires-Dist: rerun-notebook; extra == 'rerun'
 Requires-Dist: rerun-sdk==0.20.1; extra == 'rerun'
 Provides-Extra: test
-Requires-Dist: coverage<=7.6.8,>=7.5.4; extra == 'test'
-Requires-Dist: hypothesis<=6.122.0,>=6.104.2; extra == 'test'
+Requires-Dist: coverage<=7.6.10,>=7.5.4; extra == 'test'
+Requires-Dist: hypothesis<=6.123.2,>=6.104.2; extra == 'test'
 Requires-Dist: pre-commit<=4.0.1; extra == 'test'
-Requires-Dist: pylint<=3.3.1,>=3.2.5; extra == 'test'
+Requires-Dist: pylint<=3.3.3,>=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.8.1,>=0.5.0; extra == 'test'
+Requires-Dist: pytest<=8.3.4,>=7.4; extra == 'test'
+Requires-Dist: ruff<=0.8.4,>=0.5.0; extra == 'test'
 Description-Content-Type: text/markdown
 
 # Bencher

{holobench-1.32.0.dist-info → holobench-1.33.1.dist-info}/RECORD

@@ -1,8 +1,8 @@
-bencher/__init__.py,sha256=mE-PlylaVQSRPDdC3vcwW-mCkAki4i7Y8MavtEvOciY,1818
+bencher/__init__.py,sha256=CDfQPU9g0x4aYkYblf5epfJSg20Xv2giWFckhTF2de0,1834
 bencher/bench_cfg.py,sha256=mcsF5VU7Z-BLKE0bh9te73cEVNzr9pCnbsdIOPCJPy4,18414
 bencher/bench_plot_server.py,sha256=nvGTr981XgWELqV7yID91j6V1UIPGtKilzxHcNWaZ6Q,4196
-bencher/bench_report.py,sha256=FVMPZutQKTxq5Um46xLeJahntmuP76n7PaYhVGi4bB8,6364
-bencher/bench_runner.py,sha256=5h_g-WCxocUEIDix-D81zOz0YdN-3kC7tneN9yKEE0s,6201
+bencher/bench_report.py,sha256=ikMSHceyc8cYFH-sIza167DH-H-_iiTYDm2TmusUHDc,7515
+bencher/bench_runner.py,sha256=YkE7LXd-5dZ3Dro2OfuChXyTKVqQw1VqQmP5sdnZdLE,6490
 bencher/bencher.py,sha256=C71paITRtrESt_O2RNFdJ17Hg2zB6FSX4RINRsJq59c,35328
 bencher/caching.py,sha256=AusaNrzGGlj5m6zcwcqnTn55Mam2mQdF--oqelO806M,1627
 bencher/class_enum.py,sha256=kYHW9qKkKcNdwaXizZL-fTptS_DUEGv4c88yCehk3gc,1492
@@ -37,6 +37,7 @@ bencher/example/example_image1.py,sha256=3T6rgmCL7mCra2F6us-Fy0_jwhh7OvStmSieQui
 bencher/example/example_levels.py,sha256=gcNqjdsC0Bi0dX9oakssPEmuh_zFqpJhPYPPoDN3uw8,6890
 bencher/example/example_levels2.py,sha256=tMhA6dYYQskzMeAZdaz6jRmQTe-c-jLXfkaUqWT30-I,1117
 bencher/example/example_pareto.py,sha256=sLh37iZSQitW7DE7ktbyaOgHr1ZWxG7pXxCMH00KKqQ,2688
+bencher/example/example_publish.py,sha256=qIilHdsjqcUQ5u_IuGjjhJCLRkcQvhVuhI3efDrFTww,1005
 bencher/example/example_rerun.py,sha256=gruldZ6tmW56Mc6bPrNc7ChZEGHhYXPE4VVeG-L8w7M,981
 bencher/example/example_rerun2.py,sha256=TV8e2UMwLFowhiXb_sQG2IS-W5jXF67VCitVjD8u1o8,660
 bencher/example/example_sample_cache.py,sha256=7gf1BJ63VAgdqNuNXkbL9-jeTeC3kXA_PY9yG3ulTz0,4200
@@ -93,7 +94,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.32.0.dist-info/METADATA,sha256=rMrxwsX6FOYMEAVFA__m0ISq3EsKBKreKeMmGwyOMKQ,6564
-holobench-1.32.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-holobench-1.32.0.dist-info/licenses/LICENSE,sha256=dSHXTdRY4Y7qGFMv63UksV700iff7iE-p7GGs6Sbnvo,1065
-holobench-1.32.0.dist-info/RECORD,,
+holobench-1.33.1.dist-info/METADATA,sha256=T-8JdF_e_nEXUizB4QuZ3oxYUrPCMXzdWgcln7Au0LI,6600
+holobench-1.33.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+holobench-1.33.1.dist-info/licenses/LICENSE,sha256=dSHXTdRY4Y7qGFMv63UksV700iff7iE-p7GGs6Sbnvo,1065
+holobench-1.33.1.dist-info/RECORD,,

{holobench-1.32.0.dist-info → holobench-1.33.1.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.26.3
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any