p2pfl.learning.frameworks.p2pfl_model module

P2PFL model abstraction.

class p2pfl.learning.frameworks.p2pfl_model.P2PFLModel(model, params=None, num_samples=None, contributors=None, additional_info=None, compression=None)

Bases: object

P2PFL model abstraction.

This class encapsulates the different models across all the possible frameworks.

The key concept is the extraction of the model weights in a common format for all the frameworks.

Parameters:

model (Any) – The model to encapsulate.

:: note :: The model type is ANY because the different frameworks do not share a common model type.

Parameters:

• params (list[ndarray] | bytes | None)

• num_samples (int | None)

• contributors (list[str] | None)

• additional_info (dict[str, Any] | None)

• compression (dict[str, dict[str, Any]] | None)

add_info(callback, info)

Add additional information to the learner state.

Parameters:

• callback (str) – The callback to add the information

• info (Any) – The information for the callback.

Return type:

None

build_copy(**kwargs)

Build a copy of the model.

Parameters:

**kwargs – Parameters of the model initialization.

Return type:

P2PFLModel

Returns:

A copy of the model.

decode_parameters(data)

Decode the parameters of the model.

Parameters:

data (bytes) – The parameters of the model.

Return type:

tuple[list[ndarray], dict[str, Any]]

encode_parameters(params=None)

Encode the parameters of the model.

Parameters:

params (list[ndarray] | None) – The parameters of the model.

Return type:

bytes

get_contributors()

Get the contributors of the model.

Return type:

list[str]

get_framework()

Retrieve the model framework name.

Return type:

str

Returns:

The name of the model framework.

get_info(callback=None)

Get additional information from the learner state.

Parameters:

• callback (str | None) – The callback to add the information

• key – The key of the information.

Return type:

Any

get_model()

Get the model.

Return type:

Any

get_num_samples()

Get the number of samples used to train this model.

Return type:

int

get_parameters()

Get the parameters of the model.

Return type:

list[ndarray]

Returns:

The parameters of the model

set_contribution(contributors, num_samples)

Set the contribution of the model.

Parameters:

• contributors (list[str]) – The contributors of the model.

• num_samples (int) – The number of samples used to train this model.

Return type:

None

set_parameters(params)

Set the parameters of the model.

Parameters:

params (list[ndarray] | bytes) – The parameters of the model.

Raises:

ModelNotMatchingError – If parameters don’t match the model.

Return type:

None