Struct ModuleRecord 

pub struct ModuleRecord { /* private fields */ }

A non-generic record holding a module’s parameters.

Obtain one from a module with Module::into_record, then either save it (save / into_bytes) or apply it back with Module::load_record. Load-time behavior is configured with the builder methods; they are ignored when saving.

The save-side dtype is intentionally not configurable: use module.cast(dtype) before taking the record. The record stores whatever dtype the module currently holds.

Implementations

impl ModuleRecord

pub fn len(&self) -> usize

The number of tensors in the record.

pub fn is_empty(&self) -> bool

Whether the record holds no tensors.

pub fn with_dtype_policy(self, policy: DTypePolicy) -> Self

Set the dtype policy used when loading into a module.

pub fn cast_to_module_dtype(self) -> Self

Cast the record’s data to the module parameter dtypes on load.

Sugar for with_dtype_policy(DTypePolicy::CastToModule).

pub fn allow_partial(self, allow: bool) -> Self

Allow loading even when some module parameters are absent from the record.

pub fn validate(self, validate: bool) -> Self

Enable or disable validation while loading.

pub fn into_bytes(self) -> Result<Bytes, RecordError>

Serialize the record to an in-memory burnpack byte buffer.

pub fn from_bytes(bytes: Bytes) -> Result<Self, RecordError>

Reconstruct a record from an in-memory burnpack byte buffer.

pub fn save<P: AsRef<Path>>(self, path: P) -> Result<(), RecordError>

Available on crate feature std only.

Save the record to a burnpack file on disk.

pub fn load<P: AsRef<Path>>(path: P) -> Result<Self, RecordError>

Available on crate feature std only.

Load a record from a burnpack file on disk.

Trait Implementations

impl Clone for ModuleRecord

fn clone(&self) -> ModuleRecord

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModuleRecord

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

Formats the value using the given formatter.