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

use serde::{Deserialize, Serialize};

use crate::vnext::{DynamicStorageProfile, ResolvedValueRole};

/// Exact logical byte ABI promised by a provider for one state port. Both
/// forms require a contiguous semantic tensor and one physical component;
/// the selected storage profile may translate its logical range into pages.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case", deny_unknown_fields)]
pub enum ProviderCheckpointStateLayout {
    /// The component contains the complete tensor value at the boundary.
    ContiguousBoundaryValue,
    /// Ordered token-major values with no per-token padding. The declared
    /// stride is the entire resolved semantic tensor's byte size. Only [0,N)
    /// is valid, regardless of how much backing capacity was reserved.
    TokenMajorPrefix,
}

/// A declaration is specific to an operation port and physical storage ABI.
/// Its ordinal is validated against the selected operation; it is not a
/// semantic state name or a user-supplied resource byte range.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct ProviderCheckpointStatePort {
    role: ResolvedValueRole,
    ordinal: u32,
    storage_profile: DynamicStorageProfile,
    layout: ProviderCheckpointStateLayout,
}

impl ProviderCheckpointStatePort {
    pub const fn new(
        role: ResolvedValueRole,
        ordinal: u32,
        storage_profile: DynamicStorageProfile,
        layout: ProviderCheckpointStateLayout,
    ) -> Self {
        Self {
            role,
            ordinal,
            storage_profile,
            layout,
        }
    }

    pub const fn role(&self) -> ResolvedValueRole {
        self.role
    }
    pub const fn ordinal(&self) -> u32 {
        self.ordinal
    }
    pub const fn storage_profile(&self) -> DynamicStorageProfile {
        self.storage_profile
    }
    pub const fn layout(&self) -> ProviderCheckpointStateLayout {
        self.layout
    }

    pub(super) fn key(&self) -> (ResolvedValueRole, u32, DynamicStorageProfile) {
        (self.role, self.ordinal, self.storage_profile)
    }
}