p2pfl.communication.protocols.protobuff.protobuff_communication_protocol module

GRPC communication protocol.

class p2pfl.communication.protocols.protobuff.protobuff_communication_protocol.ProtobuffCommunicationProtocol(commands=None)[source]

Bases: CommunicationProtocol

Protobuff communication protocol.

Parameters:

  • addr – Address of the node.

  • commands (list[Command] | None) – Commands to add to the communication protocol.

Todo

Decouple the heeartbeat command.

add_command(cmds)[source]

Add a command to the communication protocol.

Parameters:

cmds (Command | list[Command]) – The command to add.

Return type:

None

abstract bluid_client(*args, **kwargs)[source]

Build client function.

Return type:

ProtobuffClient

broadcast(msg, node_list=None)[source]

Broadcast a message to all neighbors.

Parameters:

  • msg (RootMessage) – The message to broadcast.

  • node_list (list[str] | None) – Optional node list.

Return type:

None

build_msg(cmd, args=None, round=None, direct=False)[source]

Build a RootMessage to send to the neighbors.

Parameters:

  • cmd (str) – Command of the message.

  • args (list[str] | None) – Arguments of the message.

  • round (int | None) – Round of the message.

  • direct (bool) – If direct message.

Return type:

RootMessage

Returns:

RootMessage to send.

abstract build_server(*args, **kwargs)[source]

Build server function.

Return type:

ProtobuffServer

build_weights(cmd, round, serialized_model, contributors=None, weight=1)[source]

Build a RootMessage with a Weights payload to send to the neighbors.

Parameters:

  • cmd (str) – Command of the message.

  • round (int) – Round of the message.

  • serialized_model (bytes) – Serialized model to send.

  • contributors (list[str] | None) – List of contributors.

  • weight (int) – Weight of the message (number of samples).

Return type:

RootMessage

Returns:

RootMessage to send.

connect(addr, non_direct=False)[source]

Connect to a neighbor.

Parameters:

  • addr (str) – The address to connect to.

  • non_direct (bool) – The non direct flag.

Return type:

bool

disconnect(nei, disconnect_msg=True)[source]

Disconnect from a neighbor.

Parameters:

  • nei (str) – The neighbor to disconnect from.

  • disconnect_msg (bool) – The disconnect message flag.

Return type:

None

get_neighbors(only_direct=False)[source]

Get the neighbors.

Parameters:

only_direct (bool) – The only direct flag.

Return type:

dict[str, Any]

gossip_weights(early_stopping_fn, get_candidates_fn, status_fn, model_fn, period=None, create_connection=False)[source]

Gossip model weights.

Parameters:

  • early_stopping_fn (Callable[[], bool]) – The early stopping function.

  • get_candidates_fn (Callable[[], list[str]]) – The get candidates function.

  • status_fn (Callable[[], Any]) – The status function.

  • model_fn (Callable[[str], tuple[Any, str, int, list[str]]]) – The model function.

  • period (float | None) – The period.

  • create_connection (bool) – The create connection flag.

Return type:

None

send(nei, msg, raise_error=False, remove_on_error=True)[source]

Send a message to a neighbor.

Parameters:

  • nei (str) – The neighbor to send the message.

  • msg (RootMessage) – The message to send.

  • raise_error (bool) – If raise error.

  • remove_on_error (bool) – If remove on error.

Return type:

None

set_addr(addr)[source]

Set the addr of the node.

Parameters:

addr (str)

Return type:

str

start()[source]

Start the GRPC communication protocol.

Return type:

None

stop()[source]

Stop the GRPC communication protocol.

Return type:

None

wait_for_termination()[source]

Get the neighbors.

Parameters:

only_direct – The only direct flag.

Return type:

None

p2pfl.communication.protocols.protobuff.protobuff_communication_protocol.running(func)[source]

Ensure that the server is running before executing a method.