client.models.get_builds

A method of the Models endpoint.

get_builds(id: int, build_id: int) → Response

Check status of a build

API URL: GET /models/{id}/builds/{build_id}

import civis
client = civis.APIClient()
response = client.models.get_builds(...)

Parameters:

Returns:

civis.Response

idint
The ID of the model build.
statestr
The state of the model build.one of ‘queued’ ‘running’ ‘succeeded’ ‘failed’ or ‘cancelled’.
errorstr
The error, if any, returned by the build.
namestr
The name of the model build.
created_atstr
The time the model build was created.
descriptionstr
A description of the model build.
root_mean_squared_errorfloat (float)
A key metric for continuous models. Nil for other model types.
r_squared_errorfloat (float)
A key metric for continuous models. Nil for other model types.
roc_aucfloat (float)
A key metric for binary, multinomial, and ordinal models. Nil for other model types.
transformation_metadatastr
A string representing the full JSON output of the metadata for transformation of column names
outputstr
A string representing the JSON output for the specified build. Only present when smaller than 10KB in size.
output_locationstr
A URL representing the location of the full JSON output for the specified build.The URL link will be valid for 5 minutes.