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.4 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.
Crates
| Crate | What it holds |
|---|---|
quip-solver-core |
The Sampler trait, Ising and compressed sparse row types, inverse-temperature ladder, adaptive budget, session loop |
quip-proto |
Generated tonic and prost stubs for proto/quip/v1/miner.proto |
quip-protocol |
Wire codec, energy and diversity scoring, handshake, ChaCha8 draw |
ising-generators |
Family descriptors, canonical instances, ChaCha8 streams, and nonce derivation, no_std |
quip-solver-conformance |
Golden vectors and the scripted session driver |
quip-protocol-py |
PyO3 bindings exposing quip-protocol scoring and wire primitives to Python |
quip-protocol-wasm |
WebAssembly bindings behind the npm package |
quip-solver-c |
C binary interface over the session loop, shipped as a release artifact |
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.4"
[dev-dependencies]
quip-solver-conformance = "0.0.4"
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.
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>
Exit code 0 means conformant. The driver spawns any executable, so this works for a solver in any language.
Licence
Metadata
Release files for quip-solver-core 0.0.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| quip_solver_core-0.0.4.tar.gz | 218.7 kB | Without provenance | Details for quip_solver_core-0.0.4.tar.gz |
Built distributions (wheels)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| quip_solver_core-0.0.4-cp311-abi3-manylinux_2_34_x86_64.whl | CPython 3.11 | abi3 | Linux glibc 2.34+ x86-64 | Details for quip_solver_core-0.0.4-cp311-abi3-manylinux_2_34_x86_64.whl |
| quip_solver_core-0.0.4-cp311-abi3-manylinux_2_34_aarch64.whl | CPython 3.11 | abi3 | Linux glibc 2.34+ ARM64 | Details for quip_solver_core-0.0.4-cp311-abi3-manylinux_2_34_aarch64.whl |
| quip_solver_core-0.0.4-cp311-abi3-macosx_11_0_arm64.whl | CPython 3.11 | abi3 | macOS 11.0+ ARM64 | Details for quip_solver_core-0.0.4-cp311-abi3-macosx_11_0_arm64.whl |
Total release size: 1.0 MB
Release files / quip_solver_core-0.0.4.tar.gz
| Download URL | quip_solver_core-0.0.4.tar.gz |
|---|---|
| Size | 218.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8526df3e40dfabaff4a0cf22ef4c3064b0a1bb124e0eb1c180cf23144e4f1bcf
|
|
BLAKE2b-256 checksum How to use checksums |
86958a20cc4a5549d2866a1cbf9764dc4cc54aa627b81319e0d433d02e5dc74a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.11.18
|
Release files / quip_solver_core-0.0.4-cp311-abi3-manylinux_2_34_x86_64.whl
| Download URL | quip_solver_core-0.0.4-cp311-abi3-manylinux_2_34_x86_64.whl |
|---|---|
| Size | 279.7 kB |
| Tags | CPython 3.11 Linux glibc 2.34+ x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
d51905db1bfb27909f9de97d5e991eed6608af29e88aaabba0a6206d4eca7960
|
|
BLAKE2b-256 checksum How to use checksums |
68790f145a5a67f904813067e634cd4f8be6a7ac84289437d5aeaed4f84c618b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.11.18
|
Release files / quip_solver_core-0.0.4-cp311-abi3-manylinux_2_34_aarch64.whl
| Download URL | quip_solver_core-0.0.4-cp311-abi3-manylinux_2_34_aarch64.whl |
|---|---|
| Size | 277.0 kB |
| Tags | CPython 3.11 Linux glibc 2.34+ ARM64 abi3 |
|
SHA-256 checksum How to use checksums |
3eefb6e1bb1fd0c0a7c977ffa53d0de661d7f5a5e133ae20252a9dbe550bbe86
|
|
BLAKE2b-256 checksum How to use checksums |
5d52e1a9755c5023b95cc0e1e9e0274fb5a2757e80b7ca752cc580a8a09cc95c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.11.18
|
Release files / quip_solver_core-0.0.4-cp311-abi3-macosx_11_0_arm64.whl
| Download URL | quip_solver_core-0.0.4-cp311-abi3-macosx_11_0_arm64.whl |
|---|---|
| Size | 253.1 kB |
| Tags | CPython 3.11 abi3 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
59da170cf0c90a73c91a132f3ea4b1eeb1f7d0c76e3b8bdb5921f3ab9c4f7fa1
|
|
BLAKE2b-256 checksum How to use checksums |
a5e29f44fafd6ab92d655b87c7deeafa3d11e92379f2529dae7a00423fa0c2f5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.11.18
|
Security for quip-solver-core 0.0.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
