compass.pipeline.data_classes#

Data classes used for the COMPASS pipeline

Classes

BaseRequest(out_dir, tech, jurisdiction_fp, *)

Parameter Object base class for pipeline requests

CollectionRequest(out_dir, tech, ...[, ...])

Parameter Object for collection mode

ExtractionRequest(out_dir, tech, ...[, ...])

Parameter Object for extraction mode

JurisdictionResult([jurisdiction, ord_db_fp])

Result Object for one jurisdiction run

KnownSourcesInput([known_local_docs, ...])

Value Object for known documents and URL inputs

OutputSettings(out_dir[, log_dir, ...])

Value Object for filesystem output settings

ProcessRequest(out_dir, tech, jurisdiction_fp, *)

Parameter Object for full process mode

RuntimeSettings([td_kwargs, tpe_kwargs, ...])

Value Object for runtime and execution settings

WebSearchParams([...])

Capture configuration for jurisdiction web searches