GetModelCapabilities: Get supported capabilities for a model, e.g., whether it has...

In datarobot: 'DataRobot' Predictive Modeling API

Get supported capabilities for a model, e.g., whether it has a word cloud.

Description

Get supported capabilities for a model, e.g., whether it has a word cloud.

Usage

GetModelCapabilities(model)

Arguments

model

An S3 object of class dataRobotModel like that returned by the function GetModel, or each element of the list returned by the function ListModels.

Value

Returns a list of logicals, representing different capabilities. Some of them are defined below:

• supportsBlending logical. Whether the model supports blending. See RequestBlender.

• supportsMonotonicConstraints logical. Whether the model supports monotonic constraints. See RequestModel.

• supportsModelPackageExport. logical. Whether the model can be exported as a model package (a .mloc file).

• supportsCodeGeneration logical. Added in DataRobot API 2.18. Whether the model supports code generation.

• supportsShap logical. Added in DataRobot API 2.18. Whether the model supports the Shapley package, i.e. Shapley-based feature importance.

• supportsEarlyStopping. logical. Added in DataRobot API 2.22. Whether this is an early-stopping tree-based model, which denotes that the number of trained iterations can be retrieved.

• hasWordCloud logical. Whether the model has a word cloud. See GetWordCloud.

• eligibleForPrime logical. Whether the model is eligible for Prime. See CreatePrimeCode.

• hasParameters logical. Whether the model has parameters. See GetModelParameters.

The list also includes the following:

• reasons. character. Explanations for why this model does not support certain capabilities. Not all capabilities are listed here. Names correspond to capabilities listed in ModelCapability.

Examples

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

## End(Not run)

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