Skip to content

API overview

The project intentionally keeps its public surface small enough to inspect.

Data-generating processes

Import from causal_econometrics.dgp.

Area Primary API
Regional panels simulate_regional_panel
Instrumental variables simulate_instrumental_variables
Observed confounding simulate_observed_confounding
Counterfactual time series simulate_counterfactual_time_series
Regression Discontinuity simulate_regression_discontinuity
Experiments simulate_experiment
Causal ML simulate_causal_ml
Marketing Mix Modeling simulate_marketing_mix
Hierarchical Bayesian effects simulate_bayesian_regional_effects
Dynamic treatments simulate_dynamic_treatment_panel

Estimators

Import stable estimator functions from causal_econometrics.estimators.

Panel and DiD

  • fit_pooled_ols
  • fit_fixed_effects
  • fit_random_effects
  • fit_twfe_did
  • fit_event_study
  • estimate_group_time_att

IV and RDD

  • fit_2sls
  • estimate_sharp_rdd
  • estimate_fuzzy_rdd
  • bandwidth_sensitivity

Confounding adjustment

  • fit_propensity_scores
  • estimate_matching_att
  • estimate_ipw_ate
  • estimate_outcome_regression_ate
  • estimate_aipw_ate

Counterfactual time series

  • fit_interrupted_time_series
  • fit_synthetic_control
  • placebo_unit_synthetic_controls

Experiments

  • estimate_ab_itt
  • estimate_cuped_itt
  • estimate_complier_effect
  • required_sample_size_per_arm
  • minimum_detectable_effect

Causal ML

  • fit_s_learner
  • fit_t_learner
  • fit_x_learner
  • fit_dr_forest
  • evaluate_cate

Marketing and Bayesian models

  • fit_marketing_mix
  • optimize_budget_allocation
  • fit_bayesian_treatment_regression
  • fit_hierarchical_regional_effects
  • fit_bayesian_counterfactual

Dynamic effects and robustness

  • fit_distributed_lag
  • evaluate_treatment_history
  • run_falsification_regression
  • confounding_sensitivity_grid
  • run_adjustment_specification_curve

Production workflows

Import from causal_econometrics.production.

  • build_retail_pricing_benchmark
  • validate_common_adoption_input
  • preprocess_common_adoption_panel
  • run_common_adoption_workflow
  • write_workflow_artifacts

Portfolio case study

Import from causal_econometrics.case_studies.

  • run_retail_pricing_case_study
  • write_case_study_artifacts

Stability note

Version 1.0.0 marks the first portfolio-complete API. Method-specific result dataclasses are part of the supported public surface, but internal helper functions prefixed with _ are not.