API Reference Overview
Econometrust provides six main estimator classes, each designed for specific econometric modeling scenarios.
Estimator Classes
Linear Regression Models
| Class | Description | Use Case |
|---|---|---|
| OLS | Ordinary Least Squares | Standard linear regression with optional robust standard errors |
| Ridge | Ridge Regression (L2 Regularization) | Regularized regression for multicollinearity and overfitting prevention |
| WLS | Weighted Least Squares | Heteroskedastic models with known variance weights |
| GLS | Generalized Least Squares | Models with known error covariance structure |
Instrumental Variables Models
| Class | Description | Use Case |
|---|---|---|
| IV | Instrumental Variables | Exactly identified models with endogenous regressors |
| TSLS | Two-Stage Least Squares | Overidentified models with multiple instruments |
Panel Data Models
| Class | Description | Use Case |
|---|---|---|
| FE | Fixed Effects | Panel data with unobserved entity heterogeneity |
Common Interface
All estimators share a consistent interface:
Initialization
Fitting
Properties and Methods
model.coefficients- Regression coefficientsmodel.intercept- Intercept term (if fitted)model.predict(X)- Generate predictionsmodel.standard_errors()- Coefficient standard errorsmodel.t_statistics()- T-statistics for significance testsmodel.p_values()- P-values for hypothesis testsmodel.confidence_intervals(alpha)- Confidence intervalsmodel.summary()- Comprehensive regression outputmodel.r_squared- Coefficient of determinationmodel.residuals- Regression residualsmodel.mse- Mean squared error
Algorithm Selection
Econometrust automatically selects the most appropriate numerical algorithm based on:
- Problem size (number of observations and features)
- Matrix conditioning (numerical stability requirements)
- Available computational resources
Available Algorithms
- Cholesky Decomposition: For well-conditioned overdetermined systems
- SVD (Singular Value Decomposition): For ill-conditioned or small systems
- Normal Equations: For large overdetermined systems with good conditioning
This intelligent selection ensures optimal performance and numerical stability across different problem types.