APIリファレンス

メインのstatsmodels APIはモデルに分割されています

  • statsmodels.api：横断的モデルとメソッド。標準的にはimport statsmodels.api as smを使用してインポートします。

  • statsmodels.tsa.api：時系列モデルとメソッド。標準的にはimport statsmodels.tsa.api as tsaを使用してインポートします。

  • statsmodels.formula.api：数式文字列とDataFramesを使用してモデルを指定するための便利なインターフェース。このAPIは、formula APIをサポートするモデルのfrom_formulaクラスメソッドを直接公開します。標準的にはimport statsmodels.formula.api as smfを使用してインポートします。

APIは、モデルと最も頻繁に使用される統計的検定、およびツールに焦点を当てています。インポートパスと構造は、2つのAPIモジュールの設計と、APIからのインポートがモデルが定義されているモジュールから直接インポートするのとどのように異なるかを説明します。利用可能なモデル、統計、およびツールの完全なリストについては、ユーザーガイドの詳細なトピックページを参照してください。

statsmodels.api

回帰

OLS(endog[, exog, missing, hasconst])

通常最小二乗法

WLS(endog, exog[, weights, missing, hasconst])

加重最小二乗法

GLS(endog, exog[, sigma, missing, hasconst])

一般化最小二乗法

GLSAR(endog[, exog, rho, missing, hasconst])

AR共分散構造を持つ一般化最小二乗法

RecursiveLS(endog, exog[, constraints])

再帰的最小二乗法

RollingOLS(endog, exog[, window, min_nobs, ...])

ローリング通常最小二乗法

RollingWLS(endog, exog[, window, weights, ...])

ローリング加重最小二乗法

補完

BayesGaussMI(data[, mean_prior, cov_prior, ...])

ガウスモデルを使用したベイズ補完。

MI(imp, model[, model_args_fn, ...])

MIは、提供されたimputerオブジェクトを使用して多重代入を実行します。

MICE(model_formula, model_class, data[, ...])

連鎖方程式による多重代入。

MICEData(data[, perturbation_method, k_pmm, ...])

MICEで欠損データを処理できるようにデータセットをラップします。

一般化推定方程式

GEE(endog, exog, groups[, time, family, ...])

一般化推定方程式を用いた周辺回帰モデル。

NominalGEE(endog, exog, groups[, time, ...])

GEEを用いた名義反応周辺回帰モデル。

OrdinalGEE(endog, exog, groups[, time, ...])

GEEを用いた順序反応周辺回帰モデル

一般化線形モデル

GLM(endog, exog[, family, offset, exposure, ...])

一般化線形モデル

GLMGam(endog[, exog, smoother, alpha, ...])

一般化加法モデル（GAM）

BinomialBayesMixedGLM(endog, exog, exog_vc, ...)

ベイズ推定による一般化線形混合モデル

PoissonBayesMixedGLM(endog, exog, exog_vc, ident)

ベイズ推定による一般化線形混合モデル

離散およびカウントモデル

Logit(endog, exog[, offset, check_rank])

ロジットモデル

Probit(endog, exog[, offset, check_rank])

プロビットモデル

MNLogit(endog, exog[, check_rank])

多項ロジットモデル

OrderedModel(endog, exog[, offset, distr])

ロジスティック分布または正規分布に基づく順序モデル

Poisson(endog, exog[, offset, exposure, ...])

ポアソンモデル

NegativeBinomial(endog, exog[, ...])

負の二項モデル

NegativeBinomialP(endog, exog[, p, offset, ...])

一般化負の二項 (NB-P) モデル

GeneralizedPoisson(endog, exog[, p, offset, ...])

一般化ポアソンモデル

ZeroInflatedPoisson(endog, exog[, ...])

ゼロ過剰ポアソンモデル

ZeroInflatedNegativeBinomialP(endog, exog[, ...])

ゼロ過剰一般化負の二項モデル

ZeroInflatedGeneralizedPoisson(endog, exog)

ゼロ過剰一般化ポアソンモデル

ConditionalLogit(endog, exog[, missing])

グループ化されたデータに条件付きロジスティック回帰モデルを適合させる。

ConditionalMNLogit(endog, exog[, missing])

グループ化されたデータに条件付き多項ロジットモデルを適合させる。

ConditionalPoisson(endog, exog[, missing])

グループ化されたデータに条件付きポアソン回帰モデルを適合させる。

多変量モデル

Factor([endog, n_factor, corr, method, smc, ...])

因子分析

MANOVA(endog, exog[, missing, hasconst])

多変量分散分析

PCA(data[, ncomp, standardize, demean, ...])

主成分分析

その他のモデル

MixedLM(endog, exog, groups[, exog_re, ...])

線形混合効果モデル

SurvfuncRight(time, status[, entry, title, ...])

