Skip to content

API_REFERENCE.md

Latest commit

 

History

History
77 lines (53 loc) · 2.47 KB

API_REFERENCE.md

File metadata and controls

77 lines (53 loc) · 2.47 KB

QRES v20.0.1 API Reference

Core Traits (qres_core)

The primary interface is defined in the cortex module (Aggregation Engine).

trait SwarmNeuron (Mesh Node Protocol)

The core behavior interface for mesh nodes.

  • fn predict(&self, history: &[u8]) -> u8: Deterministic prediction hot-path.
  • fn adapt(&mut self, signals: &[SpikeEvent]): Adaptive update based on peer signals.
  • fn export_gene(&self) -> Vec<u8>: Serializes the current model bytecode.

trait ModelPersistence (Persistent Storage Layer)

Interface for model bytecode persistence. Replaces deprecated GeneStorage (v20.2.0).

  • fn save_gene(&mut self, id: u32, gene: &[u8]) -> bool: Persist model bytecode to flash/disk.
  • fn load_gene(&self, id: u32) -> Option<Vec<u8>>: Recover model bytecode on reboot.

Terminology Note (v20.2.0): GeneStorage is deprecated in favor of ModelPersistence. See TECHNICAL_DEBT.md for migration timeline.

🏗️ Rust Core API (qres_core)

The primary interface for QRES is the Rust crate. It is no_std compatible and powers all other bindings.

compress

pub fn compress(data: &[u8], config: CompressionConfig) -> Result<Vec<u8>, QresError>

Compresses a byte slice with deterministic behavior.

  • data: Input byte slice.
  • config: Struct containing mode (Standard/Tensor), threshold (0.0-1.0), and window_size.
  • Returns: Vec<u8> containing the compressed bitstream.

decompress

pub fn decompress(data: &[u8]) -> Result<Vec<u8>, QresError>

Decompresses a QRES stream.

🐍 Python Bindings (qres_core)

The Python API wraps the Rust core for high-performance usage in scripts and ML pipelines.

qres_core.compress(data: bytes, mode: str = "standard") -> bytes

  • data: Bytes to compress.
  • mode: "standard" (Linear/LZ77) or "tensor" (Tensor/SNN).

qres_core.decompress(data: bytes) -> bytes

  • data: Compressed QRES bytes.

📦 WASM / JavaScript API

The WebAssembly target allows running QRES in the browser.

compress_wasm(data: Uint8Array) -> Uint8Array

Sync compression running on the main thread (or worker).

decompress_wasm(data: Uint8Array) -> Uint8Array

Sync decompression.

📄 File I/O (Daemon/CLI)

For file operations, use the qres_daemon CLI or the QRESFile wrapper (if using the legacy Python helper).

qres_daemon

qres_daemon compress <INPUT> [OUTPUT]
qres_daemon decompress <INPUT> [OUTPUT]