Struct surrealml_core::storage::surml_file::SurMlFile

pub struct SurMlFile {
    pub header: Header,
    pub model: Vec<u8>,
}

The SurMlFile struct represents the entire surml file.

Fields

• header - The header of the surml file containing data such as key bindings for inputs and normalisers.
• model - The PyTorch model in C.

Fields

header: Header

model: Vec<u8>

Implementations

impl SurMlFile

pub fn fresh(model: Vec<u8>) -> Self

Creates a new SurMlFile struct with an empty header.

Arguments

• model - The PyTorch model in C.

Returns

A new SurMlFile struct with no columns or normalisers.

pub fn new(header: Header, model: Vec<u8>) -> Self

Creates a new SurMlFile struct.

Arguments

• header - The header of the surml file containing data such as key bindings for inputs and normalisers.
• model - The PyTorch model in C.

Returns

A new SurMlFile struct.

pub fn from_bytes(bytes: Vec<u8>) -> Result<Self, SurrealError>

Creates a new SurMlFile struct from a vector of bytes.

Arguments

• bytes - A vector of bytes representing the header and the model.

Returns

A new SurMlFile struct.

pub fn from_file(file_path: &str) -> Result<Self, SurrealError>

Creates a new SurMlFile struct from a file.

Arguments

• file_path - The path to the surml file.

Returns

A new SurMlFile struct.

pub fn to_bytes(&self) -> Vec<u8>

Converts the header and the model to a vector of bytes.

Returns

A vector of bytes representing the header and the model.

pub fn write(&self, file_path: &str) -> Result<(), SurrealError>

Writes the header and the model to a surml file.

Arguments

• file_path - The path to the surml file.

Returns

An io::Result indicating whether the write was successful.