types

Useful types for Federated Learning.

Classes

AggregatorType

class AggregatorType(    value, names=None, *, module=None, qualname=None, type=None, start=1,):

Available aggregator names from bitfount.federated.aggregator.

Ancestors

• enum.Enum

Variables

• static Aggregator

• static SecureAggregator

AlgorithmType

class AlgorithmType(value, names=None, *, module=None, qualname=None, type=None, start=1):

Available algorithm names from bitfount.federated.algorithm.

Ancestors

• enum.Enum

Variables

• static CSVReportAlgorithm

• static CSVReportGeneratorAlgorithm

• static CSVReportGeneratorOphthalmologyAlgorithm

• static ETDRSAlgorithm

• static FederatedModelTraining

• static FoveaCoordinatesAlgorithm

• static GATrialCalculationAlgorithm

• static GATrialCalculationAlgorithmJade

• static GATrialPDFGeneratorAlgorithm

• static GATrialPDFGeneratorAlgorithmAmethyst

• static GATrialPDFGeneratorAlgorithmJade

• static HuggingFaceImageClassificationInference

• static HuggingFaceImageSegmentationInference

• static HuggingFacePerplexityEvaluation

• static HuggingFaceTextClassificationInference

• static HuggingFaceTextGenerationInference

• static HuggingFaceZeroShotImageClassificationInference

• static ModelEvaluation

• static ModelInference

• static ModelTrainingAndEvaluation

• static PrivateSqlQuery

• static SqlQuery

• static TIMMFineTuning

• static TIMMInference

• static TrialInclusionCriteriaMatchAlgorithm

• static TrialInclusionCriteriaMatchAlgorithmAmethyst

• static TrialInclusionCriteriaMatchAlgorithmBronze

• static TrialInclusionCriteriaMatchAlgorithmJade

HuggingFaceImageClassificationInferenceDictionary

class HuggingFaceImageClassificationInferenceDictionary(*args, **kwargs):

Hugging Face dictionary response for image classification.

Ancestors

• builtins.dict

Variables

• static image_classification : str

ProtocolType

class ProtocolType(value, names=None, *, module=None, qualname=None, type=None, start=1):

Available protocol names from bitfount.federated.protocol.

Ancestors

• enum.Enum

Variables

• static BasicOCTProtocol

• static Conversation

• static FederatedAveraging

• static GAScreeningProtocol

• static GAScreeningProtocolAmethyst

• static GAScreeningProtocolJade

• static GAScreeningProtocolBronze

• static InferenceAndCSVReport

• static InferenceAndReturnCSVReport

• static InstrumentedInferenceAndCSVReport

• static ResultsOnly

• static RetinalDiseaseProtocolCobalt

SerializedAggregator

class SerializedAggregator(*args, **kwargs):

Serialized representation of an aggregator.

Ancestors

• builtins.dict

Variables

• static class_name : str

SerializedAlgorithm

class SerializedAlgorithm(*args, **kwargs):

Serialized representation of an algorithm.

Ancestors

• builtins.dict

Variables

• static class_name : str

• static model : typing_extensions.NotRequired[SerializedModel]

SerializedModel

class SerializedModel(*args, **kwargs):

Serialized representation of a model.

Ancestors

• builtins.dict

Variables

• static class_name : str

• static hub : NotRequired[Optional[BitfountHub]]

• static schema : NotRequired[_StrAnyDict]

SerializedProtocol

class SerializedProtocol(*args, **kwargs):

Serialized representation of a protocol.

Ancestors

• builtins.dict

Variables

• static aggregator : typing_extensions.NotRequired[SerializedAggregator]

• static algorithm : Union[SerializedAlgorithm, list[SerializedAlgorithm]]

• static class_name : str

TextGenerationDictionary

class TextGenerationDictionary(*args, **kwargs):

Hugging Face dictionary response for text generation.

Ancestors

• builtins.dict

Variables

• static generated_text : str

---