公式:使用 R 风格公式拟合模型

从 0.5.0 版本开始,statsmodels 允许用户使用 R 风格公式拟合统计模型。在内部,statsmodels 使用 patsy 包将公式和数据转换为模型拟合中使用的矩阵。公式框架非常强大;本教程只是触及了皮毛。关于公式语言的完整描述可以在 patsy 文档中找到

加载模块和函数

[1]:
import numpy as np  # noqa:F401  needed in namespace for patsy
import statsmodels.api as sm

导入约定

您可以从 statsmodels.formula.api 中显式导入

[2]:
from statsmodels.formula.api import ols

或者,您也可以直接使用主 statsmodels.apiformula 命名空间。

[3]:
sm.formula.ols
[3]:
<bound method Model.from_formula of <class 'statsmodels.regression.linear_model.OLS'>>

或者您可以使用以下约定

[4]:
import statsmodels.formula.api as smf

这些名称只是方便地访问每个模型的 from_formula 类方法的一种方法。例如,参见

[5]:
sm.OLS.from_formula
[5]:
<bound method Model.from_formula of <class 'statsmodels.regression.linear_model.OLS'>>

所有小写模型都接受 formuladata 参数,而大写模型则接受 endogexog 设计矩阵。 formula 接受一个字符串,该字符串使用 patsy 公式描述模型。 data 接受一个 pandas 数据帧或任何其他定义了用于变量名的 __getitem__ 的数据结构,例如结构化数组或变量字典。

dir(sm.formula) 将打印可用模型的列表。

与公式兼容的模型具有以下通用调用签名: (formula, data, subset=None, *args, **kwargs)

使用公式进行 OLS 回归

首先,我们拟合 入门 页面中描述的线性模型。下载数据,子集列,并进行列表式删除以移除缺失观察值

[6]:
dta = sm.datasets.get_rdataset("Guerry", "HistData", cache=True)
[7]:
df = dta.data[["Lottery", "Literacy", "Wealth", "Region"]].dropna()
df.head()
[7]:
彩票 识字率 财富 地区
0 41 37 73 E
1 38 51 22 N
2 66 13 61 C
3 80 46 76 E
4 79 69 83 E

拟合模型

[8]:
mod = ols(formula="Lottery ~ Literacy + Wealth + Region", data=df)
res = mod.fit()
print(res.summary())
                            OLS Regression Results
==============================================================================
Dep. Variable:                Lottery   R-squared:                       0.338
Model:                            OLS   Adj. R-squared:                  0.287
Method:                 Least Squares   F-statistic:                     6.636
Date:                Thu, 03 Oct 2024   Prob (F-statistic):           1.07e-05
Time:                        15:49:16   Log-Likelihood:                -375.30
No. Observations:                  85   AIC:                             764.6
Df Residuals:                      78   BIC:                             781.7
Df Model:                           6
Covariance Type:            nonrobust
===============================================================================
                  coef    std err          t      P>|t|      [0.025      0.975]
-------------------------------------------------------------------------------
Intercept      38.6517      9.456      4.087      0.000      19.826      57.478
Region[T.E]   -15.4278      9.727     -1.586      0.117     -34.793       3.938
Region[T.N]   -10.0170      9.260     -1.082      0.283     -28.453       8.419
Region[T.S]    -4.5483      7.279     -0.625      0.534     -19.039       9.943
Region[T.W]   -10.0913      7.196     -1.402      0.165     -24.418       4.235
Literacy       -0.1858      0.210     -0.886      0.378      -0.603       0.232
Wealth          0.4515      0.103      4.390      0.000       0.247       0.656
==============================================================================
Omnibus:                        3.049   Durbin-Watson:                   1.785
Prob(Omnibus):                  0.218   Jarque-Bera (JB):                2.694
Skew:                          -0.340   Prob(JB):                        0.260
Kurtosis:                       2.454   Cond. No.                         371.
==============================================================================

Notes:
[1] Standard Errors assume that the covariance matrix of the errors is correctly specified.

分类变量

查看上面打印的摘要,请注意 patsy 确定 *Region* 的元素是文本字符串,因此它将 *Region* 视为分类变量。 patsy 的默认设置也是包含一个截距,因此我们自动删除了其中一个 *Region* 类别。

如果 *Region* 是一个我们希望明确地将其视为分类变量的整数变量,我们可以使用 C() 运算符来做到这一点

[9]:
res = ols(formula="Lottery ~ Literacy + Wealth + C(Region)", data=df).fit()
print(res.params)
Intercept         38.651655
C(Region)[T.E]   -15.427785
C(Region)[T.N]   -10.016961
C(Region)[T.S]    -4.548257
C(Region)[T.W]   -10.091276
Literacy          -0.185819
Wealth             0.451475
dtype: float64

Patsy 的用于分类变量的更高级功能在以下内容中讨论: Patsy:用于分类变量的对比编码系统

运算符

我们已经看到“~” 将模型的左侧与右侧分开,而“+” 将新列添加到设计矩阵中。

