mlos_bench.environments.status

Enum for the status of the benchmark/environment.

Classes

Status

Enum for the status of the benchmark/environment.

Module Contents

class mlos_bench.environments.status.Status(*args, **kwds)[source]

Bases: enum.Enum

Enum for the status of the benchmark/environment.

is_canceled() bool[source]

Check if the status of the benchmark/environment is CANCELED.

Return type:

bool

is_completed() bool[source]

Check if the status of the benchmark/environment is one of {SUCCEEDED, CANCELED, FAILED, TIMED_OUT}.

Return type:

bool

is_failed() bool[source]

Check if the status of the benchmark/environment is FAILED.

Return type:

bool

is_good() bool[source]

Check if the status of the benchmark/environment is good.

Return type:

bool

is_pending() bool[source]

Check if the status of the benchmark/environment is PENDING.

Return type:

bool

is_ready() bool[source]

Check if the status of the benchmark/environment is READY.

Return type:

bool

is_succeeded() bool[source]

Check if the status of the benchmark/environment is SUCCEEDED.

Return type:

bool

is_timed_out() bool[source]

Check if the status of the benchmark/environment is TIMED_OUT.

Return type:

bool

CANCELED = 5[source]
FAILED = 6[source]
PENDING = 1[source]
READY = 2[source]
RUNNING = 3[source]
SUCCEEDED = 4[source]
TIMED_OUT = 7[source]
UNKNOWN = 0[source]