openfl.native.native.run_experiment

openfl.native.native.run_experiment(collaborator_dict: dict, override_config: dict | None = None)

Core function that executes the FL Plan.

Parameters:

• collaborator_dict (dict) – A dictionary mapping collaborator names to their federated models. Example: {collaborator_name(str): FederatedModel} This dictionary defines which collaborators will participate in the experiment, as well as a reference to that collaborator’s federated model.

• override_config (dict, optional) – A dictionary of values to override in the plan. Defaults to None. Example: dict {flplan.key : flplan.value} Override any of the plan parameters at runtime using this dictionary. To get a list of the available options, execute fx.get_plan()

Returns:

model – Final Federated model. The model resulting from the federated learning experiment