Compute the coefficients of (swept out) fixed effects for a regression model.
Publishes the estimates as fixef_estimates, a FixedEffectEstimates value holding the coefficient records, the dummy-coded solution alpha, and the per-observation contribution sumFE.
Parameters
Name
Type
Description
Default
atol
Float
Stopping tolerance for scipy.sparse.linalg.lsqr(). See https://docs.scipy.org/doc/ scipy/reference/generated/scipy.sparse.linalg.lsqr.html
1e-6
btol
Float
Another stopping tolerance for scipy.sparse.linalg.lsqr(). See https://docs.scipy.org/doc/ scipy/reference/generated/scipy.sparse.linalg.lsqr.html
1e-6
Returns
Name
Type
Description
pd.DataFrame
A tidy DataFrame with columns variable, code, level, and coefficient containing the estimated fixed effects.
Raises
Name
Type
Description
NonConvergenceError
If LSQR stops at its iteration limit or because the problem is too ill-conditioned, before meeting atol and btol.