Struct GgufHeader 

pub struct GgufHeader {
    pub metadata: BTreeMap<String, Value>,
    pub file_bytes: u64,
    pub data_offset: u64,
    pub tensors: Vec<TensorRow>,
}

A GGUF header: the metadata and the whole tensor table, and where in the file the tensor data lives.

Fields

metadata: BTreeMap<String, Value>

file_bytes: u64

data_offset: u64

tensors: Vec<TensorRow>

Implementations

impl GgufHeader

pub fn read_ledger(path: &Path) -> Result<GgufHeader, String>

A header ledger (benchmarks/silicon/decode/headers/*.json, written by scripts/accel/gguf_remote_header.py --tensors).

pub fn source(&self) -> HeaderSource

The header as a checkpoint’s description (crate::model::spec::SpecSource).

pub fn spec(&self) -> Result<ModelSpec, SpecError>

The architecture the header describes, read as crate::model::spec::ModelSpec::from_gguf reads its checkpoint’s.

pub fn arch(&self) -> Option<&str>

general.architecture — the prefix every architecture key carries.

pub fn meta_u64(&self, key: &str) -> Option<u64>

The architecture key {arch}.{key} as an unsigned integer.

pub fn tensor_type(&self, t: &TensorRow) -> Result<GgmlType, DecodeRefusal>

The storage type of t.

pub fn tensor_bytes(&self, t: &TensorRow) -> Result<u64, DecodeRefusal>

Bytes t occupies in the file.

pub fn byte_audit(&self) -> Result<(), String>

Holds the tensor table to the file: in offset order each tensor’s bytes fill the gap to the next up to the alignment padding, and the last one ends exactly where the file does. A wrong block size, a wrong type id or a missing tensor cannot pass.

Trait Implementations

impl Clone for GgufHeader

fn clone(&self) -> GgufHeader

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GgufHeader

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GgufHeader

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for GgufHeader

fn eq(&self, other: &GgufHeader) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for GgufHeader

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl WeightSource for GgufHeader

A header as a checkpoint’s weights: every tensor’s format and dims and none of its bytes, what lays the checkpoint out on the card and lowers its step.

fn describe(&self, name: &str) -> Result<(GgmlType, Vec<u64>)>

A tensor’s format and dims.

fn row_bytes( &mut self, name: &str, _first: usize, _count: usize, ) -> Result<Vec<u8>>

The bytes of rows [first, first + count), a row being the tensor’s dims[0] elements.

fn has(&self, name: &str) -> bool

impl StructuralPartialEq for GgufHeader