protocol_schemas
Config YAML specification classes related to protocols.
Classes
FederatedAveragingProtocolArgumentsConfig
class FederatedAveragingProtocolArgumentsConfig( aggregator: Optional[AggregatorConfig] = None, steps_between_parameter_updates: Optional[int] = None, epochs_between_parameter_updates: Optional[int] = None, auto_eval: bool = True, secure_aggregation: bool = False,):
Configuration for the FedreatedAveraging Protocol arguments.
Variables
- static
aggregator : Optional[AggregatorConfig]
- static
auto_eval : bool
- static
epochs_between_parameter_updates : Optional[int]
- static
secure_aggregation : bool
- static
steps_between_parameter_updates : Optional[int]
FederatedAveragingProtocolConfig
class FederatedAveragingProtocolConfig( name: str, arguments: Optional[FederatedAveragingProtocolArgumentsConfig] = FederatedAveragingProtocolArgumentsConfig(aggregator=None, steps_between_parameter_updates=None, epochs_between_parameter_updates=None, auto_eval=True, secure_aggregation=False),):
Configuration for the FederatedAveraging Protocol.
Ancestors
GAScreeningProtocolAmethystArgumentsConfig
class GAScreeningProtocolAmethystArgumentsConfig( aggregator: Optional[AggregatorConfig] = None, results_notification_email: Optional[bool] = False, trial_name: Optional[str] = None, rename_columns: Optional[dict[str, str]] = None,):
Configuration for GAScreeningProtocolAmethyst arguments.
Variables
- static
aggregator : Optional[AggregatorConfig]
- static
rename_columns : Optional[dict[str, str]]
- static
results_notification_email : Optional[bool]
- static
trial_name : Optional[str]
GAScreeningProtocolAmethystConfig
class GAScreeningProtocolAmethystConfig( name: str, arguments: Optional[GAScreeningProtocolAmethystArgumentsConfig] = GAScreeningProtocolAmethystArgumentsConfig(aggregator=None, results_notification_email=False, trial_name=None, rename_columns=None),):
Configuration for GAScreeningProtocolAmethyst.
Ancestors
Variables
- static
arguments : Optional[GAScreeningProtocolAmethystArgumentsConfig]
- static
name : str
GAScreeningProtocolBronzeArgumentsConfig
class GAScreeningProtocolBronzeArgumentsConfig( aggregator: Optional[AggregatorConfig] = None, results_notification_email: Optional[bool] = False, trial_name: Optional[str] = None, rename_columns: Optional[dict[str, str]] = None,):
Configuration for GAScreeningProtocolBronze arguments.
Variables
- static
aggregator : Optional[AggregatorConfig]
- static
rename_columns : Optional[dict[str, str]]
- static
results_notification_email : Optional[bool]
- static
trial_name : Optional[str]
GAScreeningProtocolBronzeConfig
class GAScreeningProtocolBronzeConfig( name: str, arguments: Optional[GAScreeningProtocolBronzeArgumentsConfig] = GAScreeningProtocolBronzeArgumentsConfig(aggregator=None, results_notification_email=False, trial_name=None, rename_columns=None),):
Configuration for GAScreeningProtocolBronze.
Ancestors
GAScreeningProtocolJadeArgumentsConfig
class GAScreeningProtocolJadeArgumentsConfig( aggregator: Optional[AggregatorConfig] = None, results_notification_email: Optional[bool] = False, trial_name: Optional[str] = None, rename_columns: Optional[dict[str, str]] = None,):
Configuration for GAScreeningProtocolJade arguments.
Variables
- static
aggregator : Optional[AggregatorConfig]
- static
rename_columns : Optional[dict[str, str]]
- static
results_notification_email : Optional[bool]
- static
trial_name : Optional[str]
GAScreeningProtocolJadeConfig
class GAScreeningProtocolJadeConfig( name: str, arguments: Optional[GAScreeningProtocolJadeArgumentsConfig] = GAScreeningProtocolJadeArgumentsConfig(aggregator=None, results_notification_email=False, trial_name=None, rename_columns=None),):
Configuration for GAScreeningProtocolJade.
Ancestors
GenericProtocolConfig
class GenericProtocolConfig(name: str, arguments: _JSONDict = {}):
Configuration for unspecified protocol plugins.
Raises
ValueError
: if the protocol name starts withbitfount.
Ancestors
InferenceAndCSVReportArgumentsConfig
class InferenceAndCSVReportArgumentsConfig(aggregator: Optional[AggregatorConfig] = None):
Configuration for InferenceAndCSVReport arguments.
Variables
- static
aggregator : Optional[AggregatorConfig]
InferenceAndCSVReportConfig
class InferenceAndCSVReportConfig( name: str, arguments: Optional[InferenceAndCSVReportArgumentsConfig] = InferenceAndCSVReportArgumentsConfig(aggregator=None),):
Configuration for InferenceAndCSVReport.
Ancestors
InferenceAndReturnCSVReportArgumentsConfig
class InferenceAndReturnCSVReportArgumentsConfig( aggregator: Optional[AggregatorConfig] = None,):
Configuration for InferenceAndReturnCSVReport arguments.
Variables
- static
aggregator : Optional[AggregatorConfig]
InferenceAndReturnCSVReportConfig
class InferenceAndReturnCSVReportConfig( name: str, arguments: Optional[InferenceAndReturnCSVReportArgumentsConfig] = InferenceAndReturnCSVReportArgumentsConfig(aggregator=None),):
Configuration for InferenceAndReturnCSVReport.
Ancestors
Variables
- static
arguments : Optional[InferenceAndReturnCSVReportArgumentsConfig]
- static
name : str
InstrumentedInferenceAndCSVReportArgumentsConfig
class InstrumentedInferenceAndCSVReportArgumentsConfig( aggregator: Optional[AggregatorConfig] = None,):
Configuration for InstrumentedInferenceAndCSVReport arguments.
Variables
- static
aggregator : Optional[AggregatorConfig]
InstrumentedInferenceAndCSVReportConfig
class InstrumentedInferenceAndCSVReportConfig( name: str, arguments: Optional[InstrumentedInferenceAndCSVReportArgumentsConfig] = InstrumentedInferenceAndCSVReportArgumentsConfig(aggregator=None),):
Configuration for InstrumentedInferenceAndCSVReport.
Ancestors
Variables
- static
arguments : Optional[InstrumentedInferenceAndCSVReportArgumentsConfig]
- static
name : str
NextGenSearchProtocolArgumentsConfig
class NextGenSearchProtocolArgumentsConfig( rename_columns: Optional[dict[str, str]] = None,):
Configuration for NextGenSearchProtocol arguments.
Variables
- static
rename_columns : Optional[dict[str, str]]
NextGenSearchProtocolConfig
class NextGenSearchProtocolConfig( name: str, arguments: Optional[NextGenSearchProtocolArgumentsConfig] = NextGenSearchProtocolArgumentsConfig(rename_columns=None),):
Configuration for NextGenSearchProtocol.
Ancestors
ProtocolConfig
class ProtocolConfig(name: str, arguments: Optional[Any] = None):
Configuration for the Protocol.
Subclasses
- FederatedAveragingProtocolConfig
- GAScreeningProtocolAmethystConfig
- GAScreeningProtocolBronzeConfig
- GAScreeningProtocolJadeConfig
- GenericProtocolConfig
- InferenceAndCSVReportConfig
- InferenceAndReturnCSVReportConfig
- InstrumentedInferenceAndCSVReportConfig
- NextGenSearchProtocolConfig
- ResultsOnlyProtocolConfig
- RetinalDiseaseProtocolCobaltConfig
ResultsOnlyProtocolArgumentsConfig
class ResultsOnlyProtocolArgumentsConfig( aggregator: Optional[AggregatorConfig] = None, secure_aggregation: bool = False,):
Configuration for the ResultsOnly Protocol arguments.
ResultsOnlyProtocolConfig
class ResultsOnlyProtocolConfig( name: str, arguments: Optional[ResultsOnlyProtocolArgumentsConfig] = ResultsOnlyProtocolArgumentsConfig(aggregator=None, secure_aggregation=False),):
Configuration for the ResultsOnly Protocol.
Ancestors
RetinalDiseaseProtocolCobaltArgumentsConfig
class RetinalDiseaseProtocolCobaltArgumentsConfig( aggregator: Optional[AggregatorConfig] = None,):
Configuration for RetinalDiseaseProtocolCobalt arguments.
Variables
- static
aggregator : Optional[AggregatorConfig]
RetinalDiseaseProtocolCobaltConfig
class RetinalDiseaseProtocolCobaltConfig( name: str, arguments: Optional[RetinalDiseaseProtocolCobaltArgumentsConfig] = RetinalDiseaseProtocolCobaltArgumentsConfig(aggregator=None),):
Configuration for RetinalDiseaseProtocolCobalt.
Ancestors
Variables
- static
arguments : Optional[RetinalDiseaseProtocolCobaltArgumentsConfig]
- static
name : str