pycaret.regression.plot_model#

pycaret.regression.plot_model(estimator, plot: str = 'residuals', scale: float = 1, save: bool = False, fold: int | Any | None = None, fit_kwargs: dict | None = None, plot_kwargs: dict | None = None, groups: str | Any | None = None, verbose: bool = True, display_format: str | None = None) → str | None[source]#

This function analyzes the performance of a trained model on holdout set. It may require re-training the model in certain cases.

Example

>>> from pycaret.datasets import get_data
>>> boston = get_data('boston')
>>> from pycaret.regression import *
>>> exp_name = setup(data = boston,  target = 'medv')
>>> lr = create_model('lr')
>>> plot_model(lr, plot = 'residual')
estimator: scikit-learn compatible object

Trained model object

plot: str, default = ‘residual’

List of available plots (ID - Name):

  • ‘pipeline’ - Schematic drawing of the preprocessing pipeline

  • ‘residuals_interactive’ - Interactive Residual plots

  • ‘residuals’ - Residuals Plot

  • ‘error’ - Prediction Error Plot

  • ‘cooks’ - Cooks Distance Plot

  • ‘rfe’ - Recursive Feat. Selection

  • ‘learning’ - Learning Curve

  • ‘vc’ - Validation Curve

  • ‘manifold’ - Manifold Learning

  • ‘feature’ - Feature Importance

  • ‘feature_all’ - Feature Importance (All)

  • ‘parameter’ - Model Hyperparameter

  • ‘tree’ - Decision Tree

scale: float, default = 1

The resolution scale of the figure.

save: bool, default = False

When set to True, plot is saved in the current working directory.

fold: int or scikit-learn compatible CV generator, default = None

Controls cross-validation. If None, the CV generator in the fold_strategy parameter of the setup function is used. When an integer is passed, it is interpreted as the ‘n_splits’ parameter of the CV generator in the setup function.

fit_kwargs: dict, default = {} (empty dict)

Dictionary of arguments passed to the fit method of the model.

plot_kwargs: dict, default = {} (empty dict)
Dictionary of arguments passed to the visualizer class.

  • pipeline: fontsize -> int

plot_kwargs: dict, default = {} (empty dict)
Dictionary of arguments passed to the visualizer class.

  • pipeline: fontsize -> int

groups: str or array-like, with shape (n_samples,), default = None

Optional group labels when GroupKFold is used for the cross validation. It takes an array with shape (n_samples, ) where n_samples is the number of rows in training dataset. When string is passed, it is interpreted as the column name in the dataset containing group labels.

verbose: bool, default = True

When set to False, progress bar is not displayed.

display_format: str, default = None

To display plots in Streamlit (https://www.streamlit.io/), set this to ‘streamlit’. Currently, not all plots are supported.

Returns:

Path to saved file, if any.

On this page