coretex.coretex.experiment.executing_experiment.ExecutingExperiment Class Reference

Inheritance diagram for coretex.coretex.experiment.executing_experiment.ExecutingExperiment:

Public Member Functions
DatasetType	dataset (self)
Public Member Functions inherited from coretex.coretex.experiment.experiment.Experiment
Dict[str, Any]	parameters (self)
str	projectPath (self)
bool	updateStatus (self, ExperimentStatus status, Optional[str] message=None, bool notifyServer=True)
List[Metric]	createMetrics (self, List[Tuple[str, str, MetricType, str, MetricType]] values)
bool	submitMetrics (self, Dict[str, Tuple[float, float]] metricValues)
bool	downloadProject (self)
Optional[Artifact]	createArtifact (self, str localFilePath, str remoteFilePath, Optional[str] mimeType=None)
Self	startCustomExperiment (cls, int projectId, Union[int, str] nodeId, Optional[str] name, Optional[str] description=None, Optional[List[Dict[str, Any]]] parameters=None)

Static Public Member Functions
ExecutingExperiment	current ()

Detailed Description

    Represents the instance of the currently executing Experiment on Coretex.ai

    Example
    -------
    >>> from coretex import ExecutingExperiment
    \b
    >>> experiment: ExecutingExperiment[DatasetType] = ExecutingExperiment.current()
    >>> print(experiment.id)
    1023

Definition at line 94 of file executing_experiment.py.

Member Function Documentation

current()

ExecutingExperiment coretex.coretex.experiment.executing_experiment.ExecutingExperiment.current ( )

static

    Returns
    -------
    ExecutingExperiment -> currently executing Experiment instance

Definition at line 111 of file executing_experiment.py.

    def current() -> ExecutingExperiment:
        """
            Returns
            -------
            ExecutingExperiment -> currently executing Experiment instance
        """
 
        if ExecutingExperiment.__currentExperiment is None:
            raise ValueError(">> [Coretex] Tried to access current experiment, but no experiment is executing")
 
        return ExecutingExperiment.__currentExperiment
 

dataset()

DatasetType coretex.coretex.experiment.executing_experiment.ExecutingExperiment.dataset

(

self

)

    If there is no parameter with name "dataset" calling this will raise an exception

    Returns
    -------
    Dataset object if there was a parameter with name "dataset" entered when the experiment was started

Definition at line 139 of file executing_experiment.py.

    def dataset(self) -> DatasetType:
        """
            If there is no parameter with name "dataset" calling this will raise an exception
 
            Returns
            -------
            Dataset object if there was a parameter with name "dataset" entered when the experiment was started
        """
        return self.parameters["dataset"]  # type: ignore

---

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

• src/coretex/coretex/experiment/executing_experiment.py