Struct xaynet::client::Client

pub struct Client {
    pub local_model: Option<Model>,
    // some fields omitted
}

A client of the federated learning service

Client is responsible for communicating with the service, deserialising its messages and delegating their processing to the underlying Participant.

Fields

local_model: Option<Model>

Implementations

impl Client

pub fn new_with_hdl(
    period: u64,
    id: u32,
    fetcher: impl Fetcher + 'static + Send + Sync,
    message_handler: impl PetMessageHandler + 'static + Send + Sync
) -> Result<Self, ClientError>

Create a new Client with a given service handle.

• period: time period at which to poll for service data, in seconds.
• id: an ID to assign to the Client.
• fetcher: fetcher for in-memory service proxy.
• message_handler: message handler for in-memory service proxy.

Errors

Returns a ParticipantInitErr if the underlying Participant is unable to initialize.

pub fn new_with_addr(
    period: u64,
    id: u32,
    addr: &str
) -> Result<Self, ClientError>

Create a new Client with a given service address.

• period: time period at which to poll for service data, in seconds.
• id: an ID to assign to the Client.
• addr: service address to connect to.

Errors

Returns a ParticipantInitErr if the underlying Participant is unable to initialize.

pub async fn start<'_>(&'_ mut self) -> Result<(), ClientError>

Starts the Client loop, iterating indefinitely over each federated learning round.

Errors

A ClientError may be returned when the round is not able to complete successfully.

pub async fn during_round<'_>(&'_ mut self) -> Result<Task, ClientError>

Client work flow over a federated learning round. A successfully completed round will return the Task of the client.

Errors

A ClientError may be returned when the round is not able to complete successfully.

Trait Implementations

impl Default for Client

fn default() -> Self

Returns the "default value" for a type.