bayesml.poisson package

bayesml.poisson package#

モジュール内容#

このモジュールではガンマ事前分布を用いたポアソン分布を利用できます。

確率的データ生成モデル#

確率的データ生成モデルは以下の通りです：

\(x \in \mathbb{N}\): データ点
\(\lambda \in \mathbb{R}_{>0}\): パラメータ

\[p(x | \lambda) = \mathrm{Po}(x|\lambda) = \frac{ \lambda^{x} }{x!}\exp \{ -\lambda \}.\]

事前分布#

事前分布は以下の通りです：

\(\alpha_0 \in \mathbb{R}_{>0}\): ハイパーパラメータ
\(\beta_0 \in \mathbb{R}_{>0}\): ハイパーパラメータ
\(\Gamma(\cdot): \mathbb{R}_{>0} \to \mathbb{R}_{>0}\): ガンマ関数

\[p(\lambda) = \mathrm{Gam}(\lambda|\alpha_0,\beta_0) = \frac{\beta_0^{\alpha_0}}{\Gamma (\alpha_0)} \lambda^{\alpha_0 - 1} \exp \{ -\beta_0 \lambda \},\]

\[\begin{split}\mathbb{E}[\lambda] &= \frac{\alpha_0}{\beta_0}, \\ \mathbb{V}[\lambda] &= \frac{\alpha_0}{\beta_0^2}.\end{split}\]

事後分布#

事後分布は以下の通りです：

\(x^n = (x_1, x_2, \dots , x_n) \in \mathbb{N}^n\): 与えられたデータ
\(\alpha_n \in \mathbb{R}_{>0}\):ハイパーパラメータ
\(\beta_n \in \mathbb{R}_{>0}\): ハイパーパラメータ

\[p(\lambda | x^n) = \mathrm{Gam}(\lambda|\alpha_n,\beta_n) = \frac{\beta_n^{\alpha_n}}{\Gamma (\alpha_n)} \lambda^{\alpha_n - 1} \exp \{ -\beta_n \lambda \},\]

\[\begin{split}\mathbb{E}[\lambda | x^n] &= \frac{\alpha_n}{\beta_n}, \\ \mathbb{V}[\lambda | x^n] &= \frac{\alpha_n}{\beta_n^2},\end{split}\]

ここでハイパーパラメータの更新式は以下で与えられます

\[\begin{split}\alpha_n &= \alpha_0 + \sum_{i=1}^n x_i,\\ \beta_n &= \beta_0 + n.\end{split}\]

予測分布#

予測分布は以下の通りです：

\(x_{n+1} \in \mathbb{N}\): 新たなデータ点
\(\theta_\mathrm{p} \in \mathbb{R}_{>0}, 0<\theta_\mathrm{p}<1\): 事後分布のハイパーパラメータ
\(r_\mathrm{p} \in \mathbb{N}\): 事後分布のハイパーパラメータ

\[\mathrm{NB}(x_{n+1}|r_\mathrm{p},\theta_\mathrm{p}) = \frac{\Gamma(x_{n+1}+r_\mathrm{p})}{\Gamma(x_{n+1}+1)\Gamma(r_\mathrm{p})}\theta_\mathrm{p}^{x_{n+1}}(1-\theta_\mathrm{p})^{r_\mathrm{p}},\]

\[\begin{split}\mathbb{E}[x_{n+1} | x^n] &= \frac{r_\mathrm{p} \theta_\mathrm{p}}{1 - \theta_\mathrm{p}}, \\ \mathbb{V}[x_{n+1} | x^n] &= \frac{r_\mathrm{p} \theta_\mathrm{p}}{(1 - \theta_\mathrm{p})^2},\end{split}\]

ここで、パラメータは事後分布のハイパーパラメータから以下のように求められます:

\[\begin{split}&r_\mathrm{p}=\alpha_n, \\ &\theta_\mathrm{p} = \frac{1}{\beta_n + 1}.\end{split}\]

GitHubスターのお願い#

もしこのページが参考になったら、GitHubリポジトリにスターをいただけると開発の励みになります。

以下のリンクからリポジトリを開いて右上の☆Starを押してください。

リポジトリを開いて右上の☆Starを押す！

クラス#

class bayesml.poisson.GenModel(lambda_=1.0, h_alpha=1.0, h_beta=1.0, seed=None)#

ベースクラス: Generative

確率的データ生成モデルと事前分布

パラメータ:

lambda_float, optional: 正の実数、デフォルトでは1.0です
h_alphafloat, optional: 正の実数、デフォルトでは1.0です
h_betafloat, optional: 正の実数、デフォルトでは1.0です
seed{None, int}, optional: numpy.random.default_rng() を初期化するシード値です。デフォルトでは None

メソッド

