rustensor 0.1.0

Small Rust-native checkpoint format for model metadata and tensor weights.
Documentation
//! Model metadata definitions.
//!
//! This module defines descriptive metadata stored inside a rustensor
//! checkpoint payload.
use crate::error::{Result, RustensorError};
use serde::{Deserialize, Serialize};
use std::collections::BTreeMap;

#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub struct ModelMetadata {
    pub model_name: String,
    pub architecture: String,
    pub model_version: String,
    pub created_by: Option<String>,
    pub description: Option<String>,
    pub extra: BTreeMap<String, String>,
}

impl ModelMetadata {
    pub fn new(
        model_name: impl Into<String>,
        architecture: impl Into<String>,
        model_version: impl Into<String>,
    ) -> Result<Self> {
        let metadata = Self {
            model_name: model_name.into(),
            architecture: architecture.into(),
            model_version: model_version.into(),
            created_by: None,
            description: None,
            extra: BTreeMap::new(),
        };

        metadata.validate()?;
        Ok(metadata)
    }

    pub fn validate(&self) -> Result<()> {
        if self.model_name.trim().is_empty() {
            return Err(RustensorError::InvalidMetadata {
                field: "model_name",
            });
        }

        if self.architecture.trim().is_empty() {
            return Err(RustensorError::InvalidMetadata {
                field: "architecture",
            });
        }

        if self.model_version.trim().is_empty() {
            return Err(RustensorError::InvalidMetadata {
                field: "model_version",
            });
        }

        Ok(())
    }

    pub fn with_created_by(mut self, created_by: impl Into<String>) -> Self {
        self.created_by = Some(created_by.into());
        self
    }

    pub fn with_description(mut self, description: impl Into<String>) -> Self {
        self.description = Some(description.into());
        self
    }

    pub fn insert_extra(mut self, key: impl Into<String>, value: impl Into<String>) -> Self {
        self.extra.insert(key.into(), value.into());
        self
    }
}