Cancel training

View as Markdown

Cancel the model’s in-flight training runs.

Overlapping retrains can leave several versions pending or training at once, so the cancel is model-wide: every in-flight version is marked ‘cancelled’ and its cloud training jobs are stopped. Returns 400 when no training is pending or running.

Requires an API key with the write 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

Errors

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