`gen_params`()	事前分布からパラメータを生成します。
`gen_sample`(sample_size)	確率的データ生成モデルからサンプルを生成します。
`get_constants`()	GenModel の定数を取得します。
`get_h_params`()	事前分布のハイパーパラメータを取得します。
`get_params`()	確率的データ生成モデルのパラメータを取得します。
`load_h_params`(filename)	h_paramsにハイパーパラメータをロードします。
`load_params`(filename)	Load the parameters saved by `save_params`.
`save_h_params`(filename)	python `pickle` モジュールを使ってハイパーパラメータを保存します。
`save_params`(filename)	python の `pickle` モジュールを使ってパラメータを保存します。
`save_sample`(filename, sample_size)	生成されたサンプルを NumPy `.npz` フォーマットで保存します。
`set_h_params`([h_alpha, h_beta])	事前分布のハイパーパラメータを設定します。
`set_params`([lambda_])	確率的データ生成モデルのパラメータを設定します。
`visualize_model`([sample_size])	確率的データ生成モデルと生成されたサンプルを可視化します。

get_constants()#

GenModel の定数を取得します。

このモデルは定数を持ちません。したがって、この関数は emtpy dict {} を返します。

返り値:

constantsan empty dict

set_h_params(h_alpha=None, h_beta=None)#

事前分布のハイパーパラメータを設定します。

パラメータ:

h_alphafloat, optional: 正の実数、デフォルトではNone
h_betafloat, optional: 正の実数、デフォルトではNone

get_h_params()#

事前分布のハイパーパラメータを取得します。

返り値:

h_paramsdict of {str: float}

"h_alpha" : self.h_alpha の値
"h_beta" : self.h_beta の値

gen_params()#

事前分布からパラメータを生成します。

生成された値は``self.lambda_``に設定されます。

set_params(lambda_=None)#

確率的データ生成モデルのパラメータを設定します。

パラメータ:

lambda_float, optional: 正の実数、デフォルトではNone

get_params()#

確率的データ生成モデルのパラメータを取得します。

返り値:

paramsdict of {str:int}

"lambda_" : self.lambda_ の値です。

gen_sample(sample_size)#

確率的データ生成モデルからサンプルを生成します。

パラメータ:

sample_sizeint: 正の整数

返り値:

xnumpy ndarray: サイズが「sammple_size」で、要素が自然数である1次元配列です。

save_sample(filename, sample_size)#

生成されたサンプルを NumPy .npz フォーマットで保存します。

キーワード "x "でNpzFileとして保存されます。

パラメータ:

filenamestr: サンプルを保存するファイル名。ない場合は .npz が追加されます。
sample_sizeint: 正の整数

参考

numpy.savez_compressed

visualize_model(sample_size=20)#

確率的データ生成モデルと生成されたサンプルを可視化します。

パラメータ:

sample_sizeint, オプション: 正の整数。デフォルトは 20。

例

>>> from bayesml import poisson
>>> model = poisson.GenModel()
>>> model.visualize_model()
lambda:1.0
x:[2 1 1 0 0 5 0 2 2 2 1 1 0 1 3 0 0 1 1 0]

class bayesml.poisson.LearnModel(h0_alpha=1.0, h0_beta=1.0)#

ベースクラス: Posterior, PredictiveMixin

事後分布と予測分布

パラメータ:

h0_alphafloat, optional: 正の実数、デフォルトでは1.0です
h0_betafloat, optional: 正の実数、デフォルトでは1.0です

属性:

hn_alphafloat: 正の実数
hn_betafloat: 正の実数
p_rfloat: 正の実数
p_thetafloat: :math:`[0, 1]`に属する実数

メソッド

`calc_log_marginal_likelihood`()	対数周辺尤度の計算
`calc_pred_dist`()	予測分布のパラメータを計算します。
`estimate_interval`([credibility])	パラメータの信頼区間
`estimate_params`([loss, dict_out])	与えられた基準の下で、確率的データ生成モデルのパラメータを推定します。
`fit`(x)	モデルをデータに当てはめます。
`get_constants`()	LearnModel の定数を取得します。
`get_h0_params`()	事後分布のハイパーパラメータの初期値を取得します。
`get_hn_params`()	事後分布のハイパーパラメータを取得します。
`get_p_params`()	予測分布のパラメータを取得します。
`load_h0_params`(filename)	h0_paramsにハイパーパラメータをロードします。
`load_hn_params`(filename)	hn_paramsにハイパーパラメータをロードします。
`make_prediction`([loss])	与えられた基準の下で、新しいデータ点を予測します。
`overwrite_h0_params`()	事後分布のハイパーパラメータの初期値を学習した値で上書きします。
`pred_and_update`(x[, loss])	逐次的に新しいデータ点を予測し、事後分布を更新します。
`predict`()	次のデータ点を予測します。
`reset_hn_params`()	事後分布のハイパーパラメータを初期値に戻します。
`save_h0_params`(filename)	python `pickle` モジュールを使ってハイパーパラメータを保存します。
`save_hn_params`(filename)	python `pickle` モジュールを使ってハイパーパラメータを保存します。
`set_h0_params`([h0_alpha, h0_beta])	事後分布のハイパーパラメータの初期値を設定します。
`set_hn_params`([hn_alpha, hn_beta])	事後分布のハイパーパラメータの更新値を設定します。
`update_posterior`(x)	訓練データを使って事後分布のハイパーパラメータを更新します。
`visualize_posterior`()	パラメータの事後分布を可視化します。

get_constants()#

