APIリファレンス

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

  • statsmodels.api :横断面モデルとメソッド。 import statsmodels.api as sm を使用して正規にインポートされます。

  • statsmodels.tsa.api :時系列モデルとメソッド。 import statsmodels.tsa.api as tsa を使用して正規にインポートされます。

  • statsmodels.formula.api :数式文字列とDataFrameを使ってモデルを指定するための便利なインターフェイスです。このインターフェイスは、数式をサポートするモデルの 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, ...])

コックス比例ハザード回帰モデル

QuantReg(endog, exog, **kwargs)

分位点回帰

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

ロアスト線形モデル

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

ベータ回帰。

グラフィックス

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

QQ および PP の確率プロット

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

qqplot の基準線をプロットします。

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

x の分位数と分布の分位数/ppf の QQ プロット。

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

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

統計

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, ...])

拡張 Dickey-Fuller 単位根検定。

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])

ホドリック・プレスコットフィルター。

マルコフレジームスイッチングモデル

MarkovAutoregression(endog, k_regimes, order)

マルコフスイッチング回帰モデル

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

一次 k レジーム マルコフ スイッチング回帰モデル

予測

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

STL を使用して季節性を除去するモデルベースの予測

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

AssimakopoulosとNikolopoulosのシータ予測モデル (2000年)

時系列ツール

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, ...])

数式とデータフレームからモデルを作成します。
最終更新日: 2025年01月28日