生存関数の推定と推論。

PHReg(endog, exog[, status, entry, strata, ...])

Cox比例ハザード回帰モデル

QuantReg(endog, exog, **kwargs)

分位点回帰

RLM(endog, exog[, M, missing])

ロバスト線形モデル

BetaModel(endog, exog[, exog_precision, ...])

ベータ回帰。

グラフィックス

ProbPlot(data[, dist, fit, distargs, a, ...])

Q-Q および P-P 確率プロット

qqline(ax, line[, x, y, dist, fmt])

qqプロットの参照線をプロットする。

qqplot(data[, dist, distargs, a, loc, ...])

xの分位数と分布の分位数/ppfとの間のQ-Qプロット。

qqplot_2samples(data1, data2[, xlabel, ...])

2つのサンプルの分位数のQ-Qプロット。

統計

Description(data[, stats, numeric, ...])

データに関する拡張された記述統計量

describe(data[, stats, numeric, ...])

データに関する拡張された記述統計量

ツール

test([extra_args, exit])

テストスイートを実行する

add_constant(data[, prepend, has_constant])

配列に1の列を追加する。

load_pickle(fname)

以前に保存したオブジェクトをロードする

show_versions([show_dirs])

statsmodelsおよびインストールされている依存関係のバージョンを一覧表示する

webdoc([func, stable])

ブラウザを開き、オンラインドキュメントを表示する

statsmodels.tsa.api

統計と検定

acf(x[, adjusted, nlags, qstat, fft, alpha, ...])

自己相関関数を計算する。

acovf(x[, adjusted, demean, fft, missing, nlag])

自己共分散を推定する。

adfuller(x[, maxlag, regression, autolag, ...])

拡張ディッキー=フラー単位根検定。

bds(x[, max_dim, epsilon, distance])

時系列の独立性のためのBDS検定統計量

ccf(x, y[, adjusted, fft, nlags, alpha])

相互相関関数。

ccovf(x, y[, adjusted, demean, fft])

2つの系列間の相互共分散を計算する。

coint(y0, y1[, trend, method, maxlag, ...])

単変量方程式のコインテグレーションの非存在を検定します。

kpss(x[, regression, nlags, store])

定常性に関する Kwiatkowski-Phillips-Schmidt-Shin 検定。

pacf(x[, nlags, method, alpha])

偏自己相関の推定。

pacf_ols(x[, nlags, efficient, adjusted])

OLS を介した偏自己相関の計算。

pacf_yw(x[, nlags, method])

非再帰的 yule_walker で推定された偏自己相関。

q_stat(x, nobs)

Ljung-Box Q 統計量を計算します。

range_unit_root_test(x[, store])

定常性に関するレンジ単位根検定。

zivot_andrews

Zivot-Andrews 構造変化単位根検定。

単変量時系列分析

AutoReg(endog, lags[, trend, seasonal, ...])

自己回帰 AR-X(p) モデル

ARDL(endog, lags[, exog, order, trend, ...])

自己回帰分布ラグ (ARDL) モデル

ARIMA(endog[, exog, order, seasonal_order, ...])

自己回帰和分移動平均 (ARIMA) モデルと拡張機能

SARIMAX(endog[, exog, order, ...])

外生回帰子モデルを使用した季節自己回帰和分移動平均

ardl_select_order(endog, maxlag, exog, maxorder)

ARDL 次数選択

arma_order_select_ic(y[, max_ar, max_ma, ...])

多くの ARMA モデルの情報量基準を計算します。

arma_generate_sample(ar, ma, nsample[, ...])

ARMA からデータをシミュレートします。

ArmaProcess([ar, ma, nobs])

指定されたラグ多項式に対する ARMA プロセスの理論的特性。

UECM(endog, lags[, exog, order, trend, ...])

制約なし誤差相関モデル (UECM)

指数平滑化

ExponentialSmoothing(endog[, trend, ...])

ホルト-ウィンターズ指数平滑化

Holt(endog[, exponential, damped_trend, ...])

ホルトの指数平滑化

SimpleExpSmoothing(endog[, ...])

単純指数平滑化

ExponentialSmoothing(endog[, trend, ...])

線形指数平滑化モデル

ETSModel(endog[, error, trend, ...])

ETS モデル。

多変量時系列モデル

DynamicFactor(endog, k_factors, factor_order)

動的因子モデル

DynamicFactorMQ(endog[, k_endog_monthly, ...])

EM アルゴリズムを使用した動的因子モデル。月次/四半期データのオプション。

VAR(endog[, exog, dates, freq, missing])

VAR(p) プロセスを適合させ、ラグ次数の選択を行います

VARMAX(endog[, exog, order, trend, ...])

外生回帰子モデルを使用したベクトル自己回帰移動平均

SVAR(endog, svar_type[, dates, freq, A, B, ...])

