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

bencher/__init__.py

@@ -1,9 +1,20 @@
 from .bencher import Bench, BenchCfg, BenchRunCfg
 from .bench_runner import BenchRunner
-from .example.benchmark_data import ExampleBenchCfgIn, ExampleBenchCfgOut, bench_function
+from .example.benchmark_data import (
+    ExampleBenchCfgIn,
+    ExampleBenchCfgOut,
+    bench_function,
+)
 from .bench_plot_server import BenchPlotServer
 from .variables.sweep_base import hash_sha1
-from .variables.inputs import IntSweep, FloatSweep, StringSweep, EnumSweep, BoolSweep, SweepBase
+from .variables.inputs import (
+    IntSweep,
+    FloatSweep,
+    StringSweep,
+    EnumSweep,
+    BoolSweep,
+    SweepBase,
+)
 from .variables.time import TimeSnapshot
 
 from .variables.inputs import box, p
@@ -32,7 +43,6 @@ from .results.composable_container.composable_container_video import (
     RenderCfg,
 )
 
-from .plotting.plot_filter import VarRange, PlotFilter
 from .utils import (
     hmap_canonical_input,
     get_nearest_coords,
@@ -40,9 +50,15 @@ from .utils import (
     gen_path,
     gen_image_path,
     gen_video_path,
+    gen_rerun_data_path,
     lerp,
     tabs_in_markdown,
+    publish_file,
+    github_content,
 )
+from .utils_rerun import publish_and_view_rrd, rrd_to_pane, record_rerun_session
+
+from .plotting.plot_filter import VarRange, PlotFilter
 from .variables.parametrised_sweep import ParametrizedSweep
 from .caching import CachedParams
 from .results.bench_result import BenchResult
@@ -52,3 +68,5 @@ from .bench_report import BenchReport
 from .job import Executors
 from .video_writer import VideoWriter, add_image
 from .class_enum import ClassEnum, ExampleEnum
+
+from .flask_server import run_flask_in_thread

bencher/bench_report.py

@@ -1,12 +1,11 @@
 import logging
 from typing import Callable
 import os
-import panel as pn
 from pathlib import Path
 import tempfile
-
 from threading import Thread
 
+import panel as pn
 from bencher.results.bench_result import BenchResult
 from bencher.bench_plot_server import BenchPlotServer
 from bencher.bench_cfg import BenchRunCfg

bencher/example/example_rerun.py

@@ -0,0 +1,30 @@
+import rerun as rr
+import bencher as bch
+
+rr.init("rerun_example_my_blueprint")
+
+
+class SweepRerun(bch.ParametrizedSweep):
+    theta = bch.FloatSweep(default=1, bounds=[1, 4], doc="Input angle", units="rad", samples=30)
+
+    out_pane = bch.ResultContainer()
+
+    def __call__(self, **kwargs):
+        self.update_params_from_kwargs(**kwargs)
+        self.out_pane = bch.record_rerun_session()
+        rr.log("s1", rr.Boxes2D(half_sizes=[self.theta, 1]))
+
+        return super().__call__(**kwargs)
+
+
+def example_rerun(run_cfg: bch.BenchRunCfg = None, report: bch.BenchReport = None) -> bch.Bench:
+    """This example shows how to sample a 1 dimensional float variable and plot the result of passing that parameter sweep to the benchmarking function"""
+
+    bench = SweepRerun().to_bench(run_cfg, report)
+    bench.plot_sweep()
+    return bench
+
+
+if __name__ == "__main__":
+    bch.run_flask_in_thread()
+    example_rerun(bch.BenchRunCfg(level=3)).report.show()

bencher/example/example_rerun2.py

@@ -0,0 +1,29 @@
+import rerun as rr
+import bencher as bch
+import panel as pn
+
+
+rr.init("rerun_example_local", spawn=True)
+file_path = "dat1.rrd"
+rr.save(file_path)
+
+rr.log("s1", rr.Scalar(1))
+rr.log("s1", rr.Scalar(4))
+rr.log("s1", rr.Scalar(2))
+
+local = True
+
+if local:
+    row = pn.Row()
+    # row.append(rrd_to_pane("http://localhost:8001/dat2.rrd"))
+
+    row.append(bch.rrd_to_pane("http://127.0.0.1:8001/dat2.rrd"))
+    row.show()
+else:
+    # publish data to a github branch
+    bch.publish_and_view_rrd(
+        file_path,
+        remote="https://github.com/dyson-ai/bencher.git",
+        branch_name="test_rrd",
+        content_callback=bch.github_content,
+    ).show()

bencher/flask_server.py

@@ -0,0 +1,25 @@
+from flask import Flask, send_from_directory
+from flask_cors import CORS
+import threading
+from pathlib import Path
+
+
+def create_server(directory):
+    """Create a Flask app configured to serve files from the specified directory."""
+    app = Flask(__name__)
+    CORS(app)
+
+    @app.route("/<path:path>", methods=["GET"])
+    def serve_file(path):
+        return send_from_directory(directory, path)
+
+    return app
+
+
+def run_flask_in_thread(directory=None, port=8001):
+    """Run the Flask server to serve files from the specified directory."""
+    if directory is None:
+        directory = Path("cachedir/").absolute().as_posix()
+    app = create_server(directory)
+    threading.Thread(target=app.run, kwargs={"port": port}, daemon=True).start()
+    print(f"Flask server is running on port {port} serving files from {directory}")

bencher/utils.py

@@ -9,6 +9,11 @@ from pathlib import Path
 from uuid import uuid4
 from functools import partial
 from typing import Callable, Any, List, Tuple
+import logging
+import os
+import tempfile
+import shutil
+
 import param
 import numpy as np
 
@@ -169,6 +174,10 @@ def gen_image_path(image_name: str = "img", filetype=".png") -> str:
     return gen_path(image_name, "img", filetype)
 
 
+def gen_rerun_data_path(rrd_name: str = "rrd", filetype=".rrd") -> str:
+    return gen_path(rrd_name, "rrd", filetype)
+
+
 def callable_name(any_callable: Callable[..., Any]) -> str:
     if isinstance(any_callable, partial):
         return any_callable.func.__name__
@@ -197,3 +206,90 @@ def get_name(var):
 
 def params_to_str(param_list: List[param.Parameter]):
     return [get_name(i) for i in param_list]
+
+
+def publish_file(filepath: str, remote: str, branch_name: str) -> str:  # pragma: no cover
+    """Publish a file to an orphan git branch:
+
+    .. code-block:: python
+
+        def publish_args(branch_name) -> Tuple[str, str]:
+            return (
+                "https://github.com/dyson-ai/bencher.git",
+                f"https://github.com/dyson-ai/bencher/blob/{branch_name}")
+
+
+    Args:
+        remote (Callable): A function the returns a tuple of the publishing urls. It must follow the signature def publish_args(branch_name) -> Tuple[str, str].  The first url is the git repo name, the second url needs to match the format for viewable html pages on your git provider.  The second url can use the argument branch_name to point to the file on a specified branch.
+
+    Returns:
+        str: the url of the published file
+    """
+
+    with tempfile.TemporaryDirectory() as temp_dir:
+        shutil.copy(filepath, temp_dir)
+        filename = Path(filepath).name
+        filepath_tmp = Path(temp_dir) / filename
+
+        logging.info(f"created report at: {filepath_tmp.absolute()}")
+        cd_dir = f"cd {temp_dir} &&"
+
+        # create a new git repo and add files to that.  Push the file to another arbitrary repo.  The aim of doing it this way is that no data needs to be downloaded.
+
+        # os.system(f"{cd_dir} git config init.defaultBranch {branch_name}")
+        os.system(f"{cd_dir} git init")
+        os.system(f"{cd_dir} git branch -m {branch_name}")
+        os.system(f"{cd_dir} git add {filename}")
+        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")
+
+
+def github_content(remote: str, branch_name: str, filename: str):  # pragma: no cover
+    raw = remote.replace(".git", "").replace(
+        "https://github.com/", "https://raw.githubusercontent.com/"
+    )
+    return f"{raw}/{branch_name}/{filename}?token=$(date +%s)"
+
+
+# import logging
+# # from rerun.legacy_notebook import as_html
+# import rerun as rr
+# import panel as pn
+# # from .utils import publish_file, gen_rerun_data_path
+
+
+# def rrd_to_pane(
+#     url: str, width: int = 499, height: int = 600, version: str = None
+# ):  # pragma: no cover
+#     if version is None:
+#         version = "-1.20.1"  # TODO find a better way of doing this
+#     return pn.pane.HTML(
+#         f'<iframe src="https://app.rerun.io/version/{version}/?url={url}" width={width} height={height}></iframe>'
+#     )
+
+
+# # def to_pane(path: str):
+# #     as_html()
+# #     return rrd_to_pane(path)
+
+
+# def publish_and_view_rrd(
+#     file_path: str,
+#     remote: str,
+#     branch_name,
+#     content_callback: callable,
+#     version: str = None,
+# ):  # pragma: no cover
+#     as_html()
+#     publish_file(file_path, remote=remote, branch_name="test_rrd")
+#     publish_path = content_callback(remote, branch_name, file_path)
+#     logging.info(publish_path)
+#     return rrd_to_pane(publish_path, version=version)
+
+
+# def record_rerun_session():
+#     rrd_path = gen_rerun_data_path()
+#     rr.save(rrd_path)
+#     path = rrd_path.split("cachedir")[0]
+#     return rrd_to_pane(f"http://126.0.0.1:8001/{path}")

bencher/utils_rerun.py

@@ -0,0 +1,41 @@
+import logging
+from rerun.legacy_notebook import as_html
+import rerun as rr
+import panel as pn
+from .utils import publish_file, gen_rerun_data_path
+
+
+def rrd_to_pane(
+    url: str, width: int = 500, height: int = 600, version: str = None
+):  # pragma: no cover
+    if version is None:
+        version = "0.20.1"  # TODO find a better way of doing this
+    return pn.pane.HTML(
+        f'<iframe src="https://app.rerun.io/version/{version}/?url={url}" width={width} height={height}></iframe>'
+    )
+
+
+def to_pane(path: str):
+    as_html()
+    return rrd_to_pane(path)
+
+
+def publish_and_view_rrd(
+    file_path: str,
+    remote: str,
+    branch_name,
+    content_callback: callable,
+    version: str = None,
+):  # pragma: no cover
+    as_html()
+    publish_file(file_path, remote=remote, branch_name="test_rrd")
+    publish_path = content_callback(remote, branch_name, file_path)
+    logging.info(publish_path)
+    return rrd_to_pane(publish_path, version=version)
+
+
+def record_rerun_session():
+    rrd_path = gen_rerun_data_path()
+    rr.save(rrd_path)
+    path = rrd_path.split("cachedir")[1]
+    return rrd_to_pane(f"http://127.0.0.1:8001/{path}")

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: holobench
-Version: 1.30.3
+Version: 1.31.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
@@ -9,6 +9,8 @@ Author-email: Austin Gregg-Smith <blooop@gmail.com>
 License: MIT
 Requires-Python: <3.13,>=3.10
 Requires-Dist: diskcache<=5.6.3,>=5.6
+Requires-Dist: flask
+Requires-Dist: flask-cors
 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
@@ -19,6 +21,8 @@ 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.1,>=5.15
+Requires-Dist: rerun-notebook
+Requires-Dist: rerun-sdk==0.20.1
 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.3.dist-info → holobench-1.31.0.dist-info}/RECORD

