Skip to content
Declearn
message_pb2
Initializing search
magnet/declearn
Declearn
magnet/declearn
Overview
Installation Guide
Quickstart
User Guide
User Guide
Introduction
Overview of the Federated Learning process
Overview of the declearn API
Hands-on usage
Guide to the Optimizer API
Local Differential Privacy capabilities
Secure Aggregation capabilities
API Reference
API Reference
[declearn]
aggregator
aggregator
[aggregator]
Aggregator
AveragingAggregator
GradientMaskedAveraging
ModelUpdates
list_aggregators
communication
communication
[communication]
NetworkClientConfig
NetworkServerConfig
build_client
build_server
list_available_protocols
api
api
[api]
NetworkClient
NetworkServer
backend
backend
[backend]
MessagesHandler
actions
flags
grpc
grpc
[grpc]
GrpcClient
GrpcServer
protobufs
protobufs
[protobufs]
message_pb2
message_pb2
Table of contents
declearn.communication.grpc.protobufs.message_pb2
message_pb2_grpc
messaging
messaging
[messaging]
CancelTraining
Empty
Error
EvaluationReply
EvaluationRequest
GenericMessage
GetMessageRequest
InitRequest
JoinReply
JoinRequest
Message
PrivacyRequest
StopTraining
TrainReply
TrainRequest
parse_message_from_string
flags (alias re-export)
utils
utils
[utils]
ErrorMessageException
MessageTypeException
NetworkClientConfig
NetworkServerConfig
build_client
build_server
list_available_protocols
verify_client_messages_validity
verify_server_message_validity
websockets
websockets
[websockets]
WebsocketsClient
WebsocketsServer
data_info
data_info
[data_info]
ClassesField
DataInfoField
DataTypeField
FeaturesShapeField
NbSamplesField
aggregate_data_info
get_data_info_fields_documentation
register_data_info_field
dataset
dataset
[dataset]
DataSpecs
Dataset
InMemoryDataset
load_dataset_from_json
split_data
examples
examples
[examples]
load_heart_uci
load_mnist
tensorflow
tensorflow
[tensorflow]
TensorflowDataset
torch
torch
[torch]
PoissonSampler
TorchDataset
collate_with_padding
utils
utils
[utils]
load_data_array
save_data_array
sparse_from_file
sparse_to_file
split_multi_classif_dataset
main
main
[main]
FederatedClient
FederatedServer
config
config
[config]
EvaluateConfig
FLOptimConfig
FLRunConfig
PrivacyConfig
RegisterConfig
TrainingConfig
privacy
privacy
[privacy]
DPTrainingManager
utils
utils
[utils]
AggregationError
Checkpointer
Constraint
ConstraintSet
EarlyStopConfig
EarlyStopping
TimeoutConstraint
TrainingManager
aggregate_clients_data_info
messaging
messaging
[messaging]
CancelTraining
Error
EvaluationReply
EvaluationRequest
GenericMessage
InitReply
InitRequest
Message
MetadataQuery
MetadataReply
PrivacyReply
PrivacyRequest
SerializedMessage
StopTraining
TrainReply
TrainRequest
metrics
metrics
[metrics]
BinaryAccuracyPrecisionRecall
BinaryRocAUC
MeanAbsoluteError
MeanMetric
MeanSquaredError
Metric
MetricSet
MetricState
MulticlassAccuracyPrecisionRecall
RSquared
model
model
[model]
api
api
[api]
Model
Vector
VectorSpec
register_vector_type
haiku
haiku
[haiku]
HaikuModel
JaxNumpyVector
utils
utils
[utils]
select_device
sklearn
sklearn
[sklearn]
NumpyVector
SklearnSGDModel
tensorflow
tensorflow
[tensorflow]
TensorflowModel
TensorflowOptiModule
TensorflowVector
utils
utils
[utils]
add_indexed_slices_support
build_keras_loss
move_layer_to_device
preserve_tensor_device
select_device
torch
torch
[torch]
TorchModel
TorchOptiModule
TorchVector
utils
utils
[utils]
AutoDeviceModule
select_device
optimizer
optimizer
[optimizer]
Optimizer
list_optim_modules
list_optim_regularizers
modules
modules
[modules]
AdaGradModule
AdamModule
AuxVar
EWMAModule
GaussianNoiseModule
L2Clipping
L2GlobalClipping
MomentumModule
NoiseModule
OptiModule
RMSPropModule
ScaffoldAuxVar
ScaffoldClientModule
ScaffoldServerModule
YogiModule
YogiMomentumModule
regularizers
regularizers
[regularizers]
FedProxRegularizer
LassoRegularizer
Regularizer
RidgeRegularizer
quickrun
quickrun
[quickrun]
DataSourceConfig
ExperimentConfig
ModelConfig
parse_data_folder
quickrun
secagg
secagg
[secagg]
list_available_secagg_types
parse_secagg_config_client
parse_secagg_config_server
api
api
[api]
ArraySpec
Decrypter
EncryptedSpecs
Encrypter
SecaggConfigClient
SecaggConfigServer
SecaggSetupQuery
SecureAggregate
joye_libert
joye_libert
[joye_libert]
DEFAULT_BIPRIME
JLSAggregate
JoyeLibertDecrypter
JoyeLibertEncrypter
JoyeLibertSecaggConfigClient
JoyeLibertSecaggConfigServer
decrypt_sum
encrypt
sum_encrypted
messages
masking
masking
[masking]
MaskedAggregate
MaskingDecrypter
MaskingEncrypter
MaskingSecaggConfigClient
MaskingSecaggConfigServer
messages
messaging
shamir
shamir
[shamir]
DEFAULT_SHAMIR_PRIME
generate_secret_shares
recover_shared_secret
utils
utils
[utils]
IdentityKeys
Quantizer
generate_random_biprime
generate_random_prime
get_numpy_uint_dtype
x3dh
x3dh
[x3dh]
X3DHManager
run_x3dh_setup_client
run_x3dh_setup_server
messages
test_utils
test_utils
[test_utils]
GradientsTestCase
MockNetworkClient
MockNetworkServer
assert_batch_equal
assert_dict_equal
assert_json_serializable_dict
assert_list_equal
generate_ssl_certificates
list_available_frameworks
make_importable
setup_client_argparse
setup_server_argparse
to_numpy
typing
utils
utils
[utils]
Aggregate
DevicePolicy
LOGGING_LEVEL_MAJOR
ObjectConfig
TomlConfig
access_registered
access_registration_info
access_types_mapping
add_json_support
create_types_registry
dataclass_from_func
dataclass_from_init
deserialize_numpy
deserialize_object
get_device_policy
get_logger
json_dump
json_load
json_pack
json_unpack
register_type
run_as_processes
serialize_numpy
serialize_object
set_device_policy
version
Developer Guide
Developer Guide
Introduction
Contributions guide
Unit tests and code analysis
Building the documentation
Docstrings style guide
Release Notes
Release Notes
v2.5.0
v2.4.0
v2.3.2
v2.3.1
v2.3.0
v2.2.2
v2.2.1
v2.2.0
v2.1.1
v2.1.0
v2.0.3
v2.0.2
v2.0.1
v2.0.0
Table of contents
declearn.communication.grpc.protobufs.message_pb2
message_pb2
Generated protocol buffer code.