veil.config.pipeline¶

Classes

PipelineConfig([mode, datahandler, ...])

Root configuration dataclass for a Veil masking run.

class veil.config.pipeline.PipelineConfig(mode='offline', datahandler=None, api_server=None, entity_detectors=<factory>, entity_resolvers=None, metric_store=<factory>, masker=<factory>, overlap_resolver=<factory>, evaluator=None, concurrency=1, log_level='INFO')[source]¶

Bases: object

Root configuration dataclass for a Veil masking run.

Parameters:

mode (str)
datahandler (DataHandlerConfig | None)
api_server (ApiServerConfig | None)
entity_detectors (List[BaseEntityDetectorConfig])
entity_resolvers (List[BaseEntityResolverConfig] | None)
metric_store (MetricStoreConfig)
masker (MaskerConfig)
overlap_resolver (OverlapResolverConfig)
evaluator (EvaluatorConfig | None)
concurrency (int)
log_level (str)

api_server: ApiServerConfig | None = None¶

concurrency: int = 1¶

classmethod create_from_cli_args()[source]¶: Return one or many PipelineConfig instances based on CLI/YAML combos.

datahandler: DataHandlerConfig | None = None¶

entity_detectors: List[BaseEntityDetectorConfig]¶

entity_resolvers: List[BaseEntityResolverConfig] | None = None¶

evaluator: EvaluatorConfig | None = None¶

log_level: str = 'INFO'¶

masker: MaskerConfig¶

metric_store: MetricStoreConfig¶

mode: str = 'offline'¶

overlap_resolver: OverlapResolverConfig¶