Add HierarchicalLinearRegression for Hierarchical DiD

[jsakv]

This PR adds the HierarchicalLinearRegression with random intercepts and random slopes.

The model takes both a fixed-effect design matrix and a random-effect design matrix, similar to Bambi or Statmodel’s linear mixed effect models.

This PR is part of issue #656 Hierarchical DiD experiment resolution.

[github-actions]

👋 Welcome to CausalPy, @jsakv!

Thank you for opening your first pull request! We're excited to have you contribute to the project. 🎉

Here are a few tips to help your PR get merged smoothly:

• ✅ Make sure all CI checks pass (tests, linting, type checking)
• 📝 Run prek run --all-files locally before pushing
• 📖 Check our Contributing Guide for more details

A maintainer will review your changes soon. Thanks for helping make CausalPy better! 🚀

---

💼 LinkedIn Shoutout: Once your PR is merged, we'd love to give you a shoutout on LinkedIn to thank you for your contribution! If you're interested, just drop your LinkedIn profile URL in a comment below.

[read-the-docs-community]

Documentation build overview

📚 causalpy | 🛠️ Build #32918031 | 📁 Comparing a6d724d against latest (78ec91d)

  🔍 Preview build  

283 files changed · + 98 added · ± 184 modified · - 1 deleted

+ Added

• notebooks/sdid_pymc.html
• api/generated/causalpy.constants.html
• api/generated/causalpy.data.simulate_data.generate_hlr_data.html
• api/generated/causalpy.experiments.synthetic_difference_in_differences.SyntheticDifferenceInDifferences.algorithm.html
• api/generated/causalpy.experiments.synthetic_difference_in_differences.SyntheticDifferenceInDifferences.effect_summary.html
• api/generated/causalpy.experiments.synthetic_difference_in_differences.SyntheticDifferenceInDifferences.fit.html
• api/generated/causalpy.experiments.synthetic_difference_in_differences.SyntheticDifferenceInDifferences.generate_report.html
• api/generated/causalpy.experiments.synthetic_difference_in_differences.SyntheticDifferenceInDifferences.get_plot_data.html
• api/generated/causalpy.experiments.synthetic_difference_in_differences.SyntheticDifferenceInDifferences.get_plot_data_bayesian.html
• api/generated/causalpy.experiments.synthetic_difference_in_differences.SyntheticDifferenceInDifferences.get_plot_data_ols.html
• and 88 more...

± Modified

• 404.html
• genindex.html
• index.html
• py-modindex.html
• references.html
• _modules/index.html
• api/index.html
• knowledgebase/design_notation.html
• knowledgebase/estimands.html
• knowledgebase/quasi_dags.html
• and 174 more...

- Deleted

• api/generated/causalpy.experiments.base.BaseExperiment.plot.html

[jsakv]

Pending on #852 fix to pass CI checks

[drbenvincent]

This PR's failing test (3.11) / test (3.14) jobs are caused by test_panel_regression_plot_unit_effects (TypeError: only 0-dimensional arrays can be converted to Python scalars), which was fixed in #853 (now merged to main). Updating this branch from main should turn CI green — no code changes needed here.

[codecov]

Codecov Report

❌ Patch coverage is 99.37888% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 95.12%. Comparing base (c107d4e) to head (a6d724d).

Files with missing lines	Patch %	Lines
causalpy/tests/test_pymc_models.py	98.86%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #860      +/-   ##
==========================================
+ Coverage   95.07%   95.12%   +0.05%     
==========================================
  Files          87       87              
  Lines       13701    13862     +161     
  Branches      812      815       +3     
==========================================
+ Hits        13026    13186     +160     
  Misses        479      479              
- Partials      196      197       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[jsakv]

The PR is ready for review. Let me know what you think @drbenvincent!

Key points:



• I have aligned prior setting with a pattern closer to the InstrumentalVariableRegression pattern for protecting against silently mixing partial user priors with default variance-component priors. 

• I have still implemented the prior override logic, just being a bit stricter:
  • If priors is None: use HLR default_priors.
  • If priors: require the user to provide all priors for the chosen parameterization.
    

    
Happy to add data-driven priors later, I would like to get the HDID experiment out first!