voxora-registry 0.5.4

Central model registry for voxora (ASR-specific). Resolves a model id to (EngineDescriptor, ModelDir) without lex-sort heuristics.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

//! Central model registry for voxora (ASR-specific).
//!
//! Owns the answer to "given a model id, give me the engine + the
//! exact on-disk file". Before this crate existed, that answer was
//! distributed across `voxora-hf` (cache key), `voxora-whisper`
//! (lex-sort over `*.bin`), and `voxora-cli` (heuristic). Now it
//! lives here.
//!
//! ## Phase 0 surface
//!
//! - [`ModelId::parse`] — strict parser for `org/repo` /
//!   `org/repo/file` / `/local/path` / `./local-path`.
//! - [`Registry`] — a list of [`EngineDescriptor`]s + a
//!   [`voxora_traits::ModelSource`] used to download/locate the model.
//! - [`builtin_whisper_descriptor`] / [`builtin_qwen3asr_descriptor`]
//!   — default HF descriptors. `Registry::with_builtin_descriptors()` is
//!   provided by the `RegistryHfExt` trait behind the `hf` feature.
//! - [`builtin_local_descriptor`] — accepts any `SourceKind::Local`
//!   id (closes #120). Pair with a
//!   `Registry::with_builtin_descriptors_and_chained_source(local_root)`
//!   helper (also on `RegistryHfExt`, behind the `local` feature) to
//!   wire a `voxora_local::ChainedSource` for "local first, HF on
//!   miss" resolution.
//! - [`CacheManifest`] — `.voxora-manifest.json` written next to
//!   cached weights so future runs can answer "which engine?" without
//!   re-parsing the directory.
//!
//! ASR-specific: the descriptors model only ASR engines (Whisper,
//! Qwen3-Asr). Adding `parakeet`, `voxtral`, or `granite-speech` is
//! a 0.2.x change.

#![forbid(unsafe_code)]
#![warn(missing_docs)]

pub mod builtin;
pub mod descriptor;
pub mod error;
pub mod id;
pub mod manifest;
pub mod resolver;

#[cfg(feature = "hf")]
#[cfg_attr(docsrs, doc(cfg(feature = "hf")))]
pub mod hf;

pub use builtin::{builtin_local_descriptor, builtin_qwen3asr_descriptor, builtin_whisper_descriptor};
pub use descriptor::{EngineCapabilities, EngineDescriptor};
pub use error::RegistryError;
pub use id::{ModelId, SourceKind};
pub use manifest::{CacheManifest, MANIFEST_FILENAME, MANIFEST_VERSION};
pub use resolver::{Registry, ResolvedModel};

#[cfg(feature = "hf")]
#[cfg_attr(docsrs, doc(cfg(feature = "hf")))]
pub use hf::{RegistryHfExt, hf_registry};

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn public_surface_lists_core_types() {
        // Compile-time check that the re-exports stay in sync.
        let _id: ModelId = ModelId::parse("Qwen/Qwen3-ASR-0.6B").unwrap();
        let _src = SourceKind::HuggingFace;
    }
}