pyreal.RealApp.prepare_similar_examples#

RealApp.prepare_similar_examples(x_train_orig=None, y_train=None, model_id=None, algorithm=None, training_size=None, standardize=False, fast=True)[source]#

Initialize and fit a nearest neighbor explainer

Parameters:

  • model_id (int or string) – Model id to explain

  • x_train_orig (DataFrame of shape (n_instances, n_features)) – Training data, if not provided at initialization.

  • y_train (DataFrame or Series) – Training targets, if not provided at initialization

  • algorithm (string) – NN algorithm to use (current options: [nn])

  • training_size (int) – Number of rows to use in fitting explainer

  • standardize (Boolean) – If True, standardize data before using it to get similar examples. Recommended if model-ready data is not already standardized

  • fast (Boolean) – If True, use a faster algorithm for getting similar examples (disable if faiss dependency not available)

Returns:

A fit SimilarExamples explainer