@@ -1,14 +1,16 @@
-bencher/__init__.py,sha256=VtSU6Dq3XdjphKQJ9s3yZlA3el5B9kNGqsJMM-vyYx0,1580
+bencher/__init__.py,sha256=kJtu0hg6Bf6CgBMahI8vqi3NqgywqE_YCv7NRpbE4BY,1818
 bencher/bench_cfg.py,sha256=mcsF5VU7Z-BLKE0bh9te73cEVNzr9pCnbsdIOPCJPy4,18414
 bencher/bench_plot_server.py,sha256=nvGTr981XgWELqV7yID91j6V1UIPGtKilzxHcNWaZ6Q,4196
-bencher/bench_report.py,sha256=95K4ubVGXyyGO40fsdFysgPmxrI6JbXpQKdMiahm7KI,6365
+bencher/bench_report.py,sha256=FVMPZutQKTxq5Um46xLeJahntmuP76n7PaYhVGi4bB8,6364
 bencher/bench_runner.py,sha256=5h_g-WCxocUEIDix-D81zOz0YdN-3kC7tneN9yKEE0s,6201
 bencher/bencher.py,sha256=C71paITRtrESt_O2RNFdJ17Hg2zB6FSX4RINRsJq59c,35328
 bencher/caching.py,sha256=AusaNrzGGlj5m6zcwcqnTn55Mam2mQdF--oqelO806M,1627
 bencher/class_enum.py,sha256=kYHW9qKkKcNdwaXizZL-fTptS_DUEGv4c88yCehk3gc,1492
