GetFeatureImpactForJobId: Retrieve completed Feature Impact results given a job ID

View source: R/FeatureImpact.R

GetFeatureImpactForJobIdR Documentation

Retrieve completed Feature Impact results given a job ID

Description

This will wait for the Feature Impact job to be completed (giving an error if the job is not a Feature Impact job and an error if the job errors).

Usage

GetFeatureImpactForJobId(project, jobId, maxWait = 600)

Arguments

project

character. The project the Feature Impact is part of.

jobId

character. The ID of the job (e.g. as returned from RequestFeatureImpact)

maxWait

integer. The maximum time (in seconds) to wait for the model job to complete

Value

A data frame with the following columns:

  • featureName character. The name of the feature.

  • impactNormalized numeric. The normalized impact score (largest value is 1).

  • impactUnnormalized numeric. The unnormalized impact score.

  • redundantWith character. A feature that makes this feature redundant, or NA if the feature is not redundant.

Examples

## Not run: 
  model <- ListModels(project)[[1]]
  featureImpactJobId <- RequestFeatureImpact(model)
  featureImpact <- GetFeatureImpactForJobId(project, featureImpactJobId)

## End(Not run)

datarobot documentation built on May 29, 2024, 4:36 a.m.