Skip to main content

protocol_schemas

Config YAML specification classes related to protocols.

Classes​

DataExtractionProtocolCharcoalArgumentsConfig​

class DataExtractionProtocolCharcoalArgumentsConfig(    trial_name: Optional[str] = None,    patient_ids: Optional[list[str]] = None,    patient_ids_file: Optional[Path] = None,):

Configuration for DataExtractionProtocolCharcoal arguments.

Variables​

  • static patient_ids : Optional[list[str]]
  • static trial_name : Optional[str]

DataExtractionProtocolCharcoalConfig​

class DataExtractionProtocolCharcoalConfig(    name: str, arguments: Optional[DataExtractionProtocolCharcoalArgumentsConfig],):

Configuration for DataExtractionProtocolCharcoal.

Ancestors​

Variables​

  • static name : str

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 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​

Variables​

  • static name : str

FluidVolumeScreeningProtocolArgumentsConfig​

class FluidVolumeScreeningProtocolArgumentsConfig(    aggregator: Optional[AggregatorConfig] = None,    results_notification_email: Optional[bool] = False,    trial_name: Optional[str] = None,    rename_columns: Optional[dict[str, str]] = None,):

Configuration for FluidVolumeScreeningProtocol arguments.

Variables​

  • static rename_columns : Optional[dict[str, str]]
  • static results_notification_email : Optional[bool]
  • static trial_name : Optional[str]

FluidVolumeScreeningProtocolConfig​

class FluidVolumeScreeningProtocolConfig(    name: str,    arguments: Optional[FluidVolumeScreeningProtocolArgumentsConfig] = FluidVolumeScreeningProtocolArgumentsConfig(aggregator=None, results_notification_email=False, trial_name=None, rename_columns=None),):

Configuration for FluidVolumeScreeningProtocol.

Ancestors​

Variables​

  • static name : str

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 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 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 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​

Variables​

  • static name : str

GAScreeningProtocolBronzeWithEHRConfig​

class GAScreeningProtocolBronzeWithEHRConfig(    name: str,    arguments: Optional[GAScreeningProtocolBronzeArgumentsConfig] = GAScreeningProtocolBronzeArgumentsConfig(aggregator=None, results_notification_email=False, trial_name=None, rename_columns=None),):

Configuration for GAScreeningProtocolBronzeWithEHR.

Ancestors​

Variables​

  • static name : str

GAScreeningProtocolCharcoalArgumentsConfig​

class GAScreeningProtocolCharcoalArgumentsConfig(    aggregator: Optional[AggregatorConfig] = None,    results_notification_email: Optional[bool] = False,    trial_name: Optional[str] = None,    rename_columns: Optional[dict[str, str]] = None,):

Configuration for GAScreeningProtocolCharcoal arguments.

Variables​

  • static rename_columns : Optional[dict[str, str]]
  • static results_notification_email : Optional[bool]
  • static trial_name : Optional[str]

GAScreeningProtocolCharcoalConfig​

class GAScreeningProtocolCharcoalConfig(    name: str,    arguments: Optional[GAScreeningProtocolCharcoalArgumentsConfig] = GAScreeningProtocolCharcoalArgumentsConfig(aggregator=None, results_notification_email=False, trial_name=None, rename_columns=None),):

Configuration for GAScreeningProtocolCharcoal.

Ancestors​

Variables​

  • static name : str

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 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​

Variables​

  • static name : str

GenericProtocolConfig​

class GenericProtocolConfig(name: str, arguments: _JSONDict = {}):

Configuration for unspecified protocol plugins.

Raises

  • ValueError: if the protocol name starts with bitfount.

Ancestors​

Variables​

  • static name : str

InSiteInsightsProtocolArgumentsConfig​

class InSiteInsightsProtocolArgumentsConfig(    aggregator: Optional[AggregatorConfig] = None,    results_notification_email: Optional[bool] = False,):

Configuration for InSiteInsightsProtocol arguments.

Variables​

  • static results_notification_email : Optional[bool]

InSiteInsightsProtocolConfig​

class InSiteInsightsProtocolConfig(    name: str,    arguments: Optional[InSiteInsightsProtocolArgumentsConfig] = InSiteInsightsProtocolArgumentsConfig(aggregator=None, results_notification_email=False),):

Configuration for InSiteInsightsProtocol.

Ancestors​

Variables​

  • static name : str

