mlos_bench.environments.status module¶

Enum for the status of the benchmark/environment.

class mlos_bench.environments.status.Status(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)¶

Bases: Enum

Enum for the status of the benchmark/environment.

CANCELED = 5¶

FAILED = 6¶

PENDING = 1¶

READY = 2¶

RUNNING = 3¶

SUCCEEDED = 4¶

TIMED_OUT = 7¶

UNKNOWN = 0¶

is_canceled() → bool¶: Check if the status of the benchmark/environment is CANCELED.

is_completed() → bool¶: Check if the status of the benchmark/environment is one of {SUCCEEDED, CANCELED, FAILED, TIMED_OUT}.

is_failed() → bool¶: Check if the status of the benchmark/environment is FAILED.

is_good() → bool¶: Check if the status of the benchmark/environment is good.

is_pending() → bool¶: Check if the status of the benchmark/environment is PENDING.

is_ready() → bool¶: Check if the status of the benchmark/environment is READY.

is_succeeded() → bool¶: Check if the status of the benchmark/environment is SUCCEEDED.

is_timed_out() → bool¶: Check if the status of the benchmark/environment is TIMED_OUT.