API ReferenceEntry

make_cuped_tweedie

make_cuped_tweedie

Reference details for make_cuped_tweedie in causalis.dgp.

make_cuped_tweedie

Tweedie-like DGP with mixed marginals and structured HTE. Features many zeros and a heavy right tail. Suitable for CUPED benchmarking.

Parameters
  • n (int) – Number of samples to generate.
  • seed (int) – Random seed.
  • add_pre (bool) – Whether to add a pre-period covariate 'y_pre'.
  • pre_name (str) – Name of the pre-period covariate column.
  • pre_target_corr (float) – Target correlation between y_pre and post-outcome y in control group.
  • pre_spec (PreCorrSpec) – Detailed specification for pre-period calibration (transform, method, etc.). If provided, pre_target_corr is ignored in favor of pre_spec.target_corr.
  • include_oracle (bool) – Whether to include oracle ground-truth columns like 'cate', 'propensity', etc.
  • return_causal_data (bool) – Whether to return a CausalData object.
  • theta_log (float) – The log-uplift theta parameter for the treatment effect.
Returns