LearnModel の定数を取得します。

このモデルは定数を持ちません。したがって、この関数は emtpy dict {} を返します。

返り値:

constantsan empty dict

set_h0_params(h0_alpha=None, h0_beta=None)#

事後分布のハイパーパラメータの初期値を設定します。

パラメータ:

h0_alphafloat, optional: 正の実数、デフォルトではNone
h0_betafloat, optional: 正の実数、デフォルトではNone

get_h0_params()#

事後分布のハイパーパラメータの初期値を取得します。

返り値:

h0_paramsdict of {str: float}

"h0_alpha" : self.h0_alpha の値
"h0_beta" : self.h0_beta の値

set_hn_params(hn_alpha=None, hn_beta=None)#

事後分布のハイパーパラメータの更新値を設定します。

パラメータ:

hn_alphafloat, optional: 正の実数、デフォルトではNone
hn_betafloat, optional: 正の実数、デフォルトではNone

get_hn_params()#

事後分布のハイパーパラメータを取得します。

返り値:

hn_paramsdict of {str: float}

"hn_alpha" : self.hn_alpha の値
"hn_beta" : self.hn_beta の値

update_posterior(x)#

訓練データを使って事後分布のハイパーパラメータを更新します。

パラメータ:

xnumpy.ndarray: すべての要素は非負の整数でなければなりません。

estimate_params(loss='squared', dict_out=False)#

与えられた基準の下で、確率的データ生成モデルのパラメータを推定します。

パラメータ:

lossstr, optional: ベイズリスク関数の基礎となる損失関数、デフォルトは "squared"。この関数は "squared"、"0-1"、"abs"、"KL "をサポートしています。
dict_outbool, optional: If True, output will be a dict, by default False.

返り値:

estimator{float, None, rv_frozen}: 与えられた損失関数の下での推定値。存在しない場合は None が返されます。損失関数が "KL" の場合、事後分布そのものが scipy.stats の rv_frozen オブジェクトとして返されます。

参考

scipy.stats.rv_continuous
scipy.stats.rv_discrete

estimate_interval(credibility=0.95)#

パラメータの信頼区間

パラメータ:

credibilityfloat, optional: パラメータがその区間に含まれるという事後確率（デフォルト値：0.95）

返り値:

lower, upper: float: 区間の下限と上限

visualize_posterior()#

パラメータの事後分布を可視化します。

例

>>> from bayesml import poisson
>>> gen_model = poisson.GenModel(lambda_=2.0)
>>> x = gen_model.gen_sample(20)
>>> print(x)
[2 1 6 2 3 1 1 3 2 1 2 1 1 1 2 2 4 2 2 2]
>>> learn_model = poisson.LearnModel()
>>> learn_model.update_posterior(x)
>>> learn_model.visualize_posterior()

get_p_params()#

予測分布のパラメータを取得します。

返り値:

p_paramsdict of {str: float}

"p_r"：``self.p_r``の値
"p_theta" : The value of self.p_theta

calc_pred_dist()#: 予測分布のパラメータを計算します。

make_prediction(loss='squared')#

与えられた基準の下で、新しいデータ点を予測します。

パラメータ:

lossstr, optional: ベイズリスク関数の基礎となる損失関数、デフォルトは "squared"。この関数は "squared"、"0-1"、"abs"、"KL "をサポートしています。

返り値:

Predicted_value{float, rv_frozen}: 指定された損失関数における予測値です。損失関数が「KL」の場合、事後分布そのものが scipy.stats の rv_frozen オブジェクトとして返されます。

参考

scipy.stats.rv_continuous
scipy.stats.rv_discrete

pred_and_update(x, loss='squared')#

逐次的に新しいデータ点を予測し、事後分布を更新します。

パラメータ:

xint: それは自然数でなければなりません
lossstr, optional: ベイズリスク関数の基礎となる損失関数、デフォルトは "squared"。この関数は "squared"、"0-1"、"abs"、"KL "をサポートしています。

返り値:

Predicted_value{float, rv_frozen}: 指定された損失関数における予測値です。損失関数が「KL」の場合、事後分布そのものが scipy.stats の rv_frozen オブジェクトとして返されます。

参考

scipy.stats.rv_continuous
scipy.stats.rv_discrete

calc_log_marginal_likelihood()#

対数周辺尤度の計算

返り値:

log_marginal_likelihoodfloat: 対数周辺尤度

fit(x)#

モデルをデータに当てはめます。

この関数は以下の関数のラッパーです：

>>> self.reset_hn_params()
>>> self.update_posterior(x)
>>> return self

パラメータ:

xnumpy.ndarray: すべての要素は非負の整数でなければなりません。

返り値:

selfLearnModel: The fitted model.

predict()#

次のデータ点を予測します。

この関数は以下の関数のラッパーです：

>>> self.calc_pred_dist()
>>> return self.make_prediction(loss="squared")

返り値:

predicted_valuefloat: 二乗誤差関数に基づく予測値。

bayesml.poisson package

目次

bayesml.poisson package#

モジュール内容#

確率的データ生成モデル#

事前分布#

事後分布#

予測分布#

GitHubスターのお願い#

クラス#