API ReferenceEntry

generate_cuped_binary

generate_cuped_binary

Reference details for generate_cuped_binary in causalis.data_contracts.

generate_cuped_binary

Binary CUPED-oriented DGP with richer confounders and structured HTE.

Designed for CUPED benchmarking with randomized treatment and a calibrated pre-period covariate while preserving exact oracle cate under include_oracle.

Parameters
  • n (int) – Number of samples to generate.
  • seed (int) – Random seed.
  • add_pre (bool) – Whether to add a pre-period covariate.
  • pre_name (str) – Name of the pre-period covariate column.
  • pre_target_corr (float) – Target correlation between y_pre and post-outcome y in the control group.
  • pre_spec (PreCorrSpec) – Detailed specification for pre-period calibration. If provided, pre_target_corr is ignored in favor of pre_spec.target_corr.
  • include_oracle (bool) – Whether to include oracle columns like m, g0, g1, cate.
  • return_causal_data (bool) – Whether to return a CausalData object.
  • theta_logit (float) – Baseline log-odds uplift scale for heterogeneous treatment effects.
Returns