superbenchmark/superbench/benchmarks/return_code.py

# Copyright (c) Microsoft Corporation.
# Licensed under the MIT license.

"""A module for statuses of benchmarks."""

from superbench.benchmarks.context import Enum


class ReturnCode(Enum):
    """The Enum class representing benchmark status."""
    # Common return codes.
    SUCCESS = 0
    INVALID_ARGUMENT = 1
    INVALID_BENCHMARK_TYPE = 2
    INVALID_BENCHMARK_RESULT = 3
    RUNTIME_EXCEPTION_ERROR = 4
    KILLED_BY_TIMEOUT = 124
    # Return codes related to model benchmarks.
    NO_SUPPORTED_PRECISION = 10
    DISTRIBUTED_SETTING_INIT_FAILURE = 13
    DISTRIBUTED_SETTING_DESTROY_FAILURE = 14
    DATASET_GENERATION_FAILURE = 15
    DATALOADER_INIT_FAILURE = 16
    OPTIMIZER_CREATION_FAILURE = 17
    MODEL_CREATION_FAILURE = 18
    # Return codes related to micro benchmarks.
    MICROBENCHMARK_BINARY_NAME_NOT_SET = 30
    MICROBENCHMARK_BINARY_NOT_EXIST = 31
    MICROBENCHMARK_EXECUTION_FAILURE = 32
    MICROBENCHMARK_RESULT_PARSING_FAILURE = 33
    MICROBENCHMARK_UNSUPPORTED_ARCHITECTURE = 34
    MICROBENCHMARK_DEVICE_GETTING_FAILURE = 35
    MICROBENCHMARK_MPI_INIT_FAILURE = 36
    # Return codes related to docker benchmarks.
    DOCKERBENCHMARK_IMAGE_NOT_SET = 50
    DOCKERBENCHMARK_CONTAINER_NOT_SET = 51
    DOCKERBENCHMARK_IMAGE_PULL_FAILURE = 52
    DOCKERBENCHMARK_EXECUTION_FAILURE = 53
    DOCKERBENCHMARK_RESULT_PARSING_FAILURE = 54