Source code for florist.api.clients.common

"""Common functions and definitions for clients."""

from enum import Enum
from typing import List

from fl4health.clients.basic_client import BasicClient

from florist.api.clients.mnist import MnistClient



[docs]
class Client(Enum):
    """Enumeration of supported clients."""

    MNIST = "MNIST"


[docs]
    @classmethod
    def class_for_client(cls, client: "Client") -> type[BasicClient]:
        """
        Return the class for a given client.

        :param client: (Client) The client enumeration object.
        :return: (type[BasicClient]) A subclass of BasicClient corresponding to the given client.
        :raises ValueError: if the client is not supported.
        """
        if client == Client.MNIST:
            return MnistClient

        raise ValueError(f"Client {client.value} not supported.")



[docs]
    @classmethod
    def list(cls) -> List[str]:
        """
        List all the supported clients.

        :return: (List[str]) a list of supported clients.
        """
        return [client.value for client in Client]