Skip to main content

evaluate

Algorithm to evaluate a model on remote data.

Classes​

ModelEvaluation​

class ModelEvaluation(    *,    model: _DistributedModelTypeOrReference,    pretrained_file: Optional[Union[str, os.PathLike]] = None,    **kwargs: Any,):

Algorithm for evaluating a model and returning metrics.

Arguments

  • model: The model to evaluate on remote data.

Attributes

  • name: The name of the algorithm.
  • model: The model to evaluate on remote data.
note

The metrics cannot currently be specified by the user.

Ancestors​

  • bitfount.federated.algorithms.model_algorithms.base._BaseModelAlgorithmFactory
  • bitfount.federated.algorithms.base._BaseAlgorithmFactory
  • abc.ABC
  • bitfount.federated.roles._RolesMixIn
  • bitfount.types._BaseSerializableObjectMixIn

Methods​

def modeller(    self, **kwargs: Any,) ‑> bitfount.federated.algorithms.model_algorithms.evaluate._ModellerSide:

Returns the modeller side of the ModelEvaluation algorithm.

def worker(    self, hub: BitfountHub, **kwargs: Any,) ‑> bitfount.federated.algorithms.model_algorithms.evaluate._WorkerSide:

Returns the worker side of the ModelEvaluation algorithm.

Arguments

  • hub: BitfountHub object to use for communication with the hub.

Variables​

  • static nested_fields : ClassVar[Dict[str, Mapping[str, Any]]]