Skip to navigation

Get a model

View as Markdown

Get one ML model’s training status and results.

Once the newest version’s training job ends, training_log_summary describes the run: how the job exited, how long each phase took, dataset facts such as the size of the holdout split, the final exception, and the most frequent warnings. Read the job’s output with get_ml_model_training_log.

Requires an API key with the read scope.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

ml_model_idstringRequired

Response

OK
idstringformat: "uuid"
namestring
task_typestring
descriptionstring or nullOptional
target_columnstring or nullOptional
feature_columnslist of strings or nullOptional
image_columnslist of strings or nullOptional
problem_typestring or nullOptional
currently_activebooleanOptionalDefaults to false
statusstring or nullOptional
version_numberinteger or nullOptional
dataset_idstring or nullOptionalformat: "uuid"
quality_presetstring or nullOptional
error_messagestring or nullOptional
training_started_atdatetime or nullOptional
training_completed_atdatetime or nullOptional
evaluation_metricsmap from strings to any or nullOptional
training_log_summaryobject or nullOptional

A summary of a training job’s output, built by the training runner from every line the job printed.

exit_signal names the signal that stopped the job. SIGKILL most often means the job ran out of memory. facts holds dataset figures the job reported, such as row counts and the holdout size. error and traceback come from the last exception the job logged or printed. warnings groups warnings by text, most frequent first.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error