PyPI - dfbench - Versions diffs - 0.2.1__tar.gz → 0.3.0__tar.gz - Mend

dfbench 0.2.1tar.gz → 0.3.0tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (184) hide show

{dfbench-0.2.1 → dfbench-0.3.0}/PKG-INFO RENAMED Viewed

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: dfbench
-Version: 0.2.1
-Summary: Differometor Benchmark - Optimization algorithms and problem definitions
+Version: 0.3.0
+Summary: dfbench: A Black-Box Optimization Framework for JAX-Differentiable Gravitational Wave Detector Discovery
 Project-URL: Homepage, https://github.com/artificial-scientist-lab/Differometor-Benchmark
 Project-URL: Repository, https://github.com/artificial-scientist-lab/Differometor-Benchmark
 Project-URL: Documentation, https://github.com/artificial-scientist-lab/Differometor-Benchmark/tree/main/docs
@@ -34,6 +34,7 @@ Requires-Dist: cmaes>=0.10.0; extra == 'all'
 Requires-Dist: evosax>=0.1.6; extra == 'all'
 Requires-Dist: evox>=1.3.0; extra == 'all'
 Requires-Dist: gpytorch>=1.14; extra == 'all'
+Requires-Dist: hebo>=0.3.2; extra == 'all'
 Requires-Dist: nevergrad>=1.0.12; extra == 'all'
 Requires-Dist: omads>=2408.0; extra == 'all'
 Requires-Dist: optax>=0.2.6; extra == 'all'
@@ -54,6 +55,7 @@ Provides-Extra: bo
 Requires-Dist: ax-platform>=1.2.4; extra == 'bo'
 Requires-Dist: botorch>=0.16.1; extra == 'bo'
 Requires-Dist: gpytorch>=1.14; extra == 'bo'
+Requires-Dist: hebo>=0.3.2; extra == 'bo'
 Requires-Dist: torch>=2.9.1; extra == 'bo'
 Provides-Extra: cuda12
 Requires-Dist: jax[cuda12]==0.9.0.1; extra == 'cuda12'
@@ -88,11 +90,14 @@ Provides-Extra: torch
 Requires-Dist: torch>=2.9.1; extra == 'torch'
 Description-Content-Type: text/markdown
-> [!IMPORTANT]
-> **BETA RELEASE:** This repository is currently in beta. The official competition will start on **July ~7**.
 # Differometor Benchmark