VAR を適合させてから、A および B の構造成分を推定します。定義

VECM(endog[, exog, exog_coint, dates, freq, ...])

ベクトル誤差修正モデル (VECM) を表すクラス。

UnobservedComponents(endog[, level, trend, ...])

単変量観測されないコンポーネント時系列モデル

フィルターと分解

seasonal_decompose(x[, model, filt, period, ...])

移動平均を使用した季節分解。

STL(endog[, period, seasonal, trend, ...])

LOESS を使用した季節トレンド分解。

MSTL(endog[, periods, windows, lmbda, ...])

複数の季節性に対して LOESS を使用した季節トレンド分解。

bkfilter(x[, low, high, K])

Baxter-Kingバンドパスフィルターを用いて時系列をフィルタリングします。

cffilter(x[, low, high, drift])

Christiano Fitzgeraldの非対称ランダムウォークフィルター。

hpfilter(x[, lamb])

Hodrick-Prescottフィルター。

マルコフ連鎖レジーム切替モデル

MarkovAutoregression(endog, k_regimes, order)

マルコフ切替回帰モデル

MarkovRegression(endog, k_regimes[, trend, ...])

一次のk-レジームマルコフ切替回帰モデル

予測

STLForecast(endog, model, *[, model_kwargs, ...])

季節性除去にSTLを用いたモデルベースの予測

ThetaModel(endog, *[, period, ...])

AssimakopoulosとNikolopoulos（2000）のTheta予測モデル

時系列ツール

add_lag(x[, col, lags, drop, insert])

与えられた配列にラグを含めた配列を返します。

add_trend(x[, trend, prepend, has_constant])

配列にトレンドおよび/または定数を追加します。

detrend(x[, order, axis])

軸0または1に沿って指定された次数のトレンドで配列をデトレンドします。

lagmat(x, maxlag[, trim, original, use_pandas])

ラグの2次元配列を作成します。

lagmat2ds(x, maxlag0[, maxlagex, dropex, ...])

変数で配置された列を持つ2次元配列のラグ行列を生成します。

DeterministicProcess(index, *[, period, ...])

決定項のコンテナクラス。

X12/X13インターフェース

x13_arima_analysis(endog[, maxorder, ...])

月次または四半期データのx13-arima分析を実行します。

x13_arima_select_order(endog[, maxorder, ...])

x12/x13 ARIMAを使用して、自動季節ARIMA次数識別を実行します。

statsmodels.formula.api

モデル

小文字の名前は、対応するモデルクラスのfrom_formulaメソッドのエイリアスです。フォーミュラAPIで公開されているメソッドの説明は一般的です。詳細については、親モデルのドキュメントを参照してください。

gls(formula, data[, subset, drop_cols])

数式とデータフレームからモデルを作成します。

wls(formula, data[, subset, drop_cols])

数式とデータフレームからモデルを作成します。

ols(formula, data[, subset, drop_cols])

数式とデータフレームからモデルを作成します。

glsar(formula, data[, subset, drop_cols])

数式とデータフレームからモデルを作成します。

mixedlm(formula, data[, re_formula, ...])

数式とデータフレームからモデルを作成します。

glm(formula, data[, subset, drop_cols])

数式とデータフレームからモデルを作成します。

gee(formula, groups, data[, subset, time, ...])

数式とデータフレームからモデルを作成します。

ordinal_gee(formula, groups, data[, subset, ...])

数式とデータフレームからモデルを作成します。

nominal_gee(formula, groups, data[, subset, ...])

数式とデータフレームからモデルを作成します。

rlm(formula, data[, subset, drop_cols])

数式とデータフレームからモデルを作成します。

logit(formula, data[, subset, drop_cols])

数式とデータフレームからモデルを作成します。

probit(formula, data[, subset, drop_cols])

数式とデータフレームからモデルを作成します。

mnlogit(formula, data[, subset, drop_cols])

数式とデータフレームからモデルを作成します。

poisson(formula, data[, subset, drop_cols])

数式とデータフレームからモデルを作成します。

negativebinomial(formula, data[, subset, ...])

数式とデータフレームからモデルを作成します。

quantreg(formula, data[, subset, drop_cols])

数式とデータフレームからモデルを作成します。

phreg(formula, data[, status, entry, ...])

数式とデータフレームから比例ハザード回帰モデルを作成します。

glmgam(formula, data[, subset, drop_cols])

数式とデータフレームからモデルを作成します。

conditional_logit(formula, data[, subset, ...])

数式とデータフレームからモデルを作成します。

conditional_mnlogit(formula, data[, subset, ...])

数式とデータフレームからモデルを作成します。

conditional_poisson(formula, data[, subset, ...])

数式とデータフレームからモデルを作成します。
最終更新日：2024年10月3日