quip-solver-core

This repository is the shared Quip solver contract. A solver binary accepts Ising problems and returns spin configurations with their energies.

Rust solvers supply a Sampler and call run. C and C++ solvers register sampling callbacks with the C library. The Python wheel and npm package carry consensus primitives and generated gRPC stubs. Python and TypeScript solvers provide their own session loops.

The full contract is in SPEC.md. CHANGELOG.md lists the 0.0.8 changes. MIGRATING.md covers solver API changes. Releases from 0.0.2-rc3 require protocol version 2. Update the coordinator and solvers together using the coordinator upgrade guide. The miner hardware guide describes how a GPU or other device draws lease problems. The topology file format defines the .bin.gz files that hold the family vectors topologies.

Crates

Install

Every binding ships from its own registry. The C library ships as a release artifact, because a C consumer wants the compiled object and the header.

Rust

[dependencies]
quip-solver-core = "0.0.8"

[dev-dependencies]
quip-solver-conformance = "0.0.8"

One dependency is enough. quip-solver-core re-exports quip_proto and quip_protocol. Default Sampler implementations use IsingGraph<f64> and quip_solver_core::quip_protocol::scoring::energy_milli.

A solver can select Sampler<Milli> to receive exact wire coefficients. Import Milli from quip_solver_core::coefficient. Its stored integer is available through .0. Score those integers with quip_solver_core::quip_protocol::scoring::energy_from_milli. The Rust example shows this choice.

Python

pip install quip-solver-core

Node packages

npm install @quip.network/quip-solver-core

Native libraries

Download quip-solver-clib-<tag>-linux-amd64.tar.gz from the release page. It holds libquip_solver_c.so, libquip_solver_c.a, and include/quip_solver.h.

Samples

examples/ holds a conformant mock solver in four languages. Rust, C++, Python, and TypeScript each consume the published artifact and pass quip-solver-drive. Start there rather than from this README.

Conformance

A solver is conformant when quip-solver-drive reports a conformant session and a conformant --solve run. The --family gate applies to a solver that lists generated families.

cargo build -p quip-solver-conformance --bin quip-solver-drive --release
./target/release/quip-solver-drive <solver-binary> unix:///tmp/quip-check.sock
./target/release/quip-solver-drive --solve <solver-binary>
./target/release/quip-solver-drive --family <solver-binary> unix:///tmp/quip-family.sock

Exit code 0 means conformant. With --family, a revision that the solver lists in generated_families but the driver cannot drive fails the gate. The driver spawns any executable, so this works for a solver in any language.

Licence

Apache-2.0. See LICENSE and NOTICE.