datarobot (version 2.8.0)

GetModel: Retrieve the details of a specified model

Description

This function returns a DataRobot S3 object of class dataRobotModel for the model defined by project and modelId.

Usage

GetModel(project, modelId)

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.

modelId

character. Unique alphanumeric identifier for the model of interest.

Value

An S3 object of class `dataRobotModel', which is a list with the following components:

• featurelistId. Character string: unique alphanumeric identifier for the featurelist on which the model is based.

• processes. Character vector with components describing preprocessing; may include modelType.

• featurelistName. Character string giving the name of the featurelist on which the model is based.

• projectId. Character string giving the unique alphanumeric identifier for the project.

• samplePct. Numeric: percentage of the dataset used to form the training dataset for model fitting.

• isFrozen. Logical : is model created with frozen tuning parameters.

• modelType. Character string describing the model type.

• metrics. List with one element for each valid metric associated with the model. Each element is a list with elements for each possible evaluation type (holdout, validation, and crossValidation).

• modelCategory. Character string giving model category (e.g., blend, model).

• blueprintId. Character string giving the unique DataRobot blueprint identifier on which the model is based.

• modelId. Character string giving the unique alphanumeric model identifier.

• projectName. Character string: optional description of project defined by projectId.

• projectTarget. Character string defining the target variable predicted by all models in the project.

• projectMetric. Character string defining the fitting metric optimized by all project models.

Details

The S3 object returned by this function is required by the functions DeleteModel, ListModelFeatures, and RequestSampleSizeUpdate.

Examples

# NOT RUN {
  projectId <- "59a5af20c80891534e3c2bde"
  modelId <- "5996f820af07fc605e81ead4"
  GetModel(projectId, modelId)
# }