Struct MultinomialModelEnvelope 

pub struct MultinomialModelEnvelope {
    pub model_class: String,
    pub format_version: u32,
    pub saved: MultinomialSavedModel,
}

Round-trip persistence envelope for a fitted multinomial model. The model_class discriminator lets a loader tell a multinomial payload apart from the scalar FittedModel JSON before deserialising the whole struct.

This is the single definition of the multinomial on-disk format, shared by the Python FFI (fit_multinomial_formula / predict_multinomial_formula) and the gam CLI (gam fit --family multinomial / gam predict), so a model persisted by one surface loads in the other.

Fields

model_class: String

format_version: u32

saved: MultinomialSavedModel

Implementations

impl MultinomialModelEnvelope

pub fn new(saved: MultinomialSavedModel) -> Result<Self, EstimationError>

Wrap a fitted model with the canonical model_class tag.

pub fn to_json_bytes(&self) -> Result<Vec<u8>, EstimationError>

Serialize to the canonical JSON byte payload.

pub fn from_json_bytes(bytes: &[u8]) -> Result<Self, EstimationError>

Parse an envelope from JSON bytes, validating the model_class discriminator so a non-multinomial payload is rejected with a clear error rather than silently mis-predicted.

Trait Implementations

impl Clone for MultinomialModelEnvelope

fn clone(&self) -> MultinomialModelEnvelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MultinomialModelEnvelope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MultinomialModelEnvelope

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for MultinomialModelEnvelope

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

where __S: Serializer,

Serialize this value into the given Serde serializer.