ferrum-interfaces 0.12.1

Core trait contracts for the Ferrum LLM inference engine
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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

use std::collections::BTreeMap;

use super::*;
use crate::vnext::ResolvedTensorLayout;

/// Full canonical content of one non-token input. Tensor identity and all bytes
/// participate in equality; a hash alone is never the final matching proof.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct CheckpointCanonicalInput {
    tensor: ResolvedTensorSpec,
    bytes: Vec<u8>,
}

impl CheckpointCanonicalInput {
    pub fn new(tensor: ResolvedTensorSpec, bytes: Vec<u8>) -> Result<Self, VNextError> {
        if !matches!(tensor.layout(), ResolvedTensorLayout::Contiguous)
            || u64::try_from(bytes.len()).ok() != Some(tensor.minimum_storage_bytes()?)
        {
            return Err(invalid_plan(
                "checkpoint input requires exact contiguous canonical tensor bytes",
            ));
        }
        Ok(Self { tensor, bytes })
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct SequenceCheckpointInputIdentity {
    layout_fingerprint: String,
    token_input: ProgramValueId,
    tokens: Vec<u32>,
    conditioning: BTreeMap<ProgramValueId, CheckpointCanonicalInput>,
    requires_entire_input: bool,
    completed_input_capture: CheckpointCompletedInputCapture,
}

impl SequenceCheckpointInputIdentity {
    pub fn tokens(&self) -> &[u32] {
        &self.tokens
    }

    /// Checks exact contents after an indexed lookup. This is only the input
    /// portion of matching: plan/loading instance, saved N and numerical
    /// partition identity remain mandatory independent checks.
    pub fn matches_at(&self, target: &Self, boundary: usize) -> bool {
        boundary > 0
            && boundary < target.tokens.len()
            && (boundary < self.tokens.len()
                || (boundary == self.tokens.len()
                    && self.completed_input_capture == CheckpointCompletedInputCapture::Supported))
            && self.layout_fingerprint == target.layout_fingerprint
            && self.token_input == target.token_input
            && self.conditioning == target.conditioning
            && self.requires_entire_input == target.requires_entire_input
            && self.tokens[..boundary] == target.tokens[..boundary]
            && (!self.requires_entire_input || self.tokens == target.tokens)
    }
}

impl SequenceCheckpointLayout {
    pub fn bind_inputs(
        &self,
        token_input: &ProgramValueId,
        tokens: &[u32],
        conditioning: &BTreeMap<ProgramValueId, CheckpointCanonicalInput>,
    ) -> Result<SequenceCheckpointInputIdentity, Vec<SequenceCheckpointUnsupportedReason>> {
        use SequenceCheckpointUnsupportedReason as Reason;
        let declared = self.inputs();
        let mut reasons = Vec::new();
        if token_input != declared.token_input() || tokens.is_empty() {
            reasons.push(Reason::InvalidInput {
                value_id: declared.token_input().clone(),
            });
        }
        for value_id in declared.conditioning_inputs() {
            if !conditioning.contains_key(value_id) {
                reasons.push(Reason::MissingInput {
                    value_id: value_id.clone(),
                });
            }
        }
        for value_id in conditioning.keys() {
            if !declared.conditioning_inputs().contains(value_id) {
                reasons.push(Reason::InvalidInput {
                    value_id: value_id.clone(),
                });
            }
        }
        if !reasons.is_empty() {
            return Err(reasons);
        }
        let layout_fingerprint = self
            .fingerprint()
            .map_err(|_| vec![Reason::InputCoverage])?;
        Ok(SequenceCheckpointInputIdentity {
            layout_fingerprint,
            token_input: token_input.clone(),
            tokens: tokens.to_vec(),
            conditioning: conditioning.clone(),
            requires_entire_input: self.input_dependency()
                == CheckpointInputDependency::EntireTokenInput,
            completed_input_capture: self.completed_input_capture(),
        })
    }
}