PyCaret使いこなしのために公式ドキュメントの解読を決意してClassificationのsetup()関数、compare_models()関数のドキュメントを解読。続いてはClassificationのevaluate_models()関数のドキュメント。

evaluate_models()のオプション概要

pycaret.classification.evaluate_model(
  estimator,
  fold: Optional[Union[int, Any]] = None,
  fit_kwargs: Optional[dict] = None,
  plot_kwargs: Optional[dict] = None,
  groups: Optional[Union[str, Any]] = None,
  use_train_data: bool = False
)

関数の説明

この関数は学習済みモデルの性能を分析するためのユーザーインターフェースを表示します。内部でplot_model()関数を呼び出してます。

注意

この関数はIPython Notebook(Jupyter Notebook)上でのみ動作します。

実行例

from pycaret.datasets import get_data
from pycaret.classification import *

juice = get_data('juice')
exp_name = setup(data = juice,  target = 'Purchase')
best = compare_models()
evaluate_model(best)

必須パラメータ

estimator

形式: scikit-learn互換オブジェクト
説明: 学習済みモデルを渡します。

オプションパラメータ

fold

形式: int, scikit-learn互換CV生成器
デフォルト値: None
説明: 交差検証を制御します。もしNoneに設定した場合、setup()関数のfold_strategyパラメータで設定したものが使われます。整数値が渡された場合、もし整数値が渡された場合、setup()関数におけるCV生成器のn_splitsパラメータと解釈されます。

fit_kwargs

形式: dict
デフォルト値: {}(空のdict)
説明: モデルのfit()関数に渡す(キーワード)引数のディクショナリです。

plot_kwargs

形式: dict
デフォルト値: {}(空のdict)
説明: ビジュアライザークラス(可視化機能)に渡す(キーワード)引数のディクショナリです。

groups

形式: str, (n_shapses,)の行列形式
デフォルト値: None
説明: 交差検証にGroupKFoldを使用する場合のオプションのグループラベルを設定します。 (n_samples,)の行列形式で渡します。n_samplesは学習データの行数です。文字列が渡されると、グループラベルの値と等しいデータセット内の列名として解釈されます。

use_train_data

形式: bool
デフォルト値: False
説明: Trueを設定した場合、テストデータの代わりに、学習データを結果のプロットに用います。

PyCaretのドキュメント解読: Classification evaluate_model()関数