GetDatetimeModelFromJobId: Retrieve a new or updated datetime model defined by...

In datarobot: 'DataRobot' Predictive Modeling API

Retrieve a new or updated datetime model defined by modelJobId

Description

The functions RequestNewDatetimeModel and RequestFrozenDatetimeModel initiate the creation of new models in a DataRobot project. Both functions submit requests to the DataRobot modeling engine and return an integer-valued modelJobId. The GetDatetimeModelFromJobId function polls the modeling engine until the model has been built or a specified time limit is exceeded, returning an S3 object of class 'dataRobotDatetimeModel' when the model is available.

Usage

GetDatetimeModelFromJobId(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	The integer returned by either RequestNewDatetimeModel
maxWait	Integer, The maximum time (in seconds) to wait for the model job to complete

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.

Value

An S3 object of class 'dataRobotDatetimeModel' summarizing all available information about the model. See GetDatetimeModel

Examples

## Not run: 
  projectId <- "59a5af20c80891534e3c2bde"
  initialJobs <- ListModelJobs(project)
  job <- initialJobs[[1]]
  modelJobId <- job$modelJobId
  GetDatetimeModelFromJobId(projectId, modelJobId)

## End(Not run)

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