移除变量

“-” 符号可用于移除列/变量。例如,我们可以通过以下方式从模型中移除截距

[10]:
res = ols(formula="Lottery ~ Literacy + Wealth + C(Region) -1 ", data=df).fit()
print(res.params)
C(Region)[C]    38.651655
C(Region)[E]    23.223870
C(Region)[N]    28.634694
C(Region)[S]    34.103399
C(Region)[W]    28.560379
Literacy        -0.185819
Wealth           0.451475
dtype: float64

乘法交互

“:” 将一个新列添加到设计矩阵中,该列包含其他两列的交互。 “*” 还将包含一起相乘的各个列

[11]:
res1 = ols(formula="Lottery ~ Literacy : Wealth - 1", data=df).fit()
res2 = ols(formula="Lottery ~ Literacy * Wealth - 1", data=df).fit()
print(res1.params, "\n")
print(res2.params)
Literacy:Wealth    0.018176
dtype: float64

Literacy           0.427386
Wealth             1.080987
Literacy:Wealth   -0.013609
dtype: float64

运算符可以实现许多其他功能。请参阅 patsy 文档 以了解更多信息。

函数

您可以将向量化函数应用于模型中的变量

[12]:
res = smf.ols(formula="Lottery ~ np.log(Literacy)", data=df).fit()
print(res.params)
Intercept           115.609119
np.log(Literacy)    -20.393959
dtype: float64

定义自定义函数

[13]:
def log_plus_1(x):
    return np.log(x) + 1.0


res = smf.ols(formula="Lottery ~ log_plus_1(Literacy)", data=df).fit()
print(res.params)
Intercept               136.003079
log_plus_1(Literacy)    -20.393959
dtype: float64

调用命名空间中的任何函数都可用于公式。

将公式与不支持公式的模型一起使用(目前)

即使给定的 statsmodels 函数不支持公式,您仍然可以使用 patsy 的公式语言来生成设计矩阵。然后可以将这些矩阵作为 endogexog 参数提供给拟合函数。

要生成 numpy 数组

[14]:
import patsy

f = "Lottery ~ Literacy * Wealth"
y, X = patsy.dmatrices(f, df, return_type="matrix")
print(y[:5])
print(X[:5])
[[41.]
 [38.]
 [66.]
 [80.]
 [79.]]
[[1.000e+00 3.700e+01 7.300e+01 2.701e+03]
 [1.000e+00 5.100e+01 2.200e+01 1.122e+03]
 [1.000e+00 1.300e+01 6.100e+01 7.930e+02]
 [1.000e+00 4.600e+01 7.600e+01 3.496e+03]
 [1.000e+00 6.900e+01 8.300e+01 5.727e+03]]

要生成 pandas 数据帧

[15]:
f = "Lottery ~ Literacy * Wealth"
y, X = patsy.dmatrices(f, df, return_type="dataframe")
print(y[:5])
print(X[:5])
   Lottery
0     41.0
1     38.0
2     66.0
3     80.0
4     79.0
   Intercept  Literacy  Wealth  Literacy:Wealth
0        1.0      37.0    73.0           2701.0
1        1.0      51.0    22.0           1122.0
2        1.0      13.0    61.0            793.0
3        1.0      46.0    76.0           3496.0
4        1.0      69.0    83.0           5727.0
[16]:
print(sm.OLS(y, X).fit().summary())
                            OLS Regression Results
==============================================================================
Dep. Variable:                Lottery   R-squared:                       0.309
Model:                            OLS   Adj. R-squared:                  0.283
Method:                 Least Squares   F-statistic:                     12.06
Date:                Thu, 03 Oct 2024   Prob (F-statistic):           1.32e-06
Time:                        15:49:16   Log-Likelihood:                -377.13
No. Observations:                  85   AIC:                             762.3
Df Residuals:                      81   BIC:                             772.0
Df Model:                           3
Covariance Type:            nonrobust
===================================================================================
                      coef    std err          t      P>|t|      [0.025      0.975]
-----------------------------------------------------------------------------------
Intercept          38.6348     15.825      2.441      0.017       7.149      70.121
Literacy           -0.3522      0.334     -1.056      0.294      -1.016       0.312
Wealth              0.4364      0.283      1.544      0.126      -0.126       0.999
Literacy:Wealth    -0.0005      0.006     -0.085      0.933      -0.013       0.012
==============================================================================
Omnibus:                        4.447   Durbin-Watson:                   1.953
Prob(Omnibus):                  0.108   Jarque-Bera (JB):                3.228
Skew:                          -0.332   Prob(JB):                        0.199
Kurtosis:                       2.314   Cond. No.                     1.40e+04
==============================================================================

Notes:
[1] Standard Errors assume that the covariance matrix of the errors is correctly specified.
[2] The condition number is large, 1.4e+04. This might indicate that there are
strong multicollinearity or other numerical problems.

上次更新:2024 年 10 月 3 日