candding 0.1.0

Pure candle embeddings for Rust with no ONNX: dense, sparse, multi-vector and rerank models today, image models on the roadmap
Documentation 
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

//! The dense catalog's own `all`, `lookup`, `by_phase` and `dtype_needs_accelerator`, as each other catalog has.

use candle_core::DType;

use super::ModelDescriptor;
use super::entries;
use super::entry::Entry;
use super::entry_for;

/// Every registered dense entry, in registration order.
pub fn all() -> Vec<ModelDescriptor> {
  entries().map(Entry::descriptor).collect()
}

/// Case-insensitive lookup by repository id.
pub fn lookup(id: &str) -> Option<ModelDescriptor> {
  entry_for(id).map(Entry::descriptor)
}

/// Every registered dense entry for a phase, in registration order.
pub fn by_phase(phase: u8) -> Vec<ModelDescriptor> {
  entries()
    .filter(|entry| entry.phase == phase)
    .map(Entry::descriptor)
    .collect()
}

/// Whether a registered dense id computes `dtype` correctly only on an accelerator, read from the row its builder
/// refuses from; `false` for an id outside the dense catalog.
pub fn dtype_needs_accelerator(id: &str, dtype: DType) -> bool {
  entry_for(id).is_some_and(|entry| {
    entry
      .descriptor()
      .dtype_backends
      .row(dtype)
      .needs_accelerator()
  })
}