InferenceAndCSVReportArgumentsConfig​

class InferenceAndCSVReportArgumentsConfig(aggregator: Optional[AggregatorConfig] = None):

Configuration for InferenceAndCSVReport arguments.

Variables​

InferenceAndCSVReportConfig​

class InferenceAndCSVReportConfig(    name: str,    arguments: Optional[InferenceAndCSVReportArgumentsConfig] = InferenceAndCSVReportArgumentsConfig(aggregator=None),):

Configuration for InferenceAndCSVReport.

Ancestors​

Variables​

  • static name : str

InferenceAndImageOutputArgumentsConfig​

class InferenceAndImageOutputArgumentsConfig(    aggregator: Optional[AggregatorConfig] = None,    rename_columns: Optional[dict[str, str]] = None,):

Configuration for InferenceAndImageOutput arguments.

Variables​

  • static rename_columns : Optional[dict[str, str]]

InferenceAndImageOutputConfig​

class InferenceAndImageOutputConfig(    name: str,    arguments: Optional[InferenceAndImageOutputArgumentsConfig] = InferenceAndImageOutputArgumentsConfig(aggregator=None, rename_columns=None),):

Configuration for InferenceAndImageOutput.

Ancestors​

Variables​

  • static name : str

InferenceAndReturnCSVReportArgumentsConfig​

class InferenceAndReturnCSVReportArgumentsConfig(    aggregator: Optional[AggregatorConfig] = None,):

Configuration for InferenceAndReturnCSVReport arguments.

Variables​

InferenceAndReturnCSVReportConfig​

class InferenceAndReturnCSVReportConfig(    name: str,    arguments: Optional[InferenceAndReturnCSVReportArgumentsConfig] = InferenceAndReturnCSVReportArgumentsConfig(aggregator=None),):

Configuration for InferenceAndReturnCSVReport.

Ancestors​

Variables​

  • static name : str

InstrumentedInferenceAndCSVReportArgumentsConfig​

class InstrumentedInferenceAndCSVReportArgumentsConfig(    aggregator: Optional[AggregatorConfig] = None,):

Configuration for InstrumentedInferenceAndCSVReport arguments.

Variables​

InstrumentedInferenceAndCSVReportConfig​

class InstrumentedInferenceAndCSVReportConfig(    name: str,    arguments: Optional[InstrumentedInferenceAndCSVReportArgumentsConfig] = InstrumentedInferenceAndCSVReportArgumentsConfig(aggregator=None),):

Configuration for InstrumentedInferenceAndCSVReport.

Ancestors​

Variables​

  • 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​

Variables​

  • static name : str

ProtocolConfig​

class ProtocolConfig(name: str, arguments: Optional[Any] = None):

Configuration for the Protocol.

Subclasses​

Variables​

  • static arguments : Optional[Any]
  • static name : str

ResultsOnlyProtocolArgumentsConfig​

class ResultsOnlyProtocolArgumentsConfig(    aggregator: Optional[AggregatorConfig] = None,    secure_aggregation: bool = False,    save_location: Optional[list[SaveLocation]] = [<SaveLocation.Modeller: 'Modeller'>],    save_path: Optional[Path] = None,):

Configuration for the ResultsOnly Protocol arguments.

Variables​

  • static secure_aggregation : bool

ResultsOnlyProtocolConfig​

class ResultsOnlyProtocolConfig(    name: str,    arguments: Optional[ResultsOnlyProtocolArgumentsConfig] = ResultsOnlyProtocolArgumentsConfig(aggregator=None, secure_aggregation=False, save_location=[<SaveLocation.Modeller: 'Modeller'>], save_path=None),):

Configuration for the ResultsOnly Protocol.

Ancestors​

Variables​

  • static name : str

RetinalDiseaseProtocolCobaltArgumentsConfig​

class RetinalDiseaseProtocolCobaltArgumentsConfig(    aggregator: Optional[AggregatorConfig] = None,):

Configuration for RetinalDiseaseProtocolCobalt arguments.

Variables​

RetinalDiseaseProtocolCobaltConfig​

class RetinalDiseaseProtocolCobaltConfig(    name: str,    arguments: Optional[RetinalDiseaseProtocolCobaltArgumentsConfig] = RetinalDiseaseProtocolCobaltArgumentsConfig(aggregator=None),):

Configuration for RetinalDiseaseProtocolCobalt.

Ancestors​

Variables​

  • static name : str