Skip to main content
Ctrl+K

v0.23.1

  • Home page
  • About
  • Installation
  • Examples
  • CLI reference
    • API reference
    • Validation
    • Development
    • Glossary
  • Home page
  • About
  • Installation
  • Examples
  • CLI reference
  • API reference
  • Validation
  • Development
  • Glossary

Section Navigation

  • compass.common
    • compass.common.base
      • compass.common.base.empty_output
      • compass.common.base.llm_response_does_not_start_with_no
      • compass.common.base.llm_response_starts_with_no
      • compass.common.base.llm_response_starts_with_yes
      • compass.common.base.run_async_tree
      • compass.common.base.run_async_tree_with_bm
      • compass.common.base.setup_async_decision_tree
      • compass.common.base.setup_base_setback_graph
      • compass.common.base.setup_graph_extra_restriction
      • compass.common.base.setup_graph_no_nodes
      • compass.common.base.setup_graph_permitted_use_districts
      • compass.common.base.setup_participating_owner
    • compass.common.tree
      • compass.common.tree.AsyncDecisionTree
  • compass.exceptions
    • compass.exceptions.COMPASSError
    • compass.exceptions.COMPASSFileNotFoundError
    • compass.exceptions.COMPASSNotInitializedError
    • compass.exceptions.COMPASSPluginConfigurationError
    • compass.exceptions.COMPASSRuntimeError
    • compass.exceptions.COMPASSTypeError
    • compass.exceptions.COMPASSValueError
  • compass.extraction
    • compass.extraction.apply
      • compass.extraction.apply.check_for_relevant_text
      • compass.extraction.apply.extract_date
      • compass.extraction.apply.extract_ordinance_values
      • compass.extraction.apply.extract_relevant_text_with_llm
      • compass.extraction.apply.extract_relevant_text_with_ngram_validation
    • compass.extraction.context
      • compass.extraction.context.ExtractionContext
    • compass.extraction.date
      • compass.extraction.date.DateExtractor
    • compass.extraction.features
      • compass.extraction.features.SetbackFeatures
    • compass.extraction.geothermal_electricity
    • compass.extraction.ghp
    • compass.extraction.rmp
    • compass.extraction.small_wind
      • compass.extraction.small_wind.graphs
        • compass.extraction.small_wind.graphs.setup_conditional_max
        • compass.extraction.small_wind.graphs.setup_conditional_min
        • compass.extraction.small_wind.graphs.setup_graph_wes_types
        • compass.extraction.small_wind.graphs.setup_multiplier
      • compass.extraction.small_wind.ordinance
        • compass.extraction.small_wind.ordinance.SmallWindHeuristic
        • compass.extraction.small_wind.ordinance.SmallWindOrdinanceTextCollector
        • compass.extraction.small_wind.ordinance.SmallWindOrdinanceTextExtractor
        • compass.extraction.small_wind.ordinance.SmallWindPermittedUseDistrictsTextCollector
        • compass.extraction.small_wind.ordinance.SmallWindPermittedUseDistrictsTextExtractor
      • compass.extraction.small_wind.parse
        • compass.extraction.small_wind.parse.SmallWindSetbackFeatures
        • compass.extraction.small_wind.parse.StructuredSmallWindOrdinanceParser
        • compass.extraction.small_wind.parse.StructuredSmallWindParser
        • compass.extraction.small_wind.parse.StructuredSmallWindPermittedUseDistrictsParser
      • compass.extraction.small_wind.plugin
        • compass.extraction.small_wind.plugin.COMPASSSmallWindExtractor
    • compass.extraction.solar
      • compass.extraction.solar.graphs
        • compass.extraction.solar.graphs.setup_graph_sef_types
        • compass.extraction.solar.graphs.setup_multiplier
      • compass.extraction.solar.ordinance
        • compass.extraction.solar.ordinance.SolarHeuristic
        • compass.extraction.solar.ordinance.SolarOrdinanceTextCollector
        • compass.extraction.solar.ordinance.SolarOrdinanceTextExtractor
        • compass.extraction.solar.ordinance.SolarPermittedUseDistrictsTextCollector
        • compass.extraction.solar.ordinance.SolarPermittedUseDistrictsTextExtractor
      • compass.extraction.solar.parse
        • compass.extraction.solar.parse.StructuredSolarOrdinanceParser
        • compass.extraction.solar.parse.StructuredSolarParser
        • compass.extraction.solar.parse.StructuredSolarPermittedUseDistrictsParser
      • compass.extraction.solar.plugin
        • compass.extraction.solar.plugin.COMPASSSolarExtractor
    • compass.extraction.water
      • compass.extraction.water.graphs
        • compass.extraction.water.graphs.setup_graph_contingency
        • compass.extraction.water.graphs.setup_graph_drought
        • compass.extraction.water.graphs.setup_graph_external_transfer
        • compass.extraction.water.graphs.setup_graph_extraction
        • compass.extraction.water.graphs.setup_graph_geothermal
        • compass.extraction.water.graphs.setup_graph_limits
        • compass.extraction.water.graphs.setup_graph_metering_device
        • compass.extraction.water.graphs.setup_graph_oil_and_gas
        • compass.extraction.water.graphs.setup_graph_permits
        • compass.extraction.water.graphs.setup_graph_plugging_reqs
        • compass.extraction.water.graphs.setup_graph_production_cost
        • compass.extraction.water.graphs.setup_graph_production_reporting
        • compass.extraction.water.graphs.setup_graph_redrilling
        • compass.extraction.water.graphs.setup_graph_setback_features
        • compass.extraction.water.graphs.setup_graph_time
        • compass.extraction.water.graphs.setup_graph_well_spacing
      • compass.extraction.water.parse
        • compass.extraction.water.parse.StructuredWaterParser
      • compass.extraction.water.plugin
        • compass.extraction.water.plugin.TexasWaterRightsExtractor
        • compass.extraction.water.plugin.WaterRightsHeuristic
    • compass.extraction.wind
      • compass.extraction.wind.graphs
        • compass.extraction.wind.graphs.setup_conditional_max
        • compass.extraction.wind.graphs.setup_conditional_min
        • compass.extraction.wind.graphs.setup_graph_wes_types
        • compass.extraction.wind.graphs.setup_multiplier
      • compass.extraction.wind.ordinance
        • compass.extraction.wind.ordinance.WindHeuristic
        • compass.extraction.wind.ordinance.WindOrdinanceTextCollector
        • compass.extraction.wind.ordinance.WindOrdinanceTextExtractor
        • compass.extraction.wind.ordinance.WindPermittedUseDistrictsTextCollector
        • compass.extraction.wind.ordinance.WindPermittedUseDistrictsTextExtractor
      • compass.extraction.wind.parse
        • compass.extraction.wind.parse.StructuredWindOrdinanceParser
        • compass.extraction.wind.parse.StructuredWindParser
        • compass.extraction.wind.parse.StructuredWindPermittedUseDistrictsParser
      • compass.extraction.wind.plugin
        • compass.extraction.wind.plugin.COMPASSWindExtractor
  • compass.llm
    • compass.llm.calling
      • compass.llm.calling.BaseLLMCaller
      • compass.llm.calling.ChatLLMCaller
      • compass.llm.calling.JSONFromTextLLMCaller
      • compass.llm.calling.LLMCaller
      • compass.llm.calling.SchemaOutputLLMCaller
    • compass.llm.config
      • compass.llm.config.LLMConfig
      • compass.llm.config.OpenAIConfig
  • compass.pb
    • compass.pb.COMPASS_PB
  • compass.pipeline
    • compass.pipeline.collection
      • compass.pipeline.collection.base
        • compass.pipeline.collection.base.DocumentCollection
      • compass.pipeline.collection.dedupe
        • compass.pipeline.collection.dedupe.DocumentDeDuplicator
      • compass.pipeline.collection.persistence
        • compass.pipeline.collection.persistence.build_collection_manifest
        • compass.pipeline.collection.persistence.load_collected_docs
        • compass.pipeline.collection.persistence.load_collection_manifest
        • compass.pipeline.collection.persistence.load_specific_collection_manifest_shard
        • compass.pipeline.collection.persistence.persist_documents
        • compass.pipeline.collection.persistence.write_collection_manifest
        • compass.pipeline.collection.persistence.write_collection_manifest_shard
      • compass.pipeline.collection.steps
        • compass.pipeline.collection.steps.CollectionStep
        • compass.pipeline.collection.steps.CompassWebsiteCrawlStep
        • compass.pipeline.collection.steps.ElmWebsiteCrawlStep
        • compass.pipeline.collection.steps.KnownLocalDocumentsStep
        • compass.pipeline.collection.steps.KnownUrlDocumentsStep
        • compass.pipeline.collection.steps.SearchEngineDocumentsStep
    • compass.pipeline.coordinator
      • compass.pipeline.coordinator.run_compass
      • compass.pipeline.coordinator.BaseRunMode
      • compass.pipeline.coordinator.COMPASSCollection
      • compass.pipeline.coordinator.COMPASSExtraction
      • compass.pipeline.coordinator.COMPASSFullProcessing
    • compass.pipeline.data_classes
      • compass.pipeline.data_classes.BaseRequest
      • compass.pipeline.data_classes.CollectionRequest
      • compass.pipeline.data_classes.DocParsingParams
      • compass.pipeline.data_classes.ExtractionRequest
      • compass.pipeline.data_classes.JurisdictionResult
      • compass.pipeline.data_classes.KnownSourcesInput
      • compass.pipeline.data_classes.OutputSettings
      • compass.pipeline.data_classes.ProcessRequest
      • compass.pipeline.data_classes.RuntimeSettings
      • compass.pipeline.data_classes.WebSearchParams
    • compass.pipeline.extraction
      • compass.pipeline.extraction.DocumentExtraction
    • compass.pipeline.jurisdiction
      • compass.pipeline.jurisdiction.SingleJurisdictionRun
    • compass.pipeline.runtime
      • compass.pipeline.runtime.PipelineRuntime
  • compass.plugin
    • compass.plugin.base
      • compass.plugin.base.BaseExtractionPlugin
    • compass.plugin.interface
      • compass.plugin.interface.BaseHeuristic
      • compass.plugin.interface.BaseTextCollector
      • compass.plugin.interface.FilteredExtractionPlugin
      • compass.plugin.interface.OutputColumn
    • compass.plugin.noop
      • compass.plugin.noop.NoOpHeuristic
      • compass.plugin.noop.NoOpTextCollector
      • compass.plugin.noop.NoOpTextExtractor
    • compass.plugin.one_shot
      • compass.plugin.one_shot.base
        • compass.plugin.one_shot.base.create_schema_based_one_shot_extraction_plugin
      • compass.plugin.one_shot.cache
      • compass.plugin.one_shot.components
        • compass.plugin.one_shot.components.SchemaBasedTextCollector
        • compass.plugin.one_shot.components.SchemaBasedTextExtractor
        • compass.plugin.one_shot.components.SchemaOrdinanceParser
      • compass.plugin.one_shot.generators
        • compass.plugin.one_shot.generators.generate_heuristic_keywords
        • compass.plugin.one_shot.generators.generate_query_templates
        • compass.plugin.one_shot.generators.generate_website_keywords
    • compass.plugin.ordinance
      • compass.plugin.ordinance.BaseParser
      • compass.plugin.ordinance.BaseTextExtractor
      • compass.plugin.ordinance.DocSelectionMethod
      • compass.plugin.ordinance.KeywordBasedHeuristic
      • compass.plugin.ordinance.OrdinanceExtractionPlugin
      • compass.plugin.ordinance.OrdinanceParser
      • compass.plugin.ordinance.PromptBasedTextCollector
      • compass.plugin.ordinance.PromptBasedTextExtractor
    • compass.plugin.post_processing
      • compass.plugin.post_processing.POST_PROCESSING_REGISTRY
      • compass.plugin.post_processing.add_document_name
    • compass.plugin.registry
      • compass.plugin.registry.PLUGIN_REGISTRY
      • compass.plugin.registry.register_plugin
      • compass.plugin.registry.resolve_plugin
  • compass.scripts
    • compass.scripts.download
      • compass.scripts.download.download_jurisdiction_ordinance_using_search_engine
      • compass.scripts.download.download_jurisdiction_ordinances_from_website
      • compass.scripts.download.download_jurisdiction_ordinances_from_website_compass_crawl
      • compass.scripts.download.download_known_urls
      • compass.scripts.download.filter_ordinance_docs
      • compass.scripts.download.find_jurisdiction_website
      • compass.scripts.download.load_known_docs
    • compass.scripts.search
      • compass.scripts.search.run_search
      • compass.scripts.search.summary
      • compass.scripts.search.write_search_report
  • compass.services
    • compass.services.base
      • compass.services.base.LLMService
      • compass.services.base.Service
    • compass.services.cpu
      • compass.services.cpu.read_docling_local_file
      • compass.services.cpu.read_docling_web_file
      • compass.services.cpu.read_pdf_doc
      • compass.services.cpu.read_pdf_doc_ocr
      • compass.services.cpu.read_pdf_file
      • compass.services.cpu.read_pdf_file_ocr
      • compass.services.cpu.FileLoader
      • compass.services.cpu.OCRPDFLoader
      • compass.services.cpu.ProcessPoolService
    • compass.services.openai
      • compass.services.openai.count_tokens
      • compass.services.openai.usage_from_response
      • compass.services.openai.OpenAIService
    • compass.services.provider
      • compass.services.provider.RunningAsyncServices
    • compass.services.queues
      • compass.services.queues.get_service_queue
      • compass.services.queues.initialize_service_queue
      • compass.services.queues.tear_down_service_queue
    • compass.services.threaded
      • compass.services.threaded.read_html_file
      • compass.services.threaded.CleanedFileWriter
      • compass.services.threaded.FileMover
      • compass.services.threaded.GenericFuncRunner
      • compass.services.threaded.HTMLFileLoader
      • compass.services.threaded.JurisdictionUpdater
      • compass.services.threaded.OrdDBFileWriter
      • compass.services.threaded.ParsedFileWriter
      • compass.services.threaded.StoreFileOnDisk
      • compass.services.threaded.TempFileCache
      • compass.services.threaded.TempFileCacheCopier
      • compass.services.threaded.TempFileCachePB
      • compass.services.threaded.ThreadedService
      • compass.services.threaded.UsageUpdater
    • compass.services.usage
      • compass.services.usage.TimeBoundedUsageTracker
      • compass.services.usage.TimedEntry
      • compass.services.usage.UsageTracker
  • compass.utilities
    • compass.utilities.base
      • compass.utilities.base.title_preserving_caps
      • compass.utilities.base.Directories
    • compass.utilities.costs
      • compass.utilities.costs.LLM_COST_REGISTRY
      • compass.utilities.costs.compute_cost_from_totals
      • compass.utilities.costs.compute_total_cost_and_token_from_totals
      • compass.utilities.costs.compute_total_cost_from_usage
      • compass.utilities.costs.compute_total_tokens_from_totals
      • compass.utilities.costs.cost_for_model
    • compass.utilities.enums
      • compass.utilities.enums.COMPASSDocumentCollectionStep
      • compass.utilities.enums.COMPASSRunMode
      • compass.utilities.enums.CaseInsensitiveEnum
      • compass.utilities.enums.LLMTasks
      • compass.utilities.enums.LLMUsageCategory
    • compass.utilities.finalize
      • compass.utilities.finalize.compile_collection_summary_message
      • compass.utilities.finalize.compile_run_summary_message
      • compass.utilities.finalize.doc_infos_to_db
      • compass.utilities.finalize.save_db
      • compass.utilities.finalize.save_run_meta
    • compass.utilities.io
      • compass.utilities.io.ConfigType
      • compass.utilities.io.load_config
      • compass.utilities.io.resolve_all_paths
      • compass.utilities.io.resolve_path
      • compass.utilities.io.ConfigType
      • compass.utilities.io.Handler
      • compass.utilities.io.JSON5Handler
      • compass.utilities.io.JSONHandler
      • compass.utilities.io.TOMLHandler
      • compass.utilities.io.YAMLHandler
    • compass.utilities.jurisdictions
      • compass.utilities.jurisdictions.jurisdiction_websites
      • compass.utilities.jurisdictions.jurisdictions_from_df
      • compass.utilities.jurisdictions.load_all_jurisdiction_info
      • compass.utilities.jurisdictions.load_jurisdictions_from_fp
      • compass.utilities.jurisdictions.load_jurisdictions_from_subdivision_names
      • compass.utilities.jurisdictions.Jurisdiction
    • compass.utilities.logs
      • compass.utilities.logs.log_versions
      • compass.utilities.logs.AddLocationFilter
      • compass.utilities.logs.ExceptionOnlyFilter
      • compass.utilities.logs.LQ
      • compass.utilities.logs.LocationFileLog
      • compass.utilities.logs.LocationFilter
      • compass.utilities.logs.LogListener
      • compass.utilities.logs.NoLocationFilter
    • compass.utilities.ngrams
      • compass.utilities.ngrams.convert_text_to_sentence_ngrams
      • compass.utilities.ngrams.sentence_ngram_containment
    • compass.utilities.parsing
      • compass.utilities.parsing.clean_backticks_from_llm_response
      • compass.utilities.parsing.extract_year_from_doc_attrs
      • compass.utilities.parsing.is_pdf_doc
      • compass.utilities.parsing.llm_response_as_json
      • compass.utilities.parsing.merge_overlapping_texts
      • compass.utilities.parsing.num_ordinances_dataframe
      • compass.utilities.parsing.ordinances_bool_index
    • compass.utilities.url
      • compass.utilities.url.base_website_url
      • compass.utilities.url.normalize_domain
      • compass.utilities.url.sanitize_url
  • compass.validation
    • compass.validation.content
      • compass.validation.content.parse_by_chunks
      • compass.validation.content.Heuristic
      • compass.validation.content.LegalTextValidator
      • compass.validation.content.ParseChunksWithMemory
      • compass.validation.content.TextKindValidator
    • compass.validation.graphs
      • compass.validation.graphs.setup_graph_correct_document_type
      • compass.validation.graphs.setup_graph_correct_jurisdiction_from_url
      • compass.validation.graphs.setup_graph_correct_jurisdiction_type
    • compass.validation.location
      • compass.validation.location.DTreeJurisdictionValidator
      • compass.validation.location.DTreeURLJurisdictionValidator
      • compass.validation.location.JurisdictionValidator
      • compass.validation.location.JurisdictionWebsiteValidator
    • compass.validation.utilities
      • compass.validation.utilities.step_based_threshold
  • compass.warn
    • compass.warn.COMPASSPluginConfigurationWarning
    • compass.warn.COMPASSWarning
  • compass.web
    • compass.web.file_loader
      • compass.web.file_loader.AsyncDoclingWebFileLoader
      • compass.web.file_loader.AsyncLocalDoclingFileLoader
    • compass.web.search
      • compass.web.search.search_single_jurisdiction
    • compass.web.website_crawl
      • compass.web.website_crawl.DOC_THRESHOLD
      • compass.web.website_crawl.COMPASSCrawler
      • compass.web.website_crawl.COMPASSLinkScorer
  • compass
  • compass.warn

compass.warn#

Custom Warnings for COMPASS

Exceptions

COMPASSPluginConfigurationWarning(*args, ...)

Warning for issues with plugin configuration

COMPASSWarning(*args, **kwargs)

Generic COMPASS Warning

previous

compass.validation.utilities.step_based_threshold

next

compass.warn.COMPASSPluginConfigurationWarning

© Copyright 2025, Alliance for Sustainable Energy, LLC.

Created using Sphinx 9.1.0.

Built with the PyData Sphinx Theme 0.17.1.