#!/usr/bin/env python3
__all__ = [
"Approximate"
]
from .. import RunApproximateGP
from .._const import regs
[docs]class Approximate(RunApproximateGP):
"""ApproximateGPModelの実行クラス
Parameters
----------
inducing_points_num : int or float
補助変数の個数(int)
もし 0 < inducing_points_num < 1 が渡された場合、学習用データの len と
inducing_points_num の積が補助変数の個数として設定される
kernel : str or :obj:`gpytorch.kernels`, default :obj:`'RBFKernel'`
使用するカーネル関数を指定する。下記から選択する。
- :obj:`'CosineKernel'`
- :obj:`'LinearKernel'`
- :obj:`'MaternKernel'`
- :obj:`'PeriodicKernel'`
- :obj:`'RBFKernel'`
- :obj:`'RQKernel'`
- :obj:`'SpectralMixtureKernel'`
基本はstrで指定されることを想定しているものの、 :obj:`gpytorch.kernels`
を用いた自作のカーネル関数を入力することも可能
likelihood : str, default :obj:`'GaussianLikelihood'`
likelihoodとして使用するクラス名が指定される。
- :obj:`'BernoulliLikelihood'` : likelihoodにベルヌーイ分布を仮定した二値分類ガウス過程モデルを行う場合
optimizer : str, default :obj:`'Adam'`
optimizerとして使用するクラス名が指定される。下記から選択する。
- :obj:`'Adam'`
- :obj:`'sgd'`
- :obj:`'RMSprop'`
- :obj:`'Adadelta'`
- :obj:`'Adagrad'`
mll : str, default :obj:`'VariationalELBO'`
確率分布の周辺化の方法のクラス名が指定される。下記から選択する。
- :obj:`'VariationalELBO'`, :obj:`'VELBO'`
- :obj:`'PredictiveLogLikelihood'`, :obj:`'PLL'`
- :obj:`'GammaRobustVariationalELBO'`, :obj:`'GRVELBO'`
ard_option : bool, default True
ARDカーネルを利用するかが指定される
もし :obj:`kernel_coeff` を利用する場合 `ard_option=True` を選択する
ker_conf : dict, default dict()
カーネル関数に渡す設定
mll_conf : dict, default dict()
mllに渡す設定
opt_conf : dict, default dict()
optimizerに渡す設定
random_state : int, default None
seedの固定
"""
def __init__(self, *args, **kwargs):
if kwargs.get('likelihood') is None:
kwargs['likelihood'] = 'BernoulliLikelihood'
if kwargs.get('likelihood') in regs:
raise ValueError(f"Classifierに{kwargs.get('likelihood')}は使えない")
else:
super(Approximate, self).__init__(*args, **kwargs)
[docs] def set_model(self, *args, **kwargs):
super(Approximate, self).set_model(*args, **kwargs)
[docs] def fit(self, *args, **kwargs):
super(Approximate, self).fit(*args, **kwargs)
[docs] def predict(self, *args, **kwargs):
"""予測用メソッド
Parameters
----------
X : np.array or torch.tensor
入力説明変数
cl : float default 0.6827(1sigma)
信頼区間
sample_num : int default None
yのサンプル数
sample_f_num : int default None
fのサンプル数
Returns
-------
output : object
予測された目的変数のオブジェクト。下記の属性が用意されている。
- output.samples : 入力説明変数に対する予測値yのサンプル(sample_num個サンプルされる)
- output.samples_f : 入力説明変数に対する予測関数fのサンプル(sample_f_num個サンプルされる)
- output.probs : 2値分類の予測確率。
"""
return super(Approximate, self).predict(*args, **kwargs)
[docs] def save(self, *args, **kwargs):
super(Approximate, self).save(*args, **kwargs)
[docs] def load(self, *args, **kwargs):
super(Approximate, self).load(*args, **kwargs)
[docs] def kernel_coeff(self, *args, **kwargs):
return super(Approximate, self).kernel_coeff(*args, **kwargs)
[docs] def plot_kernel(self, *args, **kwargs):
super(Approximate, self).plot_kernel(*args, **kwargs)