+bencher/flask_server.py,sha256=uMhMaySUki5StC-r_TXb4KTVqAiffyqfH7UzQidFqSw,831
 bencher/job.py,sha256=swa0VwrZf41v7qNjreVDIYUU6r_dfuLipPZbg_w5x7c,6089
 bencher/optuna_conversions.py,sha256=an-LfPsQXyyvhIZnG8Wl1RQVYMvJj7WOi3YNqoUnuxQ,5356
-bencher/utils.py,sha256=9KAThtIG8jNd0nd4Wft8miNM_yHWmZUkIBfJh19pzgI,6480
+bencher/utils.py,sha256=DP2GJP28nSEihvZwiV1Rl7YJ5NTrRt2zBLs46eQ37hQ,9887
+bencher/utils_rerun.py,sha256=jkKe6ZetWrFjiATxl0-YmUrfR6zzEtzawgeULwxAZQY,1149
 bencher/video_writer.py,sha256=z49tAG_ttXc8iWcTkWPJO1QaneaVdsmYL6Hpal-pd4Q,2176
 bencher/worker_job.py,sha256=FREi0yWQACFmH86R1j-LH72tALEFkKhLDmmoGQY9Jh4,1571
 bencher/example/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -35,6 +37,8 @@ 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_rerun.py,sha256=QNN2yRLrDM6Ph1iEk9m-81mMxmS5dRNuEA0R70gz4gA,960
+bencher/example/example_rerun2.py,sha256=TV8e2UMwLFowhiXb_sQG2IS-W5jXF67VCitVjD8u1o8,660
 bencher/example/example_sample_cache.py,sha256=7gf1BJ63VAgdqNuNXkbL9-jeTeC3kXA_PY9yG3ulTz0,4200
 bencher/example/example_sample_cache_context.py,sha256=QmNM5Y8bCWEvbE7-6uRJVZhLaIEriL4lpMIV5-yTUg8,4065
 bencher/example/example_simple.py,sha256=E1-D10N-O50S33UQ9iLIlq09-x7BohbjYaR_lzLjQjc,11706
@@ -89,7 +93,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.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,,
+holobench-1.31.0.dist-info/METADATA,sha256=iB9DhPLAcCVVu88N_X2A0n-tNkOKammffgHXDbg33Io,6470
+holobench-1.31.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+holobench-1.31.0.dist-info/licenses/LICENSE,sha256=dSHXTdRY4Y7qGFMv63UksV700iff7iE-p7GGs6Sbnvo,1065
+holobench-1.31.0.dist-info/RECORD,,