Learn R Programming

datarobot (version 2.8.0)

GetBlenderModelFromJobId: Retrieve a new or updated blender model defined by modelJobId

Description

The function RequestBlender initiates the creation of new blender models in a DataRobot project. It submits requests to the DataRobot modeling engine and returns an integer-valued modelJobId. The GetBlenderModelFromJobId function polls the modeling engine until the model has been built or a specified time limit is exceeded, returning an S3 object of class 'dataRobotBlenderModel' when the model is available.

Usage

GetBlenderModelFromJobId(project, modelJobId, 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.

modelJobId

integer. The integer returned by RequestBlender.

maxWait

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

Value

An S3 object of class 'dataRobotBlenderModel' summarizing all available information about the model. It 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,

  • 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.

  • modelIds. Character string giving the unique alphanumeric model identifier of blended models.

  • blenderMethod. Character string describing blender method.

  • id. Character string giving the unique alphanumeric blender model identifier.

Details

Motivation for this function is the fact that some models - e.g., very complex machine learning models fit to large datasets - may take a long time to complete. Splitting the model creation request from model retrieval in these cases allows the user to perform other interactive R session tasks between the time the model creation/update request is made and the time the final model is available.

Examples

Run this code
# NOT RUN {
  projectId <- "59a5af20c80891534e3c2bde"
  modelsToBlend <- c("5996f820af07fc605e81ead4", "59a5ce3301e9f0296721c64c")
  blendJobId <- RequestBlender(projectId, modelId, "GLM")
  GetBlenderModelFromJobId(projectId, blendJobId)
# }

Run the code above in your browser using DataLab