xain_fl package

XAIN FL init

Submodules

xain_fl.cli module

Module implementing the networked coordinator using gRPC.

This module implements the Coordinator state machine, the Coordinator gRPC service and helper class to keep state about the Participants.

xain_fl.cli.get_cmd_parameters()

[summary]

Returns

[description]

Return type

[type]

xain_fl.cli.main()

[summary]

xain_fl.cli.type_fraction(value)

[summary]

Parameters

value ([type]) – [description]

Returns

[description]

Return type

[type]

Raises
  • ArgumentTypeError – [description]

  • ArgumentTypeError – [description]

xain_fl.cli.type_min_num_participants_in_round(value)

[summary]

Parameters

value ([type]) – [description]

Returns

[description]

Return type

[type]

Raises
  • ArgumentTypeError – [description]

  • ArgumentTypeError – [description]

xain_fl.cli.type_num_epochs(value)

[summary]

Parameters

value ([type]) – [description]

Returns

[description]

Return type

[type]

Raises
  • ArgumentTypeError – [description]

  • ArgumentTypeError – [description]

xain_fl.cli.type_num_rounds(value)

[summary]

Parameters

value ([type]) – [description]

Returns

[description]

Return type

[type]

Raises
  • ArgumentTypeError – [description]

  • ArgumentTypeError – [description]

xain_fl.logger module

XAIN FL structured logger

xain_fl.logger.get_logger(name, level=20)

Wrap python logger with default configuration of structlog. :type name: str :param name: Identification name. For module name pass name=__name__. :type name: str :type level: int :param level: Threshold for this logger. Defaults to logging.INFO. :type level: int

Return type

BoundLoggerLazyProxy

Returns

Wrapped python logger with default configuration of structlog.

xain_fl.serve module

XAIN FL serving

xain_fl.serve.serve(coordinator, store, host='[::]', port=50051)

Main method to start the gRPC service.

This methods just creates the xain_fl.coordinator.coordinator.Coordinator, sets up all threading events and threads and configures and starts the gRPC service.

Return type

None