gap_closing
Measures the counterfactual outcome gap between groups after equalizing covariate distributions, producing certified parity evidence to support fairness decisions.
Instructions
Counterfactual gap after equalising covariate distributions. Validation: certified parity evidence.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| x | Yes | Primary running variable, regressor, or feature input for this estimator. | |
| y | Yes | Outcome variable column name or outcome array. | |
| seed | No | Random seed for reproducible stochastic steps. | |
| trim | No | trim parameter (float). | |
| alpha | No | Significance level for confidence intervals and tests. | |
| group | Yes | Group or cohort identifier. | |
| detail | No | Payload depth: 'minimal' (~150 tokens) for sub-step calls where only the point estimate is needed; 'standard' (~1K tokens) for diagnostics + coefficient table; 'agent' (~2K tokens, default) adds violations / next_steps / suggested_functions so the LLM can plan its next call without another round-trip. | agent |
| method | No | AIPW is doubly robust (recommended). | aipw |
| n_boot | No | Number of bootstrap replications. | |
| as_handle | No | If true, cache the fitted result on the server and return result_id + result_uri alongside the JSON payload so a subsequent tools/call can chain without re-running. | |
| data_path | Yes | Absolute path or URL to a data file. Supported: .csv / .tsv / .txt (delimited), .parquet / .pq, .feather / .arrow, .xlsx / .xls, .dta (Stata), .json / .jsonl. Schemes: file://, s3://, gs://, https://. | |
| inference | No | inference parameter (str). | analytical |
| result_id | No | Optional handle to a previously-fitted result (returned by an earlier call when as_handle=true). Tools that operate on a fitted object accept this in place of re-supplying data_path + columns. | |
| target_dist | No | - 1: shift Group A's covariate distribution to match Group B's - 0: shift Group B's to match Group A's | |
| data_columns | No | Optional column projection. Parquet/Feather/Stata loaders honour this for fast partial reads. | |
| data_sample_n | No | Optional uniform random subsample size (seed=0, deterministic) — useful on huge panels. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||