vyre-spec 0.7.2

Frozen data contracts for vyre - OpDef, AlgebraicLaw, Category, IntrinsicTable
Documentation

vyre-spec

Frozen data contracts for the vyre GPU compute IR.

What this crate is

vyre-spec is the leaf crate of the vyre ecosystem. It contains only frozen data types: IR scalar and operation types, algebraic laws, conformance categories, verification evidence, engine invariants, and the I1..I15 intrinsic catalog. Zero dependencies. Every vyre consumer transitively depends on this crate, so backend vendors may depend on vyre-spec alone to prove conformance without pulling in the compiler or the conform runtime.

What you get

  • Category: operation classification (A, C, etc.)
  • AlgebraicLaw: declarative laws (commutative, associative, identity, distributive, monotonic, bounded, custom predicates, and more)
  • OpDef: frozen operation specification
  • OpSignature: input/output type signature for an IR operation
  • DataType: IR types (U32, I32, U64, Vec2U32, Vec4U32, Bool, Bytes, F32)
  • Convention: calling conventions for op dispatch
  • IntrinsicTable: hardware intrinsic lookup tables
  • EngineInvariant / Invariant / InvariantId: engine-level invariant declarations and the I1..I15 catalog
  • Verification: verification result types
  • Layer: conformance layer declarations (L0–L8)
  • BackendAvailability: per-backend availability predicates
  • GoldenSample / KatVector / AdversarialInput: test vectors and hostile witnesses
  • BinOp / UnOp / AtomicOp: operation descriptors
  • LawCatalog / LAW_CATALOG: static registry of all declared laws
  • INVARIANTS / by_id / by_category: static invariant registry and lookups

Stability

All public enums are marked #[non_exhaustive]. The surface of this crate is frozen under a 5-year stability contract. Any breaking change to a public type or exported constant requires a major version bump. Patch and minor releases add only new variants, new constants, or documentation fixes.

Usage

use vyre_spec::{AlgebraicLaw, DataType, OpSignature};

let sig = OpSignature {
    inputs: vec![DataType::U32, DataType::U32],
    output: DataType::U32,
    input_params: None,
    output_params: None,
    contract: None,
};
let law = AlgebraicLaw::Commutative;
assert_eq!(sig.output, DataType::U32);

See also

License

MIT OR Apache-2.0

Crate contract

This section is generated by python3 scripts/crate_readmes.py --write from the crate manifest, release train, ownership registry, and crate-guide metadata.

Purpose

Own stable schemas, operation definitions, and compatibility contracts without runtime dependencies.

Boundaries

The specification owner maintains this foundation crate at vyre-spec. Its allowed internal production dependencies are: None. Any other normal or build dependency requires an ownership-registry change.

Minimal real example

Run the checked-in behavior from vyre-spec/examples/vyre_spec_release_surface.rs:

CARGO_BUILD_JOBS=1 ./cargo_full run -p vyre-spec --example vyre_spec_release_surface

Features

  • Manifest features: None
  • Default feature members: None

Errors and unsupported behavior

Malformed programs, incompatible schemas, and invalid transformations fail closed through validation or parsing errors before execution.

Testing

Use docs/testing/vyre-spec.md for exact commands, Cargo targets, hardware requirements, evidence outputs, expected skips, and failure semantics.

Release status

vyre-spec@0.7.2 is a publishable crate on the current Vyre release train. Publication still requires the release evidence and user-approval gates.

Ownership

docs/CRATE_OWNERSHIP.toml is authoritative for this crate's responsibility and allowed internal edges. Regenerate docs/CRATE_GRAPH.md and docs/OWNERSHIP.md after changing that registry.

License

Licensed under either of

  • Apache License, Version 2.0, or
  • MIT license

at your option. See the workspace LICENSE-APACHE and LICENSE-MIT files.