cgpu 0.1.0

A tunable GPU compute executor with automatic CPU fallback, byte-based batching, and inline shader generation.
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

use crate::error::GpuError;

pub const DEFAULT_SAFE_VRAM_BYTES: usize = 128 * 1024 * 1024;
pub const DEFAULT_FILL_RATIO: f32 = 0.92;
pub const MIN_FILL_RATIO: f32 = 0.90;
pub const MAX_FILL_RATIO: f32 = 0.95;

#[derive(Clone, Copy, Debug, PartialEq)]
pub struct GpuMemoryBudget {
    safe_vram_bytes: usize,
    fill_ratio: f32,
}

impl Default for GpuMemoryBudget {
    fn default() -> Self {
        Self {
            safe_vram_bytes: DEFAULT_SAFE_VRAM_BYTES,
            fill_ratio: DEFAULT_FILL_RATIO,
        }
    }
}

impl GpuMemoryBudget {
    pub fn new(safe_vram_bytes: usize, fill_ratio: f32) -> Result<Self, GpuError> {
        if safe_vram_bytes == 0 {
            return Err(GpuError::InvalidBudget(
                "safe_vram_bytes must be greater than zero",
            ));
        }

        if !(MIN_FILL_RATIO..=MAX_FILL_RATIO).contains(&fill_ratio) {
            return Err(GpuError::InvalidBudget(
                "fill_ratio must stay between 0.90 and 0.95",
            ));
        }

        Ok(Self {
            safe_vram_bytes,
            fill_ratio,
        })
    }

    pub fn safe_vram_bytes(self) -> usize {
        self.safe_vram_bytes
    }

    pub fn fill_ratio(self) -> f32 {
        self.fill_ratio
    }

    pub fn target_batch_bytes(self) -> usize {
        ((self.safe_vram_bytes as f64) * f64::from(self.fill_ratio)).floor() as usize
    }
}