Skip to content
Unverified: This page has not yet been anchored to automated code tests.

vox-populi API Reference (generated)

Crate: vox-populi · Version: 0.6.0 · Target: Library (lib.rs)

Vox Populi: multi-node worker registry, HTTP control plane, and Mens native ML (Burn / Candle QLoRA).

Vox populi — node registry, optional HTTP control plane, and (feature mens) native ML.

CPU-first: each [NodeRecord] carries vox_orchestrator::TaskCapabilityHints. See docs/src/architecture/populi-ssot.md for environment variables. The mens module holds Burn/Candle QLoRA training (--features mens …).

FeatureDefault / Enables
default—
gamifydep:vox-gamify
hw-probe-live-test—
inferencemens-candle-qlora
mensdep:anyhow, dep:serde_yaml, dep:ctrlc, dep:chrono, dep:dirs, dep:sysinfo, dep:rand, dep:vox-tensor, dep:vox-corpus, dep:vox-db, dep:vox-bounded-fs, dep:vox-hf-layout, dep:objc2-metal
mens-candle-qloramens, dep:candle-core, dep:candle-nn, dep:safetensors, dep:tokenizers, dep:qlora-rs, dep:reqwest, dep:vox-quantize
mens-candle-qlora-cudamens-candle-qlora, candle-core/cuda, candle-nn/cuda
mens-candle-qlora-metalmens-candle-qlora, candle-core/metal, candle-nn/metal
mens-cloudmens, mens-hf-hub, dep:reqwest, dep:vox-http-client, vox-db/host-integration
mens-hf-hubmens, dep:hf-hub, tokio/rt-multi-thread
mens-trainmens, mens-candle-qlora, mens-hf-hub, dep:vox-eval, dep:vox-plugin-host
mesh-discovery-publishdep:vox-publisher
nvml-gpu-probe—
tlsdep:rustls, dep:rustls-pemfile, dep:tokio-rustls
transportdep:axum, dep:reqwest, dep:reqwest-middleware, dep:vox-http-client, vox-http-client/middleware, dep:tower-http, dep:subtle, dep:vox-bounded-fs, dep:jsonwebtoken, dep:ed25519-dalek, dep:blake3, dep:data-encoding, dep:base64, dep:dashmap, dep:vox-db, dep:turso
DependencyKind
vox-bounded-fsNormal
vox-configNormal
vox-constrained-genNormal
vox-corpusNormal
vox-cryptoNormal
vox-dbNormal
vox-evalNormal
vox-foundationNormal
vox-gamifyNormal
vox-hf-layoutNormal
vox-http-clientNormal
vox-identityNormal
vox-mesh-typesNormal
vox-orchestrator-queueNormal
vox-packageNormal
vox-plugin-hostNormal
vox-populi-typesNormal
vox-publisherNormal
vox-quantizeNormal
vox-repositoryNormal
vox-secretsNormal
vox-tensorNormal
ModuleDescription
mens—
http_client—
http_lifecycle—
tls—
transport—
pairingGitHub-attested pairing and revocation (P5-T2).
quotaPer-key token-bucket quota + reputation EMA (P5-T3).
distributed_training—
inferenceMENS Mn-T2 inference backends (Candle CPU/CUDA/Metal, llama.cpp RPC, Ollama).
StructDescription
PopuliEnvParsed populi-related environment (best-effort).
FunctionDescription
populi_enabled_from_envWhether populi hooks are enabled (VOX_MESH_ENABLED=1 or true).
populi_env_resolvedMerge Vox.toml [populi] into env-derived values when the corresponding env is unset. Precedence: environment always wins over TOML for each field.
populi_advertise_gpu_effectiveWhether VOX_MESH_ADVERTISE_GPU is set, or [populi].advertise_gpu = true when env is unset.
normalize_http_control_baseNormalize a control-plane URL for use as an HTTP client base (join / heartbeat / list). Returns [None] for empty strings, invalid trim, or bind-all hosts (0.0.0.0, ::) where the value is meant for vox populi serve --bind, not outbound requests.
populi_envRead populi env vars (does not mutate process state).
populi_scope_id_from_envVOX_MESH_SCOPE_ID when set and non-empty after trim.
wall_clock_unix_msCurrent Unix time in milliseconds (for federation timestamps and tests).
resolve_vox_toml_best_effortResolve Vox.toml path next to the current working directory (nearest manifest root).
node_record_for_current_processBuild a [NodeRecord] for this process using orchestrator host probe + populi env labels.
publish_local_registry_best_effortRegister this process into the default local registry file (no-op if VOX_MESH_ENABLED is off).
populi_registration_record_for_process[NodeRecord] for this process — same id and listen_addr as [publish_local_registry_best_effort].
local_registry_pathResolved on-disk registry path (honours VOX_MESH_REGISTRY_PATH).
current_target_tripleReturns the current target triple (Wave 4 best-effort).