Retrieve status of Autopilot modeling jobs that are not complete

Description

This function requests information on DataRobot Autopilot modeling tasks that are not complete, for one of three reasons: the task is running and has not yet completed; the task is queued and has not yet been started; or, the task has terminated due to an error.

Usage

1
GetModelJobs(project, status = NULL)

Arguments

project

Either (1) a character string giving the unique alphanumeric identifier for the project, or (2) a list containing the element projectId with this identifier.

status

The status of the desired jobs: one of JobStatus$Queue, JobStatus$InProgress, or JobStatus$Error. If NULL (default), queued and inprogress jobs are returned.

Details

The jobStatus variable specifies which of the three groups of modeling tasks is of interest. Specifically, if jobStatus has the value 'inprogress', the request returns information about modeling tasks that are running but not yet complete; if jobStatus has the value 'queue', the request returns information about modeling tasks that are scheduled to run but have not yet started; if jobStatus has the value 'error', the request returns information about modeling tasks that have terminated due to an error. By default, jobStatus is NULL, which means jobs with status "inprogress" or "queue" are returned, but not those with status "error".

Value

A list of lists with one element for each modeling task in the group being queried; if there are no tasks in the class being queried, an empty list is returned. If the group is not empty, a list is returned with the following nine elements:

status

Prediction job status; one of JobStatus$Queue, JobStatus$InProgress, or JobStatus$Error

processes

List of character vectors describing any preprocessing applied, possibly along with the model type

projectId

Character string giving the unique identifier for the project

samplePct

Numeric: the percentage of the dataset used in constructing the training dataset for model building

modelType

Character string specifying the model type

modelCategory

Character string: what kind of model this is - 'prime' for DataRobot Prime models, 'blend' for blender models, and 'model' for other models

featurelistId

Character string identifying the featurelist used in fitting the model (derived from the modeling dataset)

blueprintId

Character string identifying the DataRobot blueprint on which the model is based

modelJobId

Character: id of the job

modelId

Character string uniquely identifying the model

Want to suggest features or report bugs for rdrr.io? Use the GitHub issue tracker.