elm
  • Home page
  • Installation
  • Examples
    • The Energy Wizard
      • Downloading and Embedding PDFs
      • Running the Streamlit App
    • Ordinance GPT
      • Prerequisites
      • Running from Python
      • Running from the Command Line Utility
        • Execution
        • Debugging
      • Source Ordinance Documents
      • Extension to Other Technologies
  • Development
    • OrdinanceGPT: Architectural Design Document
      • 1. Introduction
        • 1.1 Purpose
        • 1.2 Audience
        • 1.3 Scope
      • 2. High-Level Architecture
        • 2.1 System Context
      • 3. Detailed Design
        • 3.1 Web Scraper
        • 3.2 Document Parser
      • 4 Key Concepts and Classes
        • 4.1 Key Concept: Services
        • 4.2 Key Classes
      • 5. Workflows
        • 5.1 Downloading documents from Google
        • 5.2 Querying OpenAI
      • 6. Appendix
        • 6.1 Tools and Libraries
      • 7. Deliverables
  • API reference
    • elm.base
      • elm.base.ApiBase
        • ApiBase
      • elm.base.ApiQueue
        • ApiQueue
    • elm.chunk
      • elm.chunk.Chunker
        • Chunker
    • elm.cli
    • elm.embed
      • elm.embed.ChunkAndEmbed
        • ChunkAndEmbed
    • elm.exceptions
      • elm.exceptions.ELMError
        • ELMError
      • elm.exceptions.ELMInputError
        • ELMInputError
      • elm.exceptions.ELMKeyError
        • ELMKeyError
      • elm.exceptions.ELMRuntimeError
        • ELMRuntimeError
    • elm.ords
      • elm.ords.download
        • elm.ords.download.download_county_ordinance
      • elm.ords.extraction
        • elm.ords.extraction.apply
        • elm.ords.extraction.date
        • elm.ords.extraction.features
        • elm.ords.extraction.graphs
        • elm.ords.extraction.ngrams
        • elm.ords.extraction.ordinance
        • elm.ords.extraction.parse
        • elm.ords.extraction.tree
      • elm.ords.llm
        • elm.ords.llm.calling
      • elm.ords.process
        • elm.ords.process.process_counties_with_openai
        • elm.ords.process.process_county
        • elm.ords.process.process_county_with_logging
      • elm.ords.services
        • elm.ords.services.base
        • elm.ords.services.cpu
        • elm.ords.services.openai
        • elm.ords.services.provider
        • elm.ords.services.queues
        • elm.ords.services.threaded
        • elm.ords.services.usage
      • elm.ords.utilities
        • elm.ords.utilities.counties
        • elm.ords.utilities.exceptions
        • elm.ords.utilities.location
        • elm.ords.utilities.parsing
        • elm.ords.utilities.queued_logging
      • elm.ords.validation
        • elm.ords.validation.content
        • elm.ords.validation.location
    • elm.pdf
      • elm.pdf.PDFtoTXT
        • PDFtoTXT
    • elm.summary
      • elm.summary.Summary
        • Summary
    • elm.tree
      • elm.tree.DecisionTree
        • DecisionTree
    • elm.utilities
      • elm.utilities.parse
        • elm.utilities.parse.clean_headers
        • elm.utilities.parse.combine_pages
        • elm.utilities.parse.format_html_tables
        • elm.utilities.parse.html_to_text
        • elm.utilities.parse.is_multi_col
        • elm.utilities.parse.read_pdf
        • elm.utilities.parse.read_pdf_ocr
        • elm.utilities.parse.remove_blank_pages
        • elm.utilities.parse.remove_empty_lines_or_page_footers
        • elm.utilities.parse.replace_common_pdf_conversion_chars
        • elm.utilities.parse.replace_excessive_newlines
        • elm.utilities.parse.replace_multi_dot_lines
      • elm.utilities.retry
        • elm.utilities.retry.async_retry_with_exponential_backoff
        • elm.utilities.retry.retry_with_exponential_backoff
      • elm.utilities.try_import
        • elm.utilities.try_import.try_import
      • elm.utilities.validation
        • elm.utilities.validation.validate_azure_api_params
    • elm.version
    • elm.web
      • elm.web.document
        • elm.web.document.BaseDocument
        • elm.web.document.HTMLDocument
        • elm.web.document.PDFDocument
      • elm.web.file_loader
        • elm.web.file_loader.AsyncFileLoader
      • elm.web.html_pw
        • elm.web.html_pw.load_html_with_pw
      • elm.web.osti
        • elm.web.osti.OstiList
        • elm.web.osti.OstiRecord
      • elm.web.rhub
        • elm.web.rhub.ProfilesList
        • elm.web.rhub.ProfilesRecord
        • elm.web.rhub.PublicationsList
        • elm.web.rhub.PublicationsRecord
      • elm.web.search
        • elm.web.search.base
        • elm.web.search.bing
        • elm.web.search.duckduckgo
        • elm.web.search.dux
        • elm.web.search.google
        • elm.web.search.run
        • elm.web.search.tavily
        • elm.web.search.yahoo
      • elm.web.utilities
        • elm.web.utilities.DEFAULT_HEADERS
        • elm.web.utilities.clean_search_query
        • elm.web.utilities.compute_fn_from_url
        • elm.web.utilities.filter_documents
        • elm.web.utilities.get_redirected_url
        • elm.web.utilities.pw_page
        • elm.web.utilities.write_url_doc_to_file
        • elm.web.utilities.PWKwargs
    • elm.wizard
      • elm.wizard.EnergyWizard
        • EnergyWizard
      • elm.wizard.EnergyWizardBase
        • EnergyWizardBase
      • elm.wizard.EnergyWizardPostgres
        • EnergyWizardPostgres
  • CLI reference
    • elm
      • ords
elm
  • Examples
  • Edit on GitHub

Examples

  • The Energy Wizard
    • Downloading and Embedding PDFs
    • Running the Streamlit App
  • Ordinance GPT
    • Prerequisites
    • Running from Python
    • Running from the Command Line Utility
      • Execution
      • Debugging
    • Source Ordinance Documents
    • Extension to Other Technologies
Previous Next

© Copyright 2023, Alliance for Sustainable Energy, LLC.

Built with Sphinx using a theme provided by Read the Docs.