Get Training Status

Returns the status of a training job. Use the progress field to determine how far the training has progressed. When training completes successfully, the status is SUCCEEDED and the progress is 1.

Response Body

Name

Type

Description

Available Version

algorithm

string

Algorithm used to create the model. Returned only when the modelType is text-intent.

2.0

createdAt

date

Date and time that the model was created.

2.0

datasetId

long

ID of the dataset trained to create the model.

2.0

datasetVersionId

int

N/A

2.0

earlyStopping

boolean

Specifies whether the training process stopped before completing all the epochs. The training process stops before the specified number of epochs when the model has reached the optimal accuracy. The lastEpochDone value specifies the last training iteration.

2.0

epochs

int

Number of epochs used during training.

2.0

failureMsg

string

Reason the dataset training failed. Returned only if the training status is FAILED.

2.0

lastEpochDone

int

Last training iteration performed.

2.0

language

string

Model language inherited from the dataset language.

2.0

learningRate

float

N/A for intent and sentiment models.

2.0

modelId

string

ID of the model. Contains letters and numbers.

2.0

modelType

string

Type of data from which the model was created. Valid values are:

  • text-intent
  • text-sentiment

2.0

name

string

Name of the model.

2.0

object

string

Object returned; in this case, training.

2.0

progress

float

How far the training job has progressed. Values are between 0–1.

2.0

queuePosition

int

Where the training job is in the queue. This field appears in the response only if the status is QUEUED.

2.0

status

string

Status of the training job. Valid values are:

  • QUEUED—The training job is in the queue.
  • RUNNING—The training job is running.
  • SUCCEEDED—The training job succeeded, and you can use the model.
  • FAILED—The training job failed.

2.0

trainParams

string

Training parameters passed into the request.

2.0

trainStats

object

Statistics about the training.

2.0

updatedAt

string

Date and time that the model was last updated.

2.0

trainStats Response Body

Name

Type

Description

Available Version

datasetLoadTime

string
in HH:MM:SS:SSS format

Time it took to load the dataset to be trained.

2.0

earlyStopping

boolean

Specifies whether the training process stopped before completing all the epochs. The training process stops before the specified number of epochs when the model has reached the optimal accuracy. The lastEpochDone value specifies the last training iteration.

2.0

examples

int

Total number of examples in the dataset from which the model was created.

2.0

globalResourceDownloadTime

string
in HH:MM:SS:SSS format

Time it took to load global resources. Returned only when modelType is image-detection, text-intent, or text-sentiment.

2.0

labels

int

Total number of labels in the dataset from which the model was created.

2.0

lastEpochDone

int

Number of the last training iteration that completed.

2.0

modelSaveTime

string
in HH:MM:SS:SSS format

Time it took to save the model.

2.0

testSplitSize

int

Number of examples (from the dataset total number of examples) used to test the model. testSplitSize + trainSplitSize is equal to examples.

2.0

totalTime

string
in HH:MM:SS:SSS format

Total training time: datasetLoadTime + trainingTime + modelSaveTime + globalResourceDownloadTime

2.0

trainingTime

string
in HH:MM:SS:SSS format

Time it took to train the dataset to create the model.

2.0

trainSplitSize

int

Number of examples (from the dataset total number of examples) used to train the model. trainSplitSize + testSplitSize is equal to examples.

2.0

Language