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
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
68
69
70

//! The bytes a device can give a model's weights, the budget every builder checks them against.

#[cfg(any(target_os = "linux", test))]
mod meminfo;

use candle_core::Device;

/// `None` where this platform or build gives no figure, which the builders read as no limit.
pub(crate) fn budget_bytes(device: &Device) -> Option<u64> {
  match device {
    // Past the free pages the system compresses and swaps, slow but correct, so only a model larger than RAM is refused.
    Device::Cpu => physical_memory(),
    Device::Metal(metal) => metal_working_set(metal),
    Device::Cuda(cuda) => cuda_free(cuda),
  }
}

/// Apple's estimate of what the GPU can hold without hurting its performance, less what this process holds.
#[cfg(feature = "metal")]
fn metal_working_set(device: &candle_core::MetalDevice) -> Option<u64> {
  let raw = device.metal_device();
  let budget = raw.recommended_max_working_set_size() as u64;
  Some(budget.saturating_sub(raw.current_allocated_size() as u64))
}

#[cfg(not(feature = "metal"))]
fn metal_working_set(_: &candle_core::MetalDevice) -> Option<u64> {
  None
}

#[cfg(feature = "cuda")]
fn cuda_free(device: &candle_core::CudaDevice) -> Option<u64> {
  let (free, _total) = device.cuda_stream().context().mem_get_info().ok()?;
  Some(free as u64)
}

#[cfg(not(feature = "cuda"))]
fn cuda_free(_: &candle_core::CudaDevice) -> Option<u64> {
  None
}

#[cfg(target_os = "macos")]
fn physical_memory() -> Option<u64> {
  let mut bytes = 0u64;
  let mut len = std::mem::size_of::<u64>();
  let name = c"hw.memsize".as_ptr();
  let status = unsafe {
    libc::sysctlbyname(
      name,
      (&raw mut bytes).cast(),
      &mut len,
      std::ptr::null_mut(),
      0,
    )
  };
  (status == 0).then_some(bytes)
}

#[cfg(target_os = "linux")]
fn physical_memory() -> Option<u64> {
  meminfo::mem_total(&std::fs::read_to_string("/proc/meminfo").ok()?)
}

#[cfg(not(any(target_os = "macos", target_os = "linux")))]
fn physical_memory() -> Option<u64> {
  None
}

#[cfg(test)]
mod tests;