Struct xaynet_server::settings::PetSettings

pub struct PetSettings {
    pub min_sum_count: usize,
    pub min_update_count: usize,
    pub min_sum_time: u64,
    pub min_update_time: u64,
    pub max_sum_time: u64,
    pub max_update_time: u64,
    pub sum: f64,
    pub update: f64,
}

PET protocol settings.

Fields

min_sum_count: usize

The minimal number of participants selected for computing the unmasking sum. The value must be greater or equal to 1 (i.e. min_sum_count >= 1), otherwise the PET protocol will be broken.

This parameter should only be used to enforce security constraints.

Examples

TOML

[pet]
min_sum_count = 1

Environment variable

XAYNET_PET__MIN_SUM_COUNT=1

min_update_count: usize

The expected fraction of participants selected for submitting an updated local model for aggregation. The value must be greater or equal to 3 (i.e. min_update_count >= 3), otherwise the PET protocol will be broken.

This parameter should only be used to enforce security constraints.

Examples

TOML

[pet]
min_update_count = 3

Environment variable

XAYNET_PET__MIN_UPDATE_COUNT=3

min_sum_time: u64

The minimum amount of time reserved for processing messages in the sum and sum2 phases, in seconds.

Defaults to 0 i.e. sum and sum2 phases end as soon as PetSettings::min_sum_count messages have been processed. Set this higher to allow for the possibility of more than PetSettings::min_sum_count messages to be processed in the sum and sum2 phases.

Examples

TOML

[pet]
min_sum_time = 5

Environment variable

XAYNET_PET__MIN_SUM_TIME=5

min_update_time: u64

The minimum amount of time reserved for processing messages in the update phase, in seconds.

Defaults to 0 i.e. update phase ends as soon as PetSettings::min_update_count messages have been processed. Set this higher to allow for the possibility of more than PetSettings::min_update_count messages to be processed in the update phase.

Examples

TOML

[pet]
min_update_time = 10

Environment variable

XAYNET_PET__MIN_UPDATE_TIME=10

max_sum_time: u64

The maximum amount of time permitted for processing messages in the sum and sum2 phases, in seconds.

Defaults to a large number (effectively 1 week). Set this lower to allow for the processing of PetSettings::min_sum_count messages to time-out sooner in the sum and sum2 phases.

Examples

TOML

[pet]
max_sum_time = 30

Environment variable

XAYNET_PET__MAX_SUM_TIME=30

max_update_time: u64

The maximum amount of time permitted for processing messages in the update phase, in seconds.

Defaults to a large number (effectively 1 week). Set this lower to allow for the processing of PetSettings::min_update_count messages to time-out sooner in the update phase.

Examples

TOML

[pet]
max_update_time = 60

Environment variable

XAYNET_PET__MAX_UPDATE_TIME=60

sum: f64

The expected fraction of participants selected for computing the unmasking sum. The value must be between 0 and 1 (i.e. 0 < sum < 1).

Additionally, it is enforced that 0 < sum + update - sum*update < 1 to avoid pathological cases of deadlocks.

Examples

TOML

[pet]
sum = 0.01

Environment variable

XAYNET_PET__SUM=0.01

update: f64

The expected fraction of participants selected for submitting an updated local model for aggregation. The value must be between 0 and 1 (i.e. 0 < update < 1).

Additionally, it is enforced that 0 < sum + update - sum*update < 1 to avoid pathological cases of deadlocks.

Examples

TOML

[pet]
update = 0.01

Environment variable

XAYNET_PET__UPDATE=0.01

Trait Implementations

impl Clone for PetSettings

fn clone(&self) -> PetSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for PetSettings

impl Debug for PetSettings

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

Formats the value using the given formatter.

impl Default for PetSettings

fn default() -> Self

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for PetSettings

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Validate for PetSettings

fn validate(&self) -> Result<(), ValidationErrors>