Provides client-side functionality to connect to a XayNet service.
This functionality includes:
- Abiding by (the underlying
Participant's side of) the PET protocol.
- Handling the network communication with the XayNet service, including polling of service data.
Participants selected to
Update are responsible for sending masked model
updates in the form of PET messages constructed with
Client has an intentionally simple API - the idea is that it is
initialised with some settings, and then
start()ed. Currently for
simplicity, clients that have started running will do so indefinitely. It is
therefore the user's responsibility to terminate clients that are no longer
needed. Alternatively, it may be more convenient to run just a single round
(or a known fixed number of rounds). In this case, use
For examples of usage, see the
Note. At present, the
Client implementation is somewhat tightly
coupled with the workings of the C-API SDK, but this may well change in a
future version to be more independently reusable.
This module provides clients for the Xaynet coordinator API.
A client of the federated learning service
A participant in the PET protocol layer.
A primitive model cached on the heap.
Tasks of a participant.