GetPredictionExplanationsInitializationFromJobId: Retrieve the prediction explanations initialization for a...

In datarobot: 'DataRobot' Predictive Modeling API

Retrieve the prediction explanations initialization for a model using jobId

Description

Prediction explanations initializations are a prerequisite for computing prediction explanations, and include a sample what the computed prediction explanations for a prediction dataset would look like.

Usage

GetPredictionExplanationsInitializationFromJobId(project, jobId, maxWait = 600)

Arguments

project	character. Either (1) a character string giving the unique alphanumeric identifier for the project, or (2) a list containing the element projectId with this identifier.
jobId	integer. Unique integer identifier pointing to the prediction explanations job (returned for example by RequestPredictionExplanationsInitialization.)
maxWait	integer. The maximum time (in seconds) to wait for the model job to complete

Value

A named list which contains:

• projectId character. ID of the project the feature belongs to.

• modelId character. The unique alphanumeric model identifier.

• predictionExplanationsSample list. List with sample of prediction explanations. Each element of the list is information about prediction explanations for one data row. For more information see GetPredictionExplanationsRows.

Examples

## Not run: 
  projectId <- "59a5af20c80891534e3c2bde"
  modelId <- "5996f820af07fc605e81ead4"
  model <- GetModel(projectId, modelId)
  jobId <- RequestPredictionExplanationsInitialization(model)
  GetPredictionExplanationsInitializationFromJobId(projectId, jobId)

## End(Not run)

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