Skip to main content

sightloom_host/
lib.rs

1//! Host model package for [`sightloom`](https://docs.rs/sightloom).
2//!
3//! # Product boundary
4//!
5//! `SightLoom` **does not** turn photos into embeddings. This crate is the
6//! host side of the killer path:
7//!
8//! ```text
9//! photo / frame
10//!   → host detect / embed (reference or ONNX)
11//!   → SightLoom IndexSession (rank / memory / tracks)
12//! ```
13//!
14//! Weights, GPU runtimes, and model download policies live **here** (or in a
15//! private host binary), never inside `sightloom-core`.
16//!
17//! # Features
18//!
19//! | Feature | What |
20//! | --- | --- |
21//! | `std` (default) | host package + reference models |
22//! | `onnx` | tract ONNX backends ([`OnnxEmbedder`], [`OnnxDetector`]) |
23//! | `download` | [`HttpModelFetcher`] for `ModelSpec.uri` |
24//! | `image-decode` | JPEG/PNG → RGB for encoded photos |
25//! | `full` | `onnx` + `download` + `image-decode` |
26//!
27//! # Steps
28//!
29//! 1. Config, preprocess, reference models, [`HostPipeline`]
30//!    (`enroll_photo` / `search_photo_jpeg` / `ingest_frame` / `save_package`)
31//! 2. **ONNX** load from cache / `ModelSpec.local_path`
32//!    (`HostPipeline::from_onnx_cache` / `from_manifest`, feature `onnx`)
33//!    (YOLO detect: [`PreprocessConfig::yolo_detect`] + [`decode_detector_output`])
34//! 3. **Evidence packs** — MOT / re-id / redaction / anomaly FAR
35//! 4. FAR + scoped anomaly baselines
36//! 5. **Download + image decode** + analysis day-of-week seasonality
37//! 6. **Weights cookbook** — [`ModelManifest`], SHA-256 integrity, host docs
38//! 7. **`TrackEval` bridge** — parse/export `MOTChallenge`, import host summaries
39
40#![forbid(unsafe_code)]
41#![allow(
42    clippy::cast_possible_truncation,
43    clippy::cast_precision_loss,
44    clippy::cast_sign_loss
45)]
46
47mod config;
48mod decode;
49mod detect_decode;
50mod device;
51mod error;
52pub mod evidence;
53mod integrity;
54mod manifest;
55#[cfg(feature = "onnx")]
56mod onnx_backend;
57mod pipeline;
58mod preprocess;
59mod reference;
60mod registry;
61
62pub use config::{HostBundleConfig, ModelSpec, ModelTask};
63pub use decode::{DecodedRgb, decode_encoded_rgb, decode_photo_rgb};
64pub use detect_decode::{
65    DetectorDecodeConfig, RawBox, decode_detector_output, detections_from_raw_boxes,
66};
67pub use device::DevicePreference;
68pub use error::HostError;
69pub use evidence::{
70    AnomalyEvidence, EvidencePack, EvidencePackPaths, MotEvidence, RedactionEvidence, ReidEvidence,
71    build_synthetic_anomaly_evidence, build_synthetic_evidence_pack, build_synthetic_mot_evidence,
72    build_synthetic_redaction_evidence, build_synthetic_reid_evidence, write_evidence_pack,
73};
74pub use integrity::{file_sha256_hex, maybe_verify_sha256, verify_file_sha256};
75pub use manifest::{ModelManifest, ResolvedModel, resolve_manifest};
76#[cfg(feature = "onnx")]
77pub use onnx_backend::{OnnxDetector, OnnxEmbedder, OnnxModel};
78pub use pipeline::HostPipeline;
79pub use preprocess::{
80    Letterbox, PreprocessConfig, crop_rgb8, letterbox_rgb8, prepare_rgb8_nchw,
81    prepare_rgb8_nchw_with_meta, resize_rgb8_nearest, rgb8_to_chw_f32,
82};
83pub use reference::{
84    ReferenceEmbedder, ReferenceFaceDetector, ReferenceHostModels, ReferencePersonDetector,
85    frame_to_rgb8,
86};
87#[cfg(feature = "download")]
88pub use registry::HttpModelFetcher;
89pub use registry::{
90    DeferredDownloadFetcher, FilesystemFetcher, ModelFetcher, ensure_cache_dir, write_cache_readme,
91};
92
93/// Re-export facade types commonly used by host binaries.
94pub use sightloom::{
95    DetectorAdapter, EmbeddingTask, FrameView, IndexSession, PhotoEmbeddingAdapter, PhotoView,
96    PixelFormat, TrackEmbeddingAdapter,
97};