Struct xaynet_core::mask::Masker

pub struct Masker { /* fields omitted */ }

A masker for models.

Implementations

impl Masker

pub fn new(config: MaskConfig) -> Self

Creates a new masker with the given masking configuration with a randomly generated seed.

pub fn with_seed(config: MaskConfig, seed: MaskSeed) -> Self

Creates a new masker with the given masking configuration and seed.

impl Masker

pub fn mask(
    self,
    scalar: f64,
    model: Model
) -> (MaskSeed, MaskObject, MaskObject)

Masks the given model wrt the masking configuration. Enforces bounds on the scalar and weights.

The masking proceeds in the following steps:

• Clamp the scalar and the weights according to the masking configuration.
• Scale the weights by the scalar.
• Shift the weights into the non-negative reals.
• Shift the weights into the non-negative integers.
• Shift the weights into the finite group.
• Mask the weights with random elements from the finite group.

The random elements are derived from a seeded PRNG. Unmasking as performed in unmask() proceeds in reverse order.