Index Symbols | _ | A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | W | Z Symbols --config compass-process command line option --no_progress compass-process command line option --verbose compass-process command line option --version compass command line option -c compass-process command line option -np compass-process command line option -v compass-process command line option _ __add__() (LLMTasks method) (LLMUsageCategory method) (ProcessKwargs method) (TechSpec method) __mul__() (LLMTasks method) (LLMUsageCategory method) (ProcessKwargs method) (TechSpec method) A acquire_resources() (CleanedFileWriter method) (FileMover method) (JurisdictionUpdater method) (LLMService method) (OCRPDFLoader method) (OpenAIService method) (OrdDBFileWriter method) (PDFLoader method) (ProcessPoolService method) (Service method) (StoreFileOnDisk method) (TempFileCache method) (TempFileCachePB method) (ThreadedService method) (UsageUpdater method) add() (TimeBoundedUsageTracker method) add_to() (UsageTracker method) addHandler() (LogListener method) AddLocationFilter (class in compass.utilities.logs) all_messages_txt (AsyncDecisionTree property) api (AsyncDecisionTree property) async_call_node() (AsyncDecisionTree method) async_run() (AsyncDecisionTree method) AsyncDecisionTree (class in compass.common.tree) B BaseLLMCaller (class in compass.llm.calling) BaseTextExtractor (class in compass.common.base) C call() (ChatLLMCaller method) (CleanedFileWriter class method) (FileMover class method) (JurisdictionUpdater class method) (LegalTextValidator method) (LLMCaller method) (LLMService method) (OCRPDFLoader class method) (OpenAIService method) (OrdDBFileWriter class method) (PDFLoader class method) (ProcessPoolService class method) (Service class method) (SolarOrdinanceTextCollector method) (SolarPermittedUseDistrictsTextCollector method) (StoreFileOnDisk class method) (StructuredLLMCaller method) (TempFileCache class method) (TempFileCachePB class method) (ThreadedService class method) (UsageUpdater class method) (WindOrdinanceTextCollector method) (WindPermittedUseDistrictsTextCollector method) call_node() (AsyncDecisionTree method) can_process (CleanedFileWriter property) (FileMover property) (JurisdictionUpdater property) (LLMService property) (OCRPDFLoader property) (OpenAIService property) (OrdDBFileWriter property) (PDFLoader property) (ProcessPoolService property) (Service property) (StoreFileOnDisk property) (TempFileCache property) (TempFileCachePB property) (ThreadedService property) (UsageUpdater property) capitalize() (LLMTasks method) (LLMUsageCategory method) casefold() (LLMTasks method) (LLMUsageCategory method) center() (LLMTasks method) (LLMUsageCategory method) CHAT (LLMUsageCategory attribute) chat_llm_caller (AsyncDecisionTree property) ChatLLMCaller (class in compass.llm.calling) check() (DTreeJurisdictionValidator method) (DTreeURLJurisdictionValidator method) (Heuristic method) (JurisdictionValidator method) (JurisdictionWebsiteValidator method) (SolarHeuristic method) (WindHeuristic method) check_chunk() (LegalTextValidator method) (SolarOrdinanceTextCollector method) (SolarPermittedUseDistrictsTextCollector method) (WindOrdinanceTextCollector method) (WindPermittedUseDistrictsTextCollector method) check_for_ordinance_info() (in module compass.extraction.apply) clean_backticks_from_llm_response() (in module compass.utilities.parsing) CleanedFileWriter (class in compass.services.threaded) client_kwargs (OpenAIConfig property) compass module compass command line option --version compass-process command line option --config --no_progress --verbose -c -np -v compass.common module compass.common.base module compass.common.tree module compass.exceptions module compass.extraction module compass.extraction.apply module compass.extraction.date module compass.extraction.features module compass.extraction.ngrams module compass.extraction.solar module compass.extraction.solar.graphs module compass.extraction.solar.ordinance module compass.extraction.solar.parse module compass.extraction.wind module compass.extraction.wind.graphs module compass.extraction.wind.ordinance module compass.extraction.wind.parse module compass.llm module compass.llm.calling module compass.llm.config module compass.pb module compass.scripts module compass.scripts.download module compass.scripts.process module compass.services module compass.services.base module compass.services.cpu module compass.services.openai module compass.services.provider module compass.services.queues module compass.services.threaded module compass.services.usage module compass.utilities module compass.utilities.base module compass.utilities.enums module compass.utilities.finalize module compass.utilities.jurisdictions module compass.utilities.location module compass.utilities.logs module compass.utilities.nt module compass.utilities.parsing module compass.validation module compass.validation.content module compass.validation.graphs module compass.validation.location module compass.warn module compass.web module compass.web.website_crawl module COMPASS_PB (in module compass.pb) COMPASSCrawler (class in compass.web.website_crawl) COMPASSError COMPASSLinkScorer (class in compass.web.website_crawl) COMPASSNotInitializedError COMPASSRuntimeError COMPASSValueError COMPASSWarning compile_run_summary_message() (in module compass.utilities.finalize) contains_district_info (SolarPermittedUseDistrictsTextCollector property) (WindPermittedUseDistrictsTextCollector property) contains_ord_info (SolarOrdinanceTextCollector property) (WindOrdinanceTextCollector property) CONTAINS_ORD_PROMPT (SolarOrdinanceTextCollector attribute) (WindOrdinanceTextCollector attribute) convert_text_to_sentence_ngrams() (in module compass.extraction.ngrams) count() (LLMTasks method) (LLMUsageCategory method) (ProcessKwargs method) (TechSpec method) count_tokens() (in module compass.services.openai) D DATE_EXTRACTION (LLMTasks attribute) (LLMUsageCategory attribute) DateExtractor (class in compass.extraction.date) DECISION_TREE (LLMUsageCategory attribute) DEFAULT (LLMTasks attribute) (LLMUsageCategory attribute) DEFAULT_FEATURE_DESCRIPTIONS (SetbackFeatures attribute) Directories (class in compass.utilities.base) DISTRICT_PROMPT (SolarPermittedUseDistrictsTextCollector attribute) (WindPermittedUseDistrictsTextCollector attribute) doc_infos_to_db() (in module compass.utilities.finalize) DOC_THRESHOLD (in module compass.web.website_crawl) DOCUMENT_CONTENT_VALIDATION (LLMTasks attribute) (LLMUsageCategory attribute) DOCUMENT_JURISDICTION_VALIDATION (LLMTasks attribute) (LLMUsageCategory attribute) DOCUMENT_ORDINANCE_SUMMARY (LLMUsageCategory attribute) DOCUMENT_PERMITTED_USE_CONTENT_VALIDATION (LLMUsageCategory attribute) DOCUMENT_PERMITTED_USE_DISTRICTS_SUMMARY (LLMUsageCategory attribute) download_jurisdiction_ordinance_using_search_engine() (in module compass.scripts.download) download_jurisdiction_ordinances_from_website() (in module compass.scripts.download) download_jurisdiction_ordinances_from_website_compass_crawl() (in module compass.scripts.download) download_known_urls() (in module compass.scripts.download) DTreeJurisdictionValidator (class in compass.validation.location) DTreeURLJurisdictionValidator (class in compass.validation.location) E empty_output() (in module compass.common.base) encode() (LLMTasks method) (LLMUsageCategory method) endswith() (LLMTasks method) (LLMUsageCategory method) ExceptionOnlyFilter (class in compass.utilities.logs) expandtabs() (LLMTasks method) (LLMUsageCategory method) extract_date() (in module compass.extraction.apply) extract_large_wind_energy_system_section() (WindOrdinanceTextExtractor method) extract_ord_year_from_doc_attrs() (in module compass.utilities.parsing) extract_ordinance_text_with_llm() (in module compass.extraction.apply) extract_ordinance_text_with_ngram_validation() (in module compass.extraction.apply) extract_ordinance_values() (in module compass.extraction.apply) extract_permitted_uses() (SolarPermittedUseDistrictsTextExtractor method) (WindPermittedUseDistrictsTextExtractor method) extract_sef_permitted_uses() (SolarPermittedUseDistrictsTextExtractor method) extract_solar_energy_system_section() (SolarOrdinanceTextExtractor method) extract_wes_permitted_uses() (WindPermittedUseDistrictsTextExtractor method) extract_wind_energy_system_section() (WindOrdinanceTextExtractor method) F FEATURE_CLARIFICATIONS (SetbackFeatures attribute) FEATURES_AS_IGNORE (SetbackFeatures attribute) file_loader_kwargs (ProcessKwargs attribute) FileMover (class in compass.services.threaded) filter() (AddLocationFilter method) (ExceptionOnlyFilter method) (LocationFilter method) (NoLocationFilter method) filter_ordinance_docs() (in module compass.scripts.download) find() (LLMTasks method) (LLMUsageCategory method) find_jurisdiction_website() (in module compass.scripts.download) format() (LLMTasks method) (LLMUsageCategory method) format_map() (LLMTasks method) (LLMUsageCategory method) full_county_phrase (Jurisdiction property) full_name (Jurisdiction property) full_name_the_prefixed (Jurisdiction property) full_subdivision_phrase (Jurisdiction property) full_subdivision_phrase_the_prefixed (Jurisdiction property) G get_service_queue() (in module compass.services.queues) GOOD_TECH_ACRONYMS (Heuristic property) (SolarHeuristic attribute) (WindHeuristic attribute) GOOD_TECH_KEYWORDS (Heuristic property) (SolarHeuristic attribute) (WindHeuristic attribute) GOOD_TECH_PHRASES (Heuristic property) (SolarHeuristic attribute) (WindHeuristic attribute) graph (AsyncDecisionTree property) H Heuristic (class in compass.validation.content) heuristic (TechSpec attribute) history (AsyncDecisionTree property) I index() (LLMTasks method) (LLMUsageCategory method) (ProcessKwargs method) (TechSpec method) initialize_service_queue() (in module compass.services.queues) is_legal_text (LegalTextValidator property) IS_UTILITY_SCALE_PROMPT (SolarOrdinanceTextCollector attribute) (WindOrdinanceTextCollector attribute) isalnum() (LLMTasks method) (LLMUsageCategory method) isalpha() (LLMTasks method) (LLMUsageCategory method) isascii() (LLMTasks method) (LLMUsageCategory method) isdecimal() (LLMTasks method) (LLMUsageCategory method) isdigit() (LLMTasks method) (LLMUsageCategory method) isidentifier() (LLMTasks method) (LLMUsageCategory method) islower() (LLMTasks method) (LLMUsageCategory method) isnumeric() (LLMTasks method) (LLMUsageCategory method) isprintable() (LLMTasks method) (LLMUsageCategory method) isspace() (LLMTasks method) (LLMUsageCategory method) istitle() (LLMTasks method) (LLMUsageCategory method) isupper() (LLMTasks method) (LLMUsageCategory method) J join() (LLMTasks method) (LLMUsageCategory method) Jurisdiction (class in compass.utilities.location) JURISDICTION_MAIN_WEBSITE_VALIDATION (LLMTasks attribute) (LLMUsageCategory attribute) jurisdiction_websites() (in module compass.utilities.jurisdictions) JurisdictionUpdater (class in compass.services.threaded) JurisdictionValidator (class in compass.validation.location) JurisdictionWebsiteValidator (class in compass.validation.location) K known_doc_urls (ProcessKwargs attribute) L LARGE_WIND_ENERGY_SYSTEM_SECTION_FILTER_PROMPT (WindOrdinanceTextExtractor attribute) LegalTextValidator (class in compass.validation.content) ljust() (LLMTasks method) (LLMUsageCategory method) LLM_COST_REGISTRY (in module compass.utilities) llm_response_as_json() (in module compass.utilities.parsing) llm_response_does_not_start_with_no() (in module compass.common.base) llm_response_starts_with_no() (in module compass.common.base) llm_response_starts_with_yes() (in module compass.common.base) llm_service (LLMConfig property) (OpenAIConfig property) LLMCaller (class in compass.llm.calling) LLMConfig (class in compass.llm.config) LLMService (class in compass.services.base) LLMTasks (class in compass.utilities.enums) LLMUsageCategory (class in compass.utilities.enums) load_all_jurisdiction_info() (in module compass.utilities.jurisdictions) load_config() (in module compass.utilities.parsing) load_jurisdictions_from_fp() (in module compass.utilities.jurisdictions) LocationFileLog (class in compass.utilities.logs) LocationFilter (class in compass.utilities.logs) LogListener (class in compass.utilities.logs) lower() (LLMTasks method) (LLMUsageCategory method) lstrip() (LLMTasks method) (LLMUsageCategory method) M make_dirs() (Directories method) maketrans() (LLMTasks static method) (LLMUsageCategory static method) MAX_CONCURRENT_JOBS (CleanedFileWriter attribute) (FileMover attribute) (JurisdictionUpdater attribute) (LLMService attribute) (OCRPDFLoader attribute) (OpenAIService attribute) (OrdDBFileWriter attribute) (PDFLoader attribute) (ProcessPoolService attribute) (Service attribute) (StoreFileOnDisk attribute) (TempFileCache attribute) (TempFileCachePB attribute) (ThreadedService attribute) (UsageUpdater attribute) max_num_concurrent_jurisdictions (ProcessKwargs attribute) merge_overlapping_texts() (in module compass.utilities.parsing) messages (AsyncDecisionTree property) META_SCORE_KEY (DTreeJurisdictionValidator attribute) module compass compass.common compass.common.base compass.common.tree compass.exceptions compass.extraction compass.extraction.apply compass.extraction.date compass.extraction.features compass.extraction.ngrams compass.extraction.solar compass.extraction.solar.graphs compass.extraction.solar.ordinance compass.extraction.solar.parse compass.extraction.wind compass.extraction.wind.graphs compass.extraction.wind.ordinance compass.extraction.wind.parse compass.llm compass.llm.calling compass.llm.config compass.pb compass.scripts compass.scripts.download compass.scripts.process compass.services compass.services.base compass.services.cpu compass.services.openai compass.services.provider compass.services.queues compass.services.threaded compass.services.usage compass.utilities compass.utilities.base compass.utilities.enums compass.utilities.finalize compass.utilities.jurisdictions compass.utilities.location compass.utilities.logs compass.utilities.nt compass.utilities.parsing compass.validation compass.validation.content compass.validation.graphs compass.validation.location compass.warn compass.web compass.web.website_crawl N name (CleanedFileWriter property) (FileMover property) (JurisdictionUpdater property) (LLMService property) (OCRPDFLoader property) (OpenAIService property) (OrdDBFileWriter property) (PDFLoader property) (ProcessPoolService property) (Service property) (StoreFileOnDisk property) (TechSpec attribute) (TempFileCache property) (TempFileCachePB property) (ThreadedService property) (UsageUpdater property) NoLocationFilter (class in compass.utilities.logs) NOT_TECH_WORDS (Heuristic property) (SolarHeuristic attribute) (WindHeuristic attribute) num_ordinances_dataframe() (in module compass.utilities.parsing) num_ordinances_in_doc() (in module compass.utilities.parsing) O OCRPDFLoader (class in compass.services.cpu) OpenAIConfig (class in compass.llm.config) OpenAIService (class in compass.services.openai) OrdDBFileWriter (class in compass.services.threaded) ordinance_text (SolarOrdinanceTextCollector property) (WindOrdinanceTextCollector property) ordinance_text_collector (TechSpec attribute) ORDINANCE_TEXT_EXTRACTION (LLMTasks attribute) ordinance_text_extractor (TechSpec attribute) ORDINANCE_VALUE_EXTRACTION (LLMTasks attribute) (LLMUsageCategory attribute) ordinances_bool_index() (in module compass.utilities.parsing) P parse() (DateExtractor method) (StructuredSolarOrdinanceParser method) (StructuredSolarPermittedUseDistrictsParser method) (StructuredWindOrdinanceParser method) (StructuredWindPermittedUseDistrictsParser method) parse_by_chunks() (in module compass.validation.content) parse_from_ind() (ParseChunksWithMemory method) ParseChunksWithMemory (class in compass.validation.content) parsers (SolarOrdinanceTextExtractor property) (SolarPermittedUseDistrictsTextExtractor property) (WindOrdinanceTextExtractor property) (WindPermittedUseDistrictsTextExtractor property) partition() (LLMTasks method) (LLMUsageCategory method) PDFLoader (class in compass.services.cpu) permitted_use_district_text (SolarPermittedUseDistrictsTextCollector property) (WindPermittedUseDistrictsTextCollector property) permitted_use_text_collector (TechSpec attribute) PERMITTED_USE_TEXT_EXTRACTION (LLMTasks attribute) permitted_use_text_extractor (TechSpec attribute) PERMITTED_USE_VALUE_EXTRACTION (LLMTasks attribute) (LLMUsageCategory attribute) PERMITTED_USES_FILTER_PROMPT (SolarPermittedUseDistrictsTextExtractor attribute) (WindPermittedUseDistrictsTextExtractor attribute) ppe_kwargs (ProcessKwargs attribute) process() (CleanedFileWriter method) (FileMover method) (JurisdictionUpdater method) (LLMService method) (OCRPDFLoader method) (OpenAIService method) (OrdDBFileWriter method) (PDFLoader method) (ProcessPoolService method) (Service method) (StoreFileOnDisk method) (TempFileCache method) (TempFileCachePB method) (ThreadedService method) (UsageUpdater method) process_jurisdictions_with_openai() (in module compass.scripts.process) process_using_futures() (CleanedFileWriter method) (FileMover method) (JurisdictionUpdater method) (LLMService method) (OCRPDFLoader method) (OpenAIService method) (OrdDBFileWriter method) (PDFLoader method) (ProcessPoolService method) (Service method) (StoreFileOnDisk method) (TempFileCache method) (TempFileCachePB method) (ThreadedService method) (UsageUpdater method) ProcessKwargs (class in compass.utilities.nt) ProcessPoolService (class in compass.services.cpu) Q QUAL_OUT_COLS (in module compass.utilities.finalize) QUANT_OUT_COLS (in module compass.utilities.finalize) questions (TechSpec attribute) R read_pdf_doc() (in module compass.services.cpu) read_pdf_doc_ocr() (in module compass.services.cpu) release_resources() (CleanedFileWriter method) (FileMover method) (JurisdictionUpdater method) (LLMService method) (OCRPDFLoader method) (OpenAIService method) (OrdDBFileWriter method) (PDFLoader method) (ProcessPoolService method) (Service method) (StoreFileOnDisk method) (TempFileCache method) (TempFileCachePB method) (ThreadedService method) (UsageUpdater method) removeHandler() (LogListener method) removeprefix() (LLMTasks method) (LLMUsageCategory method) removesuffix() (LLMTasks method) (LLMUsageCategory method) replace() (LLMTasks method) (LLMUsageCategory method) rfind() (LLMTasks method) (LLMUsageCategory method) rindex() (LLMTasks method) (LLMUsageCategory method) rjust() (LLMTasks method) (LLMUsageCategory method) rpartition() (LLMTasks method) (LLMUsageCategory method) rsplit() (LLMTasks method) (LLMUsageCategory method) rstrip() (LLMTasks method) (LLMUsageCategory method) run() (AsyncDecisionTree method) (COMPASSCrawler method) (RunningAsyncServices class method) run_async_tree() (in module compass.common.base) run_async_tree_with_bm() (in module compass.common.base) RunningAsyncServices (class in compass.services.provider) S save_db() (in module compass.utilities.finalize) save_run_meta() (in module compass.utilities.finalize) score() (COMPASSLinkScorer method) se_kwargs (WebSearchParams property) SEF_PERMITTED_USES_FILTER_PROMPT (SolarPermittedUseDistrictsTextExtractor attribute) sentence_ngram_containment() (in module compass.extraction.ngrams) Service (class in compass.services.base) SetbackFeatures (class in compass.extraction.features) setup_async_decision_tree() (in module compass.common.base) setup_base_setback_graph() (in module compass.common.base) setup_conditional_max() (in module compass.extraction.wind.graphs) setup_conditional_min() (in module compass.extraction.wind.graphs) setup_graph_correct_document_type() (in module compass.validation.graphs) setup_graph_correct_jurisdiction_from_url() (in module compass.validation.graphs) setup_graph_correct_jurisdiction_type() (in module compass.validation.graphs) setup_graph_extra_restriction() (in module compass.common.base) setup_graph_no_nodes() (in module compass.common.base) setup_graph_permitted_use_districts() (in module compass.common.base) setup_graph_sef_types() (in module compass.extraction.solar.graphs) setup_graph_wes_types() (in module compass.extraction.wind.graphs) setup_multiplier() (in module compass.extraction.solar.graphs) (in module compass.extraction.wind.graphs) setup_participating_owner() (in module compass.common.base) SOLAR_ENERGY_SYSTEM_FILTER_PROMPT (SolarOrdinanceTextExtractor attribute) SolarHeuristic (class in compass.extraction.solar.ordinance) SolarOrdinanceTextCollector (class in compass.extraction.solar.ordinance) SolarOrdinanceTextExtractor (class in compass.extraction.solar.ordinance) SolarPermittedUseDistrictsTextCollector (class in compass.extraction.solar.ordinance) SolarPermittedUseDistrictsTextExtractor (class in compass.extraction.solar.ordinance) split() (LLMTasks method) (LLMUsageCategory method) splitlines() (LLMTasks method) (LLMUsageCategory method) startswith() (LLMTasks method) (LLMUsageCategory method) StoreFileOnDisk (class in compass.services.threaded) strip() (LLMTasks method) (LLMUsageCategory method) structured_ordinance_parser (TechSpec attribute) structured_permitted_use_parser (TechSpec attribute) StructuredLLMCaller (class in compass.llm.calling) StructuredSolarOrdinanceParser (class in compass.extraction.solar.parse) StructuredSolarParser (class in compass.extraction.solar.parse) StructuredSolarPermittedUseDistrictsParser (class in compass.extraction.solar.parse) StructuredWindOrdinanceParser (class in compass.extraction.wind.parse) StructuredWindParser (class in compass.extraction.wind.parse) StructuredWindPermittedUseDistrictsParser (class in compass.extraction.wind.parse) SUPPORTED_CLIENTS (OpenAIConfig attribute) swapcase() (LLMTasks method) (LLMUsageCategory method) SYSTEM_MESSAGE (BaseTextExtractor attribute) (DateExtractor attribute) (DTreeJurisdictionValidator attribute) (DTreeURLJurisdictionValidator attribute) (LegalTextValidator attribute) (SolarOrdinanceTextExtractor attribute) (SolarPermittedUseDistrictsTextExtractor attribute) (WindOrdinanceTextExtractor attribute) (WindPermittedUseDistrictsTextExtractor attribute) T td_kwargs (ProcessKwargs attribute) tear_down_service_queue() (in module compass.services.queues) TechSpec (class in compass.utilities.nt) TempFileCache (class in compass.services.threaded) TempFileCachePB (class in compass.services.threaded) TEXT_FORMATTER (LocationFileLog attribute) text_splitter (LLMConfig property) (OpenAIConfig property) ThreadedService (class in compass.services.threaded) TimeBoundedUsageTracker (class in compass.services.usage) TimedEntry (class in compass.services.usage) title() (LLMTasks method) (LLMUsageCategory method) title_preserving_caps() (in module compass.utilities.base) total (TimeBoundedUsageTracker property) totals (UsageTracker property) tpe_kwargs (ProcessKwargs attribute) translate() (LLMTasks method) (LLMUsageCategory method) tree_name (AsyncDecisionTree property) U UNKNOWN_MODEL_LABEL (UsageTracker attribute) update_from_model() (UsageTracker method) upper() (LLMTasks method) (LLMUsageCategory method) URL_JURISDICTION_VALIDATION (LLMUsageCategory attribute) usage_from_response() (in module compass.services.openai) UsageTracker (class in compass.services.usage) UsageUpdater (class in compass.services.threaded) W WEB_PAGE_CHECK_SYSTEM_MESSAGE (JurisdictionWebsiteValidator attribute) WebSearchParams (class in compass.utilities.base) website_url_keyword_points (TechSpec attribute) WES_PERMITTED_USES_FILTER_PROMPT (WindPermittedUseDistrictsTextExtractor attribute) WIND_ENERGY_SYSTEM_FILTER_PROMPT (WindOrdinanceTextExtractor attribute) WindHeuristic (class in compass.extraction.wind.ordinance) WindOrdinanceTextCollector (class in compass.extraction.wind.ordinance) WindOrdinanceTextExtractor (class in compass.extraction.wind.ordinance) WindPermittedUseDistrictsTextCollector (class in compass.extraction.wind.ordinance) WindPermittedUseDistrictsTextExtractor (class in compass.extraction.wind.ordinance) Z zfill() (LLMTasks method) (LLMUsageCategory method)