Election Forecasting

Contents:

  • Installation
    • Requirements
    • From PyPI
    • From Source
    • Development Installation
    • Verify Installation
    • Docker Installation
  • Quick Start Guide
    • Running All Models
    • Custom Forecast Dates
    • Individual Commands
      • Run Forecasts
      • Compare Models
      • Generate Plots
    • Using Models Programmatically
    • Understanding the Output
      • Predictions Directory
      • Metrics Directory
      • Plots Directory
  • Forecasting Models
    • Model Overview
    • 1. Poll Average Model
    • 2. Kalman Diffusion Model
    • 3. Improved Kalman Model
    • 4. Hierarchical Bayes Model (Best)
    • Adding New Models
  • API Reference
    • Models
      • Base Model
        • ElectionForecastModel
      • Poll Average Model
        • PollAverageModel
      • Kalman Diffusion Model
        • KalmanDiffusionModel
      • Improved Kalman Model
        • ImprovedKalmanModel
      • Hierarchical Bayes Model
        • HierarchicalBayesModel
    • Utilities
      • Data Utilities
        • set_election_config()
        • get_election_date()
        • get_current_election_date()
        • load_polling_data()
        • load_election_results()
        • load_fundamentals()
        • get_state_list()
        • compute_metrics()
    • Scripts
      • Run All Models
        • discover_models()
        • generate_forecast_dates()
        • main()
      • Compare Models
        • parse_metrics()
        • main()
      • Generate Plots
        • discover_models()
        • main()
      • Run All Pipeline
        • run_with_temp_argv()
        • run_step()
        • main()
  • Development Guide
    • Setting Up Development Environment
    • Running Tests
    • Code Quality
      • Linting
      • Quality Check
    • Building Documentation
    • Building Distribution Packages
      • Profiling
    • Parallel Execution
    • Docker Development
Election Forecasting
  • Search

© Copyright 2025.

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