org.opensearch.ml.common.MLTaskState Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opensearch-ml-common Show documentation

OpenSearch ML Common

The newest version!

/*
 * Copyright OpenSearch Contributors
 * SPDX-License-Identifier: Apache-2.0
 */

package org.opensearch.ml.common;

/**
 * ML task states.
 * 
 * CREATED:
 *     When user send a machine-learning(ML) request(training/inference), we will create one task to track
 *     ML task execution and set its state as CREATED
 *
 * 
RUNNING:
 *     Once MLTask is dispatched to work node and start to run corresponding ML algorithm, we will set the task state as RUNNING
 *
 * 
COMPLETED:
 *     When all training/inference completed, we will set task state as COMPLETED
 *
 * 
FAILED:
 *     If any exception happen, we will set task state as FAILED
 * 
 */
public enum MLTaskState {
    CREATED,
    RUNNING,
    COMPLETED,
    FAILED,
    CANCELLED,
    COMPLETED_WITH_ERROR,
    CANCELLING,
    EXPIRED
}