absorb_ols
Run OLS with absorbed high-dimensional fixed effects to control for unobserved group heterogeneity. Obtain cluster-robust standard errors and diagnostics for causal decision-making.
Instructions
OLS with absorbed high-dimensional fixed effects (reghdfe-style).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| X | Yes | Regressors *excluding* the absorbed FEs and the constant (the constant is absorbed by any FE dimension). | |
| y | Yes | Outcome variable column name or outcome array. | |
| fe | Yes | Fixed-effect columns. | |
| tol | No | Demean convergence controls. | |
| 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 |
| slopes | No | slopes parameter (Optional[Sequence[SlopeSpec]]). | |
| solver | No | Within-transformation backend. See :class:`Absorber`. | map |
| cluster | No | One-way or multi-way cluster variables for robust SEs. If provided, returns cluster-robust SEs (one-way: Liang-Zeger sandwich; multi-way: inclusion-exclusion Cameron-Gelbach-Miller). | |
| maxiter | No | Demean convergence controls. | |
| weights | No | Observation weights. | |
| 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 | No | 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://. | |
| 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. | |
| 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. | |
| drop_singletons | No | drop_singletons parameter (bool). | |
| return_absorber | No | If True, also return the ``Absorber`` object for reuse. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||