coretex.coretex.experiment.status.ExperimentStatus Class Reference

Inherits IntEnum.

Public Member Functions
str	defaultMessage (self)
bool	isFinal (self)

Detailed Description

    List of possible Experiment statuses during the Experiment lifetime

Definition at line 21 of file status.py.

Member Function Documentation

defaultMessage()

str coretex.coretex.experiment.status.ExperimentStatus.defaultMessage

(

self

)

    List of supported statuses:
    - preparingToStart : Experiment preparing to start
    - completedWithSuccess : Experiment is completed without errors
    - completedWithError : Experiment is completed with error
    - stopped : Experiment is stopped manually
    - stopping : Experiment is stopping

    Returns
    -------
    str -> Appropriate message based on Experiment status

    Raises
    ------
    ValueError -> if unsupported status is provided

Definition at line 38 of file status.py.

    def defaultMessage(self) -> str:
        """
            List of supported statuses:
            - preparingToStart : Experiment preparing to start
            - completedWithSuccess : Experiment is completed without errors
            - completedWithError : Experiment is completed with error
            - stopped : Experiment is stopped manually
            - stopping : Experiment is stopping
 
            Returns
            -------
            str -> Appropriate message based on Experiment status
 
            Raises
            ------
            ValueError -> if unsupported status is provided
        """
 
        if self == ExperimentStatus.preparingToStart:
            return "Preparing to start the experiment."
 
        if self == ExperimentStatus.completedWithSuccess:
            return "Experiment completed successfully."
 
        if self == ExperimentStatus.completedWithError:
            return "Experiment execution was interrupted due to an error. View experiment console for more details."
 
        if self == ExperimentStatus.stopped:
            return "Experiment execution was stopped by request from the user."
 
        if self == ExperimentStatus.stopping:
            return "Stopping the experiment."
 
        raise ValueError(f">> [Coretex] {self.name} has no default message")
 

isFinal()

bool coretex.coretex.experiment.status.ExperimentStatus.isFinal

(

self

)

    List of final statuses:
    - ExperimentStatus.completedWithSuccess : Experiment finished without error
    - ExperimentStatus.completedWithError : Experiment finished with an error
    - ExperimentStatus.stopped : Experiment is manually stopped

    Returns
    -------
    bool -> True if a status is a final status for a experiment

Definition at line 74 of file status.py.

    def isFinal(self) -> bool:
        """
            List of final statuses:
            - ExperimentStatus.completedWithSuccess : Experiment finished without error
            - ExperimentStatus.completedWithError : Experiment finished with an error
            - ExperimentStatus.stopped : Experiment is manually stopped
 
            Returns
            -------
            bool -> True if a status is a final status for a experiment
        """
 
        return (
                self == ExperimentStatus.completedWithSuccess or
                self == ExperimentStatus.completedWithError or
                self == ExperimentStatus.stopped
        )

---

The documentation for this class was generated from the following file:

• src/coretex/coretex/experiment/status.py