evalml.model_understanding.calculate_permutation_importance

evalml.model_understanding.calculate_permutation_importance(pipeline, X, y, objective, n_repeats=5, n_jobs=None, random_state=0)[source]

Calculates permutation importance for features.

Parameters
  • pipeline (PipelineBase or subclass) – fitted pipeline

  • X (pd.DataFrame) – the input data used to score and compute permutation importance

  • y (pd.Series) – the target labels

  • objective (str, ObjectiveBase) – objective to score on

  • n_repeats (int) – Number of times to permute a feature. Defaults to 5.

  • n_jobs (int or None) – Non-negative integer describing level of parallelism used for pipelines. None and 1 are equivalent. If set to -1, all CPUs are used. For n_jobs below -1, (n_cpus + 1 + n_jobs) are used.

  • random_state (int, np.random.RandomState) – The random seed/state. Defaults to 0.

Returns

Mean feature importance scores over 5 shuffles.