ml.comet.experiment

Class ApiExperiment

java.lang.Object

ml.comet.experiment.BaseExperiment

ml.comet.experiment.ApiExperiment

All Implemented Interfaces:

Experiment

public final class ApiExperiment
extends BaseExperiment

Implementation of the Experiment that allows to read/update existing experiment.

The ApiExperiment should be used to directly read/update data of the existing experiment from the Comet server.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApiExperiment.ApiExperimentBuilderImpl The builder to create properly configured ApiExperiment instance.

Method Summary

Modifier and Type	Method and Description
static ApiExperiment.ApiExperimentBuilderImpl	builder(@NonNull String experimentKey) Returns builder to create ApiExperiment instance.
void	end() Tells Comet that the Experiment is complete and release all associated resources.
protected Connection	getConnection() Returns connection associated with particular experiment.
String	getContext() Gets the current context as recorded in the Experiment object locally.
String	getExperimentKey() Get the experiment key returned by Comet.
Optional<String>	getExperimentLink() Get the experiment link returned by Comet.
String	getExperimentName() Get experiment name.
protected org.slf4j.Logger	getLogger() Returns logger instance associated with particular experiment.
String	getProjectName() Get project name of the experiment.
String	getWorkspaceName() Get workspace name of the experiment.

Methods inherited from class ml.comet.experiment.BaseExperiment

addTag, getAssetList, getGitMetadata, getGraph, getHtml, getLogOther, getMetadata, getMetrics, getOutput, getParameters, getTags, logCode, logCode, logEndTime, logGitMetadata, logGraph, logHtml, logMetric, logOther, logParameter, logStartTime, setExperimentName, uploadAsset, uploadAsset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static ApiExperiment.ApiExperimentBuilderImpl builder(@NonNull
                                                             @NonNull String experimentKey)

Returns builder to create ApiExperiment instance.

Parameters:

experimentKey - the unique identifier of the existing experiment.

Returns:

the initialized ApiExperiment instance.

getConnection

protected Connection getConnection()

Description copied from class: BaseExperiment

Returns connection associated with particular experiment. The subclasses must override this method to provide relevant connection instance.

Specified by:

getConnection in class BaseExperiment

Returns:

the initialized connection associated with particular experiment.

getLogger

protected org.slf4j.Logger getLogger()

Description copied from class: BaseExperiment

Returns logger instance associated with particular experiment. The subclasses should override this method to provide specific logger instance.

Specified by:

getLogger in class BaseExperiment

Returns:

the logger instance associated with particular experiment.

getContext

public String getContext()

Description copied from class: BaseExperiment

Gets the current context as recorded in the Experiment object locally.

Specified by:

getContext in class BaseExperiment

Returns:

the current context which associated with log records of this experiment. TODO: 03.11.2021 this can be made Optional

getWorkspaceName

public String getWorkspaceName()

Description copied from interface: Experiment

Get workspace name of the experiment.

Returns:

the workspace name of the experiment.

getProjectName

public String getProjectName()

Description copied from interface: Experiment

Get project name of the experiment.

Returns:

the project name of the experiment.

getExperimentName

public String getExperimentName()

Description copied from interface: Experiment

Get experiment name.

Returns:

the name of the experiment.

end

public void end()

Description copied from interface: Experiment

Tells Comet that the Experiment is complete and release all associated resources.

getExperimentKey

public String getExperimentKey()

Description copied from interface: Experiment

Get the experiment key returned by Comet.

Returns:

the experiment key assigned by Comet

getExperimentLink

public Optional<String> getExperimentLink()

Description copied from interface: Experiment

Get the experiment link returned by Comet.

Returns:

the experiment link assigned by Comet.