Skip to content

Index

diapason.mining

Pearl mining subsystem.

See spec docs/design/2026-05-05-vllm-pearl-mining-integration-design.md.

Provider modules are soft-imported below — each one fails gracefully if the mining-pearl (or future mining-pearl-mlx etc.) extra isn't installed.

MiningCapabilities dataclass

Result of a provider's detect() call.

reason is human-readable and surfaced verbatim by diapason mine doctor when supported=False.

MiningConfig dataclass

User-supplied mining configuration.

Loaded from the [mining] TOML section by core/config.py.

MiningProvider

Bases: ABC

A mining provider — orchestrates a Pearl mining session.

One provider per (hardware, engine, model) combo. All future hardware/engine paths (Apple Silicon, AMD, Ollama) implement this exact contract. See spec §4.4.

detect(hw, engine_id, model) abstractmethod classmethod

Return whether this provider can run on the given combo.

Must be a pure inspection — no subprocess, no network, no Docker. Used by diapason mine doctor and diapason mine init for fast capability reporting.

PoolTarget dataclass

Mine through an OJ-operated pool. v2 — raises NotImplementedError in v1.

Sidecar

Read/write helpers for ~/.diapason/runtime/mining.json.

write(path, payload) staticmethod

Atomically write the sidecar JSON to path.

SoloTarget dataclass

Mine directly to a pearld node. v1 default.