spikeforge 0.3.0__tar.gz

spikeforge-0.3.0/LICENSE

@@ -0,0 +1,30 @@
+BSD 3-Clause License
+
+Copyright (c) 2018 Capsize LLC
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

spikeforge-0.3.0/PKG-INFO

@@ -0,0 +1,149 @@
+Metadata-Version: 2.4
+Name: spikeforge
+Version: 0.3.0
+Summary: Spiking neural network trainer/experiments for MNIST built with snnTorch and PyTorch.
+Author-email: Capsize LLC <contact@capsizegames.com>
+Maintainer-email: Capsize LLC <contact@capsizegames.com>
+License-Expression: BSD-3-Clause
+Project-URL: Homepage, https://github.com/capsize-games/spikeforge
+Project-URL: Repository, https://github.com/capsize-games/spikeforge
+Keywords: spiking neural networks,snn,snntorch,pytorch,mnist
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: torch>=2.5
+Requires-Dist: torchvision>=0.20
+Requires-Dist: snntorch>=1.0
+Requires-Dist: matplotlib>=3.8
+Requires-Dist: Pillow>=10.0
+Requires-Dist: numpy>=1.26
+Requires-Dist: psutil>=5.9
+Provides-Extra: all
+Requires-Dist: spikeforge-targets~=0.1.0; extra == "all"
+Requires-Dist: spikeforge-hub~=0.1.0; extra == "all"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: ruff>=0.0.280; extra == "dev"
+Requires-Dist: jsonschema>=4; extra == "dev"
+Requires-Dist: tomli; python_version < "3.11" and extra == "dev"
+Provides-Extra: nir
+Requires-Dist: nir>=1.0; extra == "nir"
+Requires-Dist: nirtorch>=1.0; extra == "nir"
+Provides-Extra: events
+Requires-Dist: tonic>=1.4; extra == "events"
+Provides-Extra: onnx
+Requires-Dist: onnx>=1.14; extra == "onnx"
+Requires-Dist: onnxruntime>=1.16; extra == "onnx"
+Provides-Extra: tracking
+Requires-Dist: tensorboard>=2.0; extra == "tracking"
+Provides-Extra: tracking-wandb
+Requires-Dist: wandb; extra == "tracking-wandb"
+Provides-Extra: docs
+Requires-Dist: mkdocs-material>=9.0; extra == "docs"
+Dynamic: license-file
+
+# spikeforge
+
+[![CI](https://github.com/capsize-games/spikeforge/actions/workflows/ci.yml/badge.svg)](https://github.com/capsize-games/spikeforge/actions/workflows/ci.yml)
+[![Status: pre-1.0](https://img.shields.io/badge/status-pre--1.0-orange.svg)](OPEN_SOURCE_CHECKLIST.md)
+[![License: BSD-3-Clause](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](LICENSE)
+[![Python 3.10–3.13](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-3776AB.svg)](https://www.python.org/downloads/)
+[![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)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/capsize-games/spikeforge/blob/main/CONTRIBUTING.md)
+[![Docs](https://img.shields.io/badge/docs-long--form%20reference-blue.svg)](documentation/README.md)
+
+A spiking-neural-network (SNN) toolkit built on
+[snnTorch](https://snntorch.readthedocs.io/) and PyTorch. Loads MNIST-style
+and neuromorphic event datasets, encodes them into rate, latency, delta, and
+random spikes, and trains, validates, exports, and deploys LIF networks —
+with a live browser dashboard served over WebSockets.
+
+> **Pre-1.0 and unpublished.** `install.sh` is the supported path today;
+> PyPI ships once the distributions are published. Before trusting any
+> number this produces, read
+> [Implications and boundaries](documentation/implications-and-boundaries.md).
+
+## Quickstart
+
+```bash
+git clone https://github.com/capsize-games/spikeforge.git
+cd spikeforge
+docker compose up --build
+```
+
+Open <http://localhost:8877> — the dashboard connects to the WebSocket on
+the same host and port. No separate backend or proxy to run.
+
+Prefer a local install, a headless example, or the CLI tools instead? See
+[Usage](documentation/usage.md) and [Quickstart](documentation/quickstart.md)
+for every path (`./install.sh`, local dev with Vite, `examples/`, and the
+eight `spikeforge-*` console scripts).
+
+## Features
+
+- **Encoding** — rate, latency, delta, and random spike coders.
+- **Training** — fully-connected and convolutional LIF networks with
+  surrogate-gradient cross-entropy, checkpointing, and opt-in AMP / gradient
+  checkpointing / truncated BPTT / multi-GPU.
+- **Topologies** — `fc_legacy`, `fc_small`, `conv_net`, `recurrent_net`, plus
+  the sequence presets `sequence_mlp` and `sequence_attn`.
+- **Datasets** — MNIST, Fashion-MNIST, KMNIST, QMNIST, USPS, EMNIST,
+  CIFAR-10, and (via the `events` extra) N-MNIST, DVS128 Gesture,
+  CIFAR10-DVS, and Spiking Speech Commands.
+- **Interpreter spine** — NIR export, an independent NIR interpreter, and
+  numerical drift validation.
+- **Introspection** — educational-mode `U[t]`/`I[t]`/`S[t]` traces,
+  trajectory metrics, and surrogate-derivative curves.
+- **Deployment** — a capability matrix, weight quantization, energy
+  accounting, and executable `reference`, `norse`, and `lava_loihi2`
+  backends.
+- **Model hub** — a curated, offline-first catalog plus optional live
+  Hugging Face search.
+- **Dashboard** — a React + TypeScript UI with training, introspection,
+  analysis, targets, energy, and hub panels, and seven guided walkthroughs.
+
+## Packages
+
+This repository is a single workspace that publishes four distributions:
+
+| Distribution | Import root | Purpose |
+|---|---|---|
+| `spikeforge` | `spikeforge` | Core package: encoders, topologies, training, simulator, NIR bridge, tracking |
+| `spikeforge-targets` | `spikeforge_targets` | Deployment targets, quantization, energy accounting, sparse event runtime |
+| `spikeforge-hub` | `spikeforge_hub` | Curated model hub and optional Hugging Face access |
+| `spikeforge-server` | `server` | FastAPI + WebSocket server and dashboard hosting |
+
+## Documentation
+
+This README stays short on purpose.
+[`documentation/`](documentation/README.md) is the full reference — install
+paths, the CLI tools, architecture, module layout, and the dev workflow —
+written for contributors and coding agents alike. Also see
+[COOKBOOK.md](COOKBOOK.md) for copy-pasteable recipes,
+[examples/](examples/) for runnable end-to-end scripts, and
+[plans/](plans/) for design documents and the roadmap.
+
+See [CONTRIBUTING.md](https://github.com/capsize-games/spikeforge/blob/main/CONTRIBUTING.md)
+and [rules.md](rules.md) before opening a pull request.
+
+## Citing
+
+If spikeforge is useful in your research, please cite it — see
+[CITATION.cff](CITATION.cff) (GitHub renders a "Cite this repository"
+button from it automatically).
+
+## License
+
+Released under the **BSD 3-Clause License** — see [LICENSE](LICENSE) and
+[AUTHORS](AUTHORS).

spikeforge-0.3.0/README.md

@@ -0,0 +1,94 @@
+# spikeforge
+
+[![CI](https://github.com/capsize-games/spikeforge/actions/workflows/ci.yml/badge.svg)](https://github.com/capsize-games/spikeforge/actions/workflows/ci.yml)
+[![Status: pre-1.0](https://img.shields.io/badge/status-pre--1.0-orange.svg)](OPEN_SOURCE_CHECKLIST.md)
+[![License: BSD-3-Clause](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](LICENSE)
+[![Python 3.10–3.13](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-3776AB.svg)](https://www.python.org/downloads/)
+[![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)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/capsize-games/spikeforge/blob/main/CONTRIBUTING.md)
+[![Docs](https://img.shields.io/badge/docs-long--form%20reference-blue.svg)](documentation/README.md)
+
+A spiking-neural-network (SNN) toolkit built on
+[snnTorch](https://snntorch.readthedocs.io/) and PyTorch. Loads MNIST-style
+and neuromorphic event datasets, encodes them into rate, latency, delta, and
+random spikes, and trains, validates, exports, and deploys LIF networks —
+with a live browser dashboard served over WebSockets.
+
+> **Pre-1.0 and unpublished.** `install.sh` is the supported path today;
+> PyPI ships once the distributions are published. Before trusting any
+> number this produces, read
+> [Implications and boundaries](documentation/implications-and-boundaries.md).
+
+## Quickstart
+
+```bash
+git clone https://github.com/capsize-games/spikeforge.git
+cd spikeforge
+docker compose up --build
+```
+
+Open <http://localhost:8877> — the dashboard connects to the WebSocket on
+the same host and port. No separate backend or proxy to run.
+
+Prefer a local install, a headless example, or the CLI tools instead? See
+[Usage](documentation/usage.md) and [Quickstart](documentation/quickstart.md)
+for every path (`./install.sh`, local dev with Vite, `examples/`, and the
+eight `spikeforge-*` console scripts).
+
+## Features
+
+- **Encoding** — rate, latency, delta, and random spike coders.
+- **Training** — fully-connected and convolutional LIF networks with
+  surrogate-gradient cross-entropy, checkpointing, and opt-in AMP / gradient
+  checkpointing / truncated BPTT / multi-GPU.
+- **Topologies** — `fc_legacy`, `fc_small`, `conv_net`, `recurrent_net`, plus
+  the sequence presets `sequence_mlp` and `sequence_attn`.
+- **Datasets** — MNIST, Fashion-MNIST, KMNIST, QMNIST, USPS, EMNIST,
+  CIFAR-10, and (via the `events` extra) N-MNIST, DVS128 Gesture,
+  CIFAR10-DVS, and Spiking Speech Commands.
+- **Interpreter spine** — NIR export, an independent NIR interpreter, and
+  numerical drift validation.
+- **Introspection** — educational-mode `U[t]`/`I[t]`/`S[t]` traces,
+  trajectory metrics, and surrogate-derivative curves.
+- **Deployment** — a capability matrix, weight quantization, energy
+  accounting, and executable `reference`, `norse`, and `lava_loihi2`
+  backends.
+- **Model hub** — a curated, offline-first catalog plus optional live
+  Hugging Face search.
+- **Dashboard** — a React + TypeScript UI with training, introspection,
+  analysis, targets, energy, and hub panels, and seven guided walkthroughs.
+
+## Packages
+
+This repository is a single workspace that publishes four distributions:
+
+| Distribution | Import root | Purpose |
+|---|---|---|
+| `spikeforge` | `spikeforge` | Core package: encoders, topologies, training, simulator, NIR bridge, tracking |
+| `spikeforge-targets` | `spikeforge_targets` | Deployment targets, quantization, energy accounting, sparse event runtime |
+| `spikeforge-hub` | `spikeforge_hub` | Curated model hub and optional Hugging Face access |
+| `spikeforge-server` | `server` | FastAPI + WebSocket server and dashboard hosting |
+
+## Documentation
+
+This README stays short on purpose.
+[`documentation/`](documentation/README.md) is the full reference — install
+paths, the CLI tools, architecture, module layout, and the dev workflow —
+written for contributors and coding agents alike. Also see
+[COOKBOOK.md](COOKBOOK.md) for copy-pasteable recipes,
+[examples/](examples/) for runnable end-to-end scripts, and
+[plans/](plans/) for design documents and the roadmap.
+
+See [CONTRIBUTING.md](https://github.com/capsize-games/spikeforge/blob/main/CONTRIBUTING.md)
+and [rules.md](rules.md) before opening a pull request.
+
+## Citing
+
+If spikeforge is useful in your research, please cite it — see
+[CITATION.cff](CITATION.cff) (GitHub renders a "Cite this repository"
+button from it automatically).
+
+## License
+
+Released under the **BSD 3-Clause License** — see [LICENSE](LICENSE) and
+[AUTHORS](AUTHORS).

spikeforge-0.3.0/main.py

@@ -0,0 +1,26 @@
+"""Entry point: train a rate-coded MNIST subset and export all visuals."""
+
+from spikeforge.exporters.presentation_exporter import (
+    PresentationGifExporter,
+)
+from spikeforge.exporters.raster_exporter import RasterExporter
+from spikeforge.exporters.reconstruction_exporter import (
+    ReconstructionExporter,
+)
+from spikeforge.exporters.spike_gif_exporter import SpikeGifExporter
+from spikeforge.exporters.video_exporter import VideoExporter
+from spikeforge.training.logger import SNNTrainerLogger
+
+
+def main() -> None:
+    """Build the trainer and write every output artifact."""
+    trainer = SNNTrainerLogger(animation_interval=100)
+    VideoExporter(trainer).export()
+    SpikeGifExporter(trainer).export()
+    ReconstructionExporter(trainer).export()
+    RasterExporter(trainer).export()
+    PresentationGifExporter(trainer).export()
+
+
+if __name__ == "__main__":
+    main()

spikeforge-0.3.0/main_encodings.py

@@ -0,0 +1,43 @@
+"""Run the additional tutorial-1 encoding demos (latency/delta/random).
+
+Produces latency curve + rasters + animation, delta plots, and random
+spike visuals under build/.
+"""
+
+from spikeforge.encoding.delta_trainer import DeltaTrainer
+from spikeforge.encoding.latency_trainer import LatencyTrainer
+from spikeforge.encoding.random_spikegen import RandomSpikeGenerator
+from spikeforge.exporters.delta_exporter import DeltaPlotExporter
+from spikeforge.exporters.latency_curve_exporter import (
+    LatencyCurveExporter,
+)
+from spikeforge.exporters.latency_raster_exporter import (
+    LatencyRasterExporter,
+)
+from spikeforge.exporters.latency_video_exporter import (
+    LatencyVideoExporter,
+)
+from spikeforge.exporters.random_spike_raster_exporter import (
+    RandomSpikeRasterExporter,
+)
+from spikeforge.exporters.random_spike_video_exporter import (
+    RandomSpikeVideoExporter,
+)
+
+
+def main() -> None:
+    """Train the latency/delta/random encoders and export their visuals."""
+    latency_trainer = LatencyTrainer(animation_interval=100)
+    LatencyCurveExporter(latency_trainer).export()
+    LatencyRasterExporter(latency_trainer).export()
+    LatencyVideoExporter(latency_trainer).export(key="clip")
+
+    DeltaPlotExporter(DeltaTrainer()).export()
+
+    random_spikegen = RandomSpikeGenerator(num_steps=100)
+    RandomSpikeRasterExporter(random_spikegen).export()
+    RandomSpikeVideoExporter(random_spikegen).export()
+
+
+if __name__ == "__main__":
+    main()

spikeforge-0.3.0/pyproject.toml

@@ -0,0 +1,130 @@
+# PEP 621 packaging authority for the core distribution (ARCH-0001 Phase 1b).
+#
+# The core distribution owns the ``spikeforge`` import root plus the two
+# top-level ``main`` modules. It deliberately excludes ``server/`` so a
+# headless ``pip install spikeforge`` cannot ship the FastAPI server.
+#
+# Phase 1 moves no source: the import root stays at ``spikeforge/`` and is
+# exposed to the build via the ``spikeforge`` symlink next to this file
+# (see the ``packages.find`` table below for why). The server distribution is
+# defined in ``packages/spikeforge-server/pyproject.toml``.
+
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "spikeforge"
+version = "0.3.0"
+description = "Spiking neural network trainer/experiments for MNIST built with snnTorch and PyTorch."
+# ``README.md`` and ``LICENSE`` are committed symlinks to the repository-root
+# files: the distribution metadata points at the root documents while
+# setuptools' sandbox only reads files inside the project directory.
+readme = "README.md"
+requires-python = ">=3.10"
+license = "BSD-3-Clause"
+license-files = ["LICENSE"]
+authors = [
+    { name = "Capsize LLC", email = "contact@capsizegames.com" },
+]
+maintainers = [
+    { name = "Capsize LLC", email = "contact@capsizegames.com" },
+]
+keywords = [
+    "spiking neural networks",
+    "snn",
+    "snntorch",
+    "pytorch",
+    "mnist",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+]
+dependencies = [
+    "torch>=2.5",
+    "torchvision>=0.20",
+    "snntorch>=1.0",
+    "matplotlib>=3.8",
+    "Pillow>=10.0",
+    "numpy>=1.26",
+    "psutil>=5.9",
+]
+
+[project.optional-dependencies]
+all = [
+    "spikeforge-targets~=0.1.0",
+    "spikeforge-hub~=0.1.0",
+]
+dev = [
+    "pytest>=7.0",
+    "pytest-cov>=4.0",
+    "ruff>=0.0.280",
+    "jsonschema>=4",
+    # stdlib ``tomllib`` only lands in 3.11; the packaging-profile tests read
+    # the PEP 621 files, so 3.10 development and CI pull in the backport.
+    'tomli; python_version < "3.11"',
+]
+nir = [
+    "nir>=1.0",
+    "nirtorch>=1.0",
+]
+events = [
+    "tonic>=1.4",
+]
+onnx = [
+    "onnx>=1.14",
+    "onnxruntime>=1.16",
+]
+tracking = [
+    "tensorboard>=2.0",
+]
+tracking-wandb = [
+    "wandb",
+]
+docs = [
+    "mkdocs-material>=9.0",
+]
+
+[project.scripts]
+spikeforge = "main:main"
+spikeforge-encodings = "main_encodings:main"
+spikeforge-verify = "spikeforge.cli.verify:main"
+spikeforge-records = "spikeforge.cli.records_cli:main"
+spikeforge-benchmark = "spikeforge.benchmark.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/capsize-games/spikeforge"
+Repository = "https://github.com/capsize-games/spikeforge"
+
+[tool.setuptools]
+py-modules = ["main", "main_encodings"]
+zip-safe = false
+
+[tool.setuptools.packages.find]
+# The design document specifies `where = ["../.."]`. Setuptools >= 68
+# sandboxes a build to the project directory (which is also why README.md and
+# LICENSE are committed symlinks here), and its default `python -m build`
+# builds the wheel from the *extracted sdist*, which cannot carry sources that
+# live outside the project root. The import root is therefore exposed next to
+# this file as a symlink to `../../spikeforge`, keeping the one source of
+# truth at its current repository path while making both `pip install` and
+# `python -m build` produce a complete wheel. The include pairs the exact
+# top-level `spikeforge` package with its `spikeforge.*` subpackages: a bare
+# `spikeforge*` glob would also match the satellites (`spikeforge_targets`,
+# `spikeforge_hub`), so it is deliberately not used, and `server/` can never
+# leak into this distribution.
+where = ["."]
+include = ["spikeforge", "spikeforge.*"]
+exclude = ["server*", "tests*", "spikeforge_targets*", "spikeforge_hub*"]
+
+[tool.setuptools.package-data]
+spikeforge = ["py.typed"]

spikeforge-0.3.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

spikeforge-0.3.0/spikeforge/__init__.py

@@ -0,0 +1,19 @@
+"""Public exports for the spikeforge package."""
+
+from spikeforge.encoding.delta_trainer import DeltaTrainer
+from spikeforge.encoding.latency_trainer import (
+    LatencyTrainer,
+    convert_to_time,
+)
+from spikeforge.encoding.random_spikegen import RandomSpikeGenerator
+from spikeforge.training.logger import SNNTrainerLogger
+from spikeforge.training.trainer import SSNTrainer
+
+__all__ = [
+    "SSNTrainer",
+    "SNNTrainerLogger",
+    "LatencyTrainer",
+    "DeltaTrainer",
+    "RandomSpikeGenerator",
+    "convert_to_time",
+]

spikeforge-0.3.0/spikeforge/benchmark/__init__.py

@@ -0,0 +1,44 @@
+"""Performance and memory benchmarks for the interpreter's execution modes.
+
+This package measures wall time and memory of a topology run under
+production and educational modes (and, opt-in, a compiled production path).
+It is deliberately separate from ``introspection``, which describes a
+recorded trajectory rather than the cost of producing one.
+
+Use :func:`run_benchmark` from Python, or ``python -m
+spikeforge.benchmark`` from a shell; both return the same
+JSON-serialisable report.
+"""
+
+from spikeforge.benchmark.compare import (
+    DEFAULT_THRESHOLD,
+    compare_runs,
+    exit_code,
+)
+from spikeforge.benchmark.config import BenchmarkConfig, default_config
+from spikeforge.benchmark.harness import run_benchmark
+from spikeforge.benchmark.serving import (
+    ServingBenchmarkConfig,
+    percentile,
+    run_serving_benchmark,
+    run_serving_suite,
+)
+from spikeforge.benchmark.store import BenchmarkStore, default_directory
+from spikeforge.benchmark.suite import run_suite, with_metadata
+
+__all__ = [
+    "BenchmarkConfig",
+    "BenchmarkStore",
+    "DEFAULT_THRESHOLD",
+    "ServingBenchmarkConfig",
+    "compare_runs",
+    "default_config",
+    "default_directory",
+    "exit_code",
+    "percentile",
+    "run_benchmark",
+    "run_serving_benchmark",
+    "run_serving_suite",
+    "run_suite",
+    "with_metadata",
+]

spikeforge-0.3.0/spikeforge/benchmark/__main__.py

@@ -0,0 +1,14 @@
+"""Module entry point: ``python -m spikeforge.benchmark``.
+
+The parser and handlers live in
+:mod:`spikeforge.benchmark.cli`; this module only exposes ``main`` so
+the module runner and the ``spikeforge-benchmark`` console script share
+one path.
+"""
+
+import sys
+
+from spikeforge.benchmark.cli import main
+
+if __name__ == "__main__":
+    sys.exit(main())