openfl.interface.interactive_api.experiment.ModelInterface

class openfl.interface.interactive_api.experiment.ModelInterface(model, optimizer, framework_plugin)

Bases: object

Registers model graph and optimizer.

This class is responsible for managing the model and optimizer in a federated learning experiment.

To be serialized and sent to collaborator nodes. This is the place to determine correct framework adapter as they are needed to fill the model graph with trained tensors.

There is no support for several models / optimizers yet.

Class Attributes:

• model – The model to be used in the experiment.

• optimizer – The optimizer to be used in the experiment.

• framework_plugin – The framework plugin to be used in the experiment.

Methods

provide_model	Retrieve model.
provide_optimizer	Retrieve optimizer.

provide_model()

Retrieve model.

Returns:

The model used in the experiment.

provide_optimizer()

Retrieve optimizer.

Returns:

The optimizer used in the experiment.