+[![image](https://img.shields.io/pypi/v/dfbench.svg)](https://pypi.python.org/pypi/dfbench)
+[![image](https://img.shields.io/pypi/l/dfbench)](https://pypi.python.org/pypi/dfbench)
+[![image](https://img.shields.io/pypi/pyversions/dfbench.svg)](https://pypi.python.org/pypi/dfbench)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Tests](https://img.shields.io/github/actions/workflow/status/artificial-scientist-lab/Differometor-Benchmark/tests.yaml?branch=main&label=tests&logo=github)](https://github.com/artificial-scientist-lab/Differometor-Benchmark/actions/workflows/tests.yaml)
 A benchmarking framework for optimization algorithms on gravitational-wave detector design problems, built on top of the [Differometor](https://github.com/artificial-scientist-lab/Differometor) simulator.
 > **For detailed documentation, see the [Wiki](https://github.com/artificial-scientist-lab/Differometor-Benchmark/wiki).**
@@ -135,7 +140,7 @@ obj.plot_loss()
 obj.save_run_to_file("my_run.npz")
 ```
-**A loss below 0 means your solution beats the real Voyager detector's sensitivity.** (On `VoyagerProblem` without physical constraints — you might be burning mirrors.)
+**A loss below 0 means your solution beats the real Voyager detector's sensitivity.** (On `VoyagerProblem` without physical constraints, you might be burning mirrors.)
 ### Evaluation Methods
@@ -157,8 +162,8 @@ The problems are JAX-based and differentiable up to second order. Use whichever
 ```python
 from dfbench import t2j, j2t
-params_jax = t2j(params_torch)       # Torch → JAX
-losses_torch = j2t(obj.vmap_value(params_jax))  # JAX → Torch
+params_jax = t2j(params_torch)       # Torch -> JAX
+losses_torch = j2t(obj.vmap_value(params_jax))  # JAX -> Torch
 ```
 This adds negligible overhead compared to the objective function itself.
@@ -226,8 +231,8 @@ OptimizationAlgorithm.optimize()
          │
          ▼
    ┌───────────┐      records losses, params, grads, timestamps
-   │ Objective │ ──►  enforces time / eval budgets
-   └─────┬─────┘      bounded ↔ unbounded sigmoid transform
+   │ Objective │ ──>  enforces time / eval budgets
+   └─────┬─────┘      bounded <-> unbounded sigmoid transform
          │
          ▼
   ContinuousProblem        (VoyagerProblem, VoyagerTuningProblem, ConstrainedVoyagerProblem, UIFOProblem)
@@ -250,15 +255,15 @@ src/dfbench/
 │   ├── problem.py        # ContinuousProblem ABC + ProblemSpec
 │   ├── algorithm.py       # OptimizationAlgorithm ABC + AlgorithmType enum
 │   ├── objective.py       # Objective wrapper (central piece)
-│   └── utils.py           # torch↔jax conversion, inverse sigmoid
+│   └── utils.py           # torch<->jax conversion, inverse sigmoid
 ├── algorithms/
 │   ├── derivative_free/   # OMADS, PDFO/Py-BOBYQA, NelderMead, Powell
-│   ├── global_search/     # SciPy BasinHopping, DualAnnealing
-│   ├── evolutionary/      # RandomSearch, EvoxPSO, EvoxES, Nevergrad, CMA family
+│   ├── global_search/     # RandomSearch, SciPy BasinHopping, DualAnnealing
+│   ├── evolutionary/      # EvoxPSO, EvoxES, Nevergrad, CMA family
 │   ├── gradient_based/
 │   │   ├── optax/         # 34 Optax-based optimizers (OptaxAdam, OptaxLAMB, ...)
-│   │   ├── scipy/         # 13 SciPy-based optimizers (BFGS, TNC, SLSQP, …)
-│   │   ├── custom_jax.py  # Native-JAX custom/hybrid batch (SGLD, ASAM, GD→L-BFGS, …)
+│   │   ├── scipy/         # 13 SciPy-based optimizers (BFGS, TNC, SLSQP, ...)
+│   │   ├── custom_jax.py  # Native-JAX custom/hybrid batch (SGLD, ASAM, GD->L-BFGS, ...)
 │   │   └── *.py           # Custom-loop algorithms (AdamGD, LBFGSGD, SAGD, NAAdamGD, OptaxLBFGS)
 │   ├── surrogate_based/
 │   │   ├── botorch/       # BotorchBO, BotorchTuRBO, BotorchqNEI, BotorchqKG,
@@ -369,7 +374,7 @@ The interface is designed to make this as simple as possible. You write the opti
 1. Subclass `OptimizationAlgorithm`
 2. Declare `algorithm_str` and `algorithm_type`
-3. Implement `optimize(objective, ...) → None`
+3. Implement `optimize(objective, ...) -> None`
 4. Use `Objective` for all function evaluations
 5. The `Objective` is mutated in place, thereby no return is needed
@@ -392,7 +397,7 @@ class MyAlgorithm(OptimizationAlgorithm):
     """My optimization algorithm."""
     algorithm_str = "my_algorithm"
-    algorithm_type = AlgorithmType.EVOLUTIONARY  # match one of the algorithms/ subfolders
+    algorithm_type = AlgorithmType.GLOBAL_SEARCH  # match one of the algorithms/ subfolders
     def __init__(self, batch_size: int = 50) -> None:
         """Algorithm-level meta-parameters that don't change between runs."""
@@ -513,7 +518,6 @@ See [Objective API Reference](https://github.com/artificial-scientist-lab/Differ
 | `BFGS`, `LBFGSB`, `NonlinearCG`, `NewtonCG` | Gradient | Classical SciPy gradient and quasi-Newton methods |
 | `TrustNCG`, `TrustKrylov`, `TrustConstr`, `Dogleg`, `SR1` | Gradient | Trust-region and constrained SciPy methods |
 | `TNC`, `SLSQP`, `COBYQA`, `COBYLA` | Gradient | Bounded physical-space SciPy solvers |
-| `RandomSearch` | Evolutionary | Unbiased baseline, no hyperparameters |
 | `EvoxPSO` | Evolutionary | Swarm intelligence, many variants (CLPSO, CSO, ...) |
 | `EvoxES` | Evolutionary | CMA-ES, OpenES, XNES, and more (EvoX backend) |
 | `PyCMACMAES` | Evolutionary | Vanilla CMA-ES (pycma backend) |
@@ -529,6 +533,7 @@ See [Objective API Reference](https://github.com/artificial-scientist-lab/Differ
 | `OmadsMADS`, `OmadsOrthoMADS` | Derivative-Free | MADS / OrthoMADS direct search (OMADS) |
 | `PDFOUOBYQA`, `PDFONEWUOA`, `PDFOLINCOA`, `PyBOBYQA` | Derivative-Free | Powell-style trust-region DFO (PDFO + Py-BOBYQA) |
 | `NelderMead`, `Powell` | Derivative-Free | SciPy classical simplex / direction-set search |
+| `RandomSearch` | Global Search | Unbiased, derivative-free global search baseline, no hyperparameters |
 | `BasinHopping`, `DualAnnealing` | Global Search | SciPy stochastic global optimization |
 | `NevergradOnePlusOne`, `NevergradTBPSA`, `NevergradNGOpt` | Evolutionary | Nevergrad rugged-landscape baselines |
 | `BotorchBO` | Surrogate | Sample-efficient Bayesian Optimization |
@@ -557,7 +562,7 @@ Reference implementations worth reading:
 - `gradient_based/adam_gd.py`: gradient-based pattern (custom loop)
 - `gradient_based/optax/adam.py`: Optax wrapper pattern (minimal subclass)
 - `gradient_based/scipy/_common.py`: shared SciPy wrapper, caching, and budget handling
-- `evolutionary/random_search.py`: simplest batched example
+- `global_search/random_search.py`: simplest batched example
 - `evolutionary/evox_es.py`: wrapping an external library (EvoX/PyTorch)
 - `evolutionary/pycma_cmaes.py`: wrapping pycma (ask/tell, restart strategies)
 - `evolutionary/jax_es.py`: native JAX ES without external library

{dfbench-0.2.1 → dfbench-0.3.0}/README.md RENAMED Viewed

@@ -1,8 +1,11 @@
-> [!IMPORTANT]
-> **BETA RELEASE:** This repository is currently in beta. The official competition will start on **July ~7**.
 # Differometor Benchmark
+[![image](https://img.shields.io/pypi/v/dfbench.svg)](https://pypi.python.org/pypi/dfbench)
+[![image](https://img.shields.io/pypi/l/dfbench)](https://pypi.python.org/pypi/dfbench)
+[![image](https://img.shields.io/pypi/pyversions/dfbench.svg)](https://pypi.python.org/pypi/dfbench)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Tests](https://img.shields.io/github/actions/workflow/status/artificial-scientist-lab/Differometor-Benchmark/tests.yaml?branch=main&label=tests&logo=github)](https://github.com/artificial-scientist-lab/Differometor-Benchmark/actions/workflows/tests.yaml)
 A benchmarking framework for optimization algorithms on gravitational-wave detector design problems, built on top of the [Differometor](https://github.com/artificial-scientist-lab/Differometor) simulator.
 > **For detailed documentation, see the [Wiki](https://github.com/artificial-scientist-lab/Differometor-Benchmark/wiki).**
@@ -45,7 +48,7 @@ obj.plot_loss()
 obj.save_run_to_file("my_run.npz")
 ```
-**A loss below 0 means your solution beats the real Voyager detector's sensitivity.** (On `VoyagerProblem` without physical constraints — you might be burning mirrors.)
+**A loss below 0 means your solution beats the real Voyager detector's sensitivity.** (On `VoyagerProblem` without physical constraints, you might be burning mirrors.)
 ### Evaluation Methods
@@ -67,8 +70,8 @@ The problems are JAX-based and differentiable up to second order. Use whichever
 ```python
 from dfbench import t2j, j2t
-params_jax = t2j(params_torch)       # Torch → JAX
-losses_torch = j2t(obj.vmap_value(params_jax))  # JAX → Torch
+params_jax = t2j(params_torch)       # Torch -> JAX
+losses_torch = j2t(obj.vmap_value(params_jax))  # JAX -> Torch
 ```
 This adds negligible overhead compared to the objective function itself.
@@ -136,8 +139,8 @@ OptimizationAlgorithm.optimize()
          │
          ▼
    ┌───────────┐      records losses, params, grads, timestamps
-   │ Objective │ ──►  enforces time / eval budgets
-   └─────┬─────┘      bounded ↔ unbounded sigmoid transform
+   │ Objective │ ──>  enforces time / eval budgets
+   └─────┬─────┘      bounded <-> unbounded sigmoid transform
          │
          ▼
   ContinuousProblem        (VoyagerProblem, VoyagerTuningProblem, ConstrainedVoyagerProblem, UIFOProblem)
@@ -160,15 +163,15 @@ src/dfbench/
 │   ├── problem.py        # ContinuousProblem ABC + ProblemSpec
 │   ├── algorithm.py       # OptimizationAlgorithm ABC + AlgorithmType enum
 │   ├── objective.py       # Objective wrapper (central piece)
-│   └── utils.py           # torch↔jax conversion, inverse sigmoid
+│   └── utils.py           # torch<->jax conversion, inverse sigmoid
 ├── algorithms/
 │   ├── derivative_free/   # OMADS, PDFO/Py-BOBYQA, NelderMead, Powell
-│   ├── global_search/     # SciPy BasinHopping, DualAnnealing
-│   ├── evolutionary/      # RandomSearch, EvoxPSO, EvoxES, Nevergrad, CMA family
+│   ├── global_search/     # RandomSearch, SciPy BasinHopping, DualAnnealing
+│   ├── evolutionary/      # EvoxPSO, EvoxES, Nevergrad, CMA family
 │   ├── gradient_based/
 │   │   ├── optax/         # 34 Optax-based optimizers (OptaxAdam, OptaxLAMB, ...)
-│   │   ├── scipy/         # 13 SciPy-based optimizers (BFGS, TNC, SLSQP, …)
-│   │   ├── custom_jax.py  # Native-JAX custom/hybrid batch (SGLD, ASAM, GD→L-BFGS, …)
+│   │   ├── scipy/         # 13 SciPy-based optimizers (BFGS, TNC, SLSQP, ...)
+│   │   ├── custom_jax.py  # Native-JAX custom/hybrid batch (SGLD, ASAM, GD->L-BFGS, ...)
 │   │   └── *.py           # Custom-loop algorithms (AdamGD, LBFGSGD, SAGD, NAAdamGD, OptaxLBFGS)
 │   ├── surrogate_based/
 │   │   ├── botorch/       # BotorchBO, BotorchTuRBO, BotorchqNEI, BotorchqKG,
@@ -279,7 +282,7 @@ The interface is designed to make this as simple as possible. You write the opti
 1. Subclass `OptimizationAlgorithm`
 2. Declare `algorithm_str` and `algorithm_type`
-3. Implement `optimize(objective, ...) → None`
+3. Implement `optimize(objective, ...) -> None`
 4. Use `Objective` for all function evaluations
 5. The `Objective` is mutated in place, thereby no return is needed
@@ -302,7 +305,7 @@ class MyAlgorithm(OptimizationAlgorithm):
     """My optimization algorithm."""
     algorithm_str = "my_algorithm"
-    algorithm_type = AlgorithmType.EVOLUTIONARY  # match one of the algorithms/ subfolders
+    algorithm_type = AlgorithmType.GLOBAL_SEARCH  # match one of the algorithms/ subfolders
     def __init__(self, batch_size: int = 50) -> None:
         """Algorithm-level meta-parameters that don't change between runs."""
@@ -423,7 +426,6 @@ See [Objective API Reference](https://github.com/artificial-scientist-lab/Differ
 | `BFGS`, `LBFGSB`, `NonlinearCG`, `NewtonCG` | Gradient | Classical SciPy gradient and quasi-Newton methods |
 | `TrustNCG`, `TrustKrylov`, `TrustConstr`, `Dogleg`, `SR1` | Gradient | Trust-region and constrained SciPy methods |
 | `TNC`, `SLSQP`, `COBYQA`, `COBYLA` | Gradient | Bounded physical-space SciPy solvers |
-| `RandomSearch` | Evolutionary | Unbiased baseline, no hyperparameters |
 | `EvoxPSO` | Evolutionary | Swarm intelligence, many variants (CLPSO, CSO, ...) |
 | `EvoxES` | Evolutionary | CMA-ES, OpenES, XNES, and more (EvoX backend) |
 | `PyCMACMAES` | Evolutionary | Vanilla CMA-ES (pycma backend) |
@@ -439,6 +441,7 @@ See [Objective API Reference](https://github.com/artificial-scientist-lab/Differ
 | `OmadsMADS`, `OmadsOrthoMADS` | Derivative-Free | MADS / OrthoMADS direct search (OMADS) |
 | `PDFOUOBYQA`, `PDFONEWUOA`, `PDFOLINCOA`, `PyBOBYQA` | Derivative-Free | Powell-style trust-region DFO (PDFO + Py-BOBYQA) |
 | `NelderMead`, `Powell` | Derivative-Free | SciPy classical simplex / direction-set search |
+| `RandomSearch` | Global Search | Unbiased, derivative-free global search baseline, no hyperparameters |
 | `BasinHopping`, `DualAnnealing` | Global Search | SciPy stochastic global optimization |
 | `NevergradOnePlusOne`, `NevergradTBPSA`, `NevergradNGOpt` | Evolutionary | Nevergrad rugged-landscape baselines |
 | `BotorchBO` | Surrogate | Sample-efficient Bayesian Optimization |
@@ -467,7 +470,7 @@ Reference implementations worth reading:
 - `gradient_based/adam_gd.py`: gradient-based pattern (custom loop)
 - `gradient_based/optax/adam.py`: Optax wrapper pattern (minimal subclass)
 - `gradient_based/scipy/_common.py`: shared SciPy wrapper, caching, and budget handling
-- `evolutionary/random_search.py`: simplest batched example
+- `global_search/random_search.py`: simplest batched example
 - `evolutionary/evox_es.py`: wrapping an external library (EvoX/PyTorch)
 - `evolutionary/pycma_cmaes.py`: wrapping pycma (ask/tell, restart strategies)
 - `evolutionary/jax_es.py`: native JAX ES without external library

{dfbench-0.2.1 → dfbench-0.3.0}/docs/Algorithm-Status.md RENAMED Viewed

@@ -18,7 +18,7 @@
 ---
-## `EvoxES` — Multi-Algorithm Wrapper (on `main`)
+## `EvoxES`: Multi-Algorithm Wrapper (on `main`)
 `EvoxES` is a single class that wraps **12 distinct EvoX evolution strategies** selectable via its `variant` parameter.
 Each variant is a separate algorithm from the EvoX library.
@@ -38,7 +38,7 @@ Each variant is a separate algorithm from the EvoX library.
 | `GuidedES` | Guided Evolution Strategy | ES |
 | `ESMC` | Evolution Strategy with Monte Carlo | ES |
-## `EvoxPSO` — Multi-Algorithm Wrapper (on `main`)
+## `EvoxPSO`: Multi-Algorithm Wrapper (on `main`)
 `EvoxPSO` is a single class that wraps **7 distinct EvoX PSO variants** selectable via its `variant` parameter.
@@ -52,10 +52,10 @@ Each variant is a separate algorithm from the EvoX library.
 | `SLPSOGS` | Social Learning PSO with Gaussian Sampling |
 | `SLPSOUS` | Social Learning PSO with Uniform Sampling |
-## `EvosaxES` — Multi-Algorithm Wrapper (on `algorithm/evo-algorithms`)
+## `EvosaxES`: Multi-Algorithm Wrapper (on `algorithm/evo-algorithms`)
 `EvosaxES` is a separate evosax-backed wrapper (pure JAX, JIT-friendly) that wraps **14 variants**.
-Coexists with `EvoxES` — different backend, class names use `evosax_` prefix.
+Coexists with `EvoxES` but uses a different backend; class names use `evosax_` prefix.
 | Variant | Full Name | Type |
 |---------|-----------|------|
@@ -129,7 +129,7 @@ Coexists with `EvoxES` — different backend, class names use `evosax_` prefix.
 |-----------|-----------|--------|--------|-------|
 | SGLD | `SGLDJAX` | Branch | `algorithm/jax-algorithms` | Stochastic Gradient Langevin Dynamics |
 | ASAM | `ASAMJAX` | Branch | `algorithm/jax-algorithms` | Adaptive Sharpness-Aware Minimization |
-| Adam→L-BFGS Switch | `AdamToLBFGSJAX` | Branch | `algorithm/jax-algorithms` | Hybrid warm-start strategy |
+| Adam->L-BFGS Switch | `AdamToLBFGSJAX` | Branch | `algorithm/jax-algorithms` | Hybrid warm-start strategy |
 | Entropy-SGD | `EntropySGDJAX` | Branch | `algorithm/jax-algorithms` | |
 | SGHMC | `SGHMCJAX` | Branch | `algorithm/jax-algorithms` | Stochastic Gradient Hamiltonian MC |
 | ARC | `ARCJAX` | Branch | `algorithm/jax-algorithms` | Adaptive Regularization with Cubics |
@@ -146,7 +146,6 @@ Coexists with `EvoxES` — different backend, class names use `evosax_` prefix.
 |-----------|-----------|--------|--------|-------|
 | EvoX ES (12 variants) | `EvoxES` | **Finished** | `main` | See variant table above |
 | EvoX PSO (7 variants) | `EvoxPSO` | **Finished** | `main` | See variant table above |
-| Random Search | `RandomSearch` | **Finished** | `main` | Baseline |
 | Evosax ES (14 variants) | `EvosaxES` | Branch | `algorithm/evo-algorithms` | See variant table above |
 | DE | `DE` | Branch | `algorithm/evo-algorithms` | Differential Evolution (custom impl) |
 | JADE | `JADE` | Branch | `algorithm/evo-algorithms` | Adaptive DE |
@@ -201,6 +200,7 @@ Coexists with `EvoxES` — different backend, class names use `evosax_` prefix.
 |-----------|-----------|--------|--------|-------|
 | Basin Hopping | `BasinHopping` | Branch | `algorithm/scipy-nongrad-algorithms` | SciPy stochastic global optimizer |
 | Dual Annealing | `DualAnnealing` | Branch | `algorithm/scipy-nongrad-algorithms` | SciPy stochastic global optimizer |
+| Random Search | `RandomSearch` | **Finished** | `main` | Baseline |
 ### Surrogate-Based / Bayesian Optimization
@@ -214,7 +214,7 @@ Coexists with `EvoxES` — different backend, class names use `evosax_` prefix.
 | GEBO | `GEBO` | Branch | `algorithm/bo-algorithms` | Gradient-Enhanced BO |
 | LineBO | `LineBO` | Branch | `algorithm/bo-algorithms` | Line-search BO |
 | qKG | `BotorchqKG` | Branch | `algorithm/bo-algorithms` | Knowledge Gradient |
-| qNEI | `BotorchqNEI` | Branch | `algorithm/bo-algorithms` | Noisy Expected Improvement |
+| qNEI | `BotorchQNEI` | Branch | `algorithm/bo-algorithms` | Noisy Expected Improvement |
 | REMBO | `REMBO` | Branch | `algorithm/bo-algorithms` | Random Embedding BO |
 | HEBO | `HEBO` | Branch | `algorithm/bo-algorithms` | Heteroscedastic BO |
 | SMAC | `SMAC` | Branch | `algorithm/bo-algorithms` | Sequential Model-based Config |

dfbench 0.2.1__tar.gz → 0.3.0__tar.gz

dfbench 0.2.1tar.gz → 0.3.0tar.gz