ml.comet.experiment.impl

Class ApiExperimentImpl

java.lang.Object

ml.comet.experiment.impl.ApiExperimentImpl

All Implemented Interfaces:

AutoCloseable, ApiExperiment, Experiment

public final class ApiExperimentImpl
extends Object
implements ApiExperiment

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
void	addTag(@NonNull String tag) Synchronous version that waits for result or exception.
static ApiExperimentImpl.ApiExperimentBuilderImpl	builder() Returns builder to create Experiment instance.
static ApiExperimentImpl.ApiExperimentBuilderImpl	builder(@NonNull String experimentKey) Returns builder to create Experiment instance.
void	close()
void	end() Tells Comet that the Experiment is complete and release all associated resources.
List<LoggedExperimentAsset>	getAllAssetList() Get list of all logged experiment assets.
LoggedArtifact	getArtifact(@NonNull String name) Allows looking for logged artifact using provided search parameters.
LoggedArtifact	getArtifact(@NonNull String name, @NonNull String workspace) Allows looking for logged artifact using provided search parameters.
LoggedArtifact	getArtifact(@NonNull String name, @NonNull String workspace, @NonNull String versionOrAlias) Allows looking for logged artifact using provided search parameters.
List<LoggedExperimentAsset>	getAssetList(@NonNull String type) Get list of the logged experiment assets with particular type.
String	getExperimentKey() Get the experiment key returned by Comet.
Optional<String>	getExperimentLink() Get the experiment link returned by Comet.
String	getExperimentName() Get experiment name.
GitMetaData	getGitMetadata() Get experiment git metadata.
Optional<String>	getGraph() Get experiment graph data.
Optional<String>	getHtml() Get experiment html.
protected abstract org.slf4j.Logger	getLogger() Returns logger instance associated with particular experiment.
List<Value>	getLogOther() Get experiment log other data.
ExperimentMetadata	getMetadata() Get experiment metadata.
List<Value>	getMetrics() Get experiment metrics.
Optional<String>	getOutput() Get experiment output data.
List<Value>	getParameters() Get experiment parameters.
String	getProjectName() Get project name of the experiment.
List<String>	getTags() Get experiment tags.
String	getWorkspaceName() Get workspace name of the experiment.
void	logCode(File file) Allows you to report code for the experiment.
void	logCode(@NonNull File file, @NonNull ExperimentContext context) Allows you to report code for the experiment.
void	logCode(String code, String logicalPath) Allows you to report code for the experiment.
void	logCode(@NonNull String code, @NonNull String logicalPath, @NonNull ExperimentContext context) Allows you to report code for the experiment.
void	logCurve(@NonNull Curve curve)
void	logCurve(@NonNull Curve curve, boolean overwrite)
void	logCurve(@NonNull Curve curve, boolean overwrite, @NonNull ExperimentContext context) Allows to log x/y curve into your Comet experiment.
void	logEndTime(long endTimeMillis) Synchronous version that waits for result or exception.
void	logGitMetadata(GitMetaData gitMetaData) Synchronous version that waits for result or exception.
void	logGraph(@NonNull String graph) Synchronous version that waits for result or exception.
void	logHtml(@NonNull String html, boolean override) Synchronous version that waits for result or exception.
void	logLine(String line, long offset, boolean stderr, String context) Synchronous version that waits for result or exception.
void	logMetric(@NonNull String metricName, @NonNull Object metricValue, @NonNull ExperimentContext context) Synchronous version that waits for result or exception.
void	logMetric(String metricName, Object metricValue, long step, long epoch) Logs a metric with Comet.
void	logOther(@NonNull String key, @NonNull Object value) Synchronous version that waits for result or exception.
void	logParameter(String parameterName, Object paramValue, ExperimentContext context) Synchronous version that waits for result or exception.
void	logParameter(String parameterName, Object paramValue, long step) Logs a param with Comet.
void	logStartTime(long startTimeMillis) Synchronous version that waits for result or exception.
void	logText(String text)
void	logText(String text, @NonNull ExperimentContext context)
void	logText(@NonNull String text, @NonNull ExperimentContext context, Map<String,Object> metadata) Allows to log additional textual data associated with Comet Experiment.
void	setExperimentName(@NonNull String experimentName) Sets the experiment name.
void	uploadAsset(@NonNull File asset, boolean overwrite, @NonNull ExperimentContext context) Upload an asset to be associated with the experiment, for example the trained weights of a neural net.
void	uploadAsset(@NonNull File asset, boolean overwrite, long step, long epoch) Upload an asset to be associated with the experiment, for example the trained weights of a neural net.
void	uploadAsset(@NonNull File file, @NonNull String logicalPath, boolean overwrite, @NonNull ExperimentContext context) Upload an asset to be associated with the experiment, for example the trained weights of a neural net.
void	uploadAsset(@NonNull File asset, String logicalPath, boolean overwrite, long step, long epoch) Upload an asset to be associated with the experiment, for example the trained weights of a neural net.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ml.comet.experiment.Experiment

addTag, getAllAssetList, getArtifact, getArtifact, getArtifact, getAssetList, getExperimentKey, getGitMetadata, getGraph, getHtml, getLogOther, getMetadata, getMetrics, getOutput, getParameters, getTags, logCode, logCode, logCode, logCode, logCurve, logCurve, logCurve, logEndTime, logGitMetadata, logGraph, logHtml, logLine, logMetric, logMetric, logOther, logParameter, logParameter, logStartTime, logText, logText, logText, setExperimentName, uploadAsset, uploadAsset, uploadAsset, uploadAsset

Method Detail

getWorkspaceName

public String getWorkspaceName()

Description copied from interface: Experiment

Get workspace name of the experiment.

Specified by:

getWorkspaceName in interface Experiment

Returns:

the workspace name of the experiment.

getProjectName

public String getProjectName()

Description copied from interface: Experiment

Get project name of the experiment.

Specified by:

getProjectName in interface Experiment

Returns:

the project name of the experiment.

getExperimentName

public String getExperimentName()

Description copied from interface: Experiment

Get experiment name.

Specified by:

getExperimentName in interface Experiment

Returns:

the name of the experiment.

getExperimentLink

public Optional<String> getExperimentLink()

Description copied from interface: Experiment

Get the experiment link returned by Comet.

Specified by:

getExperimentLink in interface Experiment

Returns:

the experiment link assigned by Comet.

end

public void end()

Description copied from interface: Experiment

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

Specified by:

end in interface Experiment

close

public void close()

Specified by:

close in interface AutoCloseable

builder

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

Returns builder to create Experiment instance.

Parameters:

experimentKey - the unique identifier of the existing experiment.

Returns:

the initialized ApiExperimentBuilder instance.

builder

public static ApiExperimentImpl.ApiExperimentBuilderImpl builder()

Returns builder to create Experiment instance.

Returns:

the initialized ApiExperimentBuilder instance.

getLogger

protected abstract org.slf4j.Logger getLogger()

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

Returns:

the logger instance associated with particular experiment.

getExperimentKey

public String getExperimentKey()

Description copied from interface: Experiment

Get the experiment key returned by Comet.

Specified by:

getExperimentKey in interface Experiment

Returns:

the experiment key assigned by Comet

setExperimentName

public void setExperimentName(@NonNull
                              @NonNull String experimentName)

Description copied from interface: Experiment

Sets the experiment name.

Specified by:

setExperimentName in interface Experiment

Parameters:

experimentName - The new name for the experiment

logMetric

public void logMetric(@NonNull
                      @NonNull String metricName,
                      @NonNull
                      @NonNull Object metricValue,
                      @NonNull
                      @NonNull ExperimentContext context)

Synchronous version that waits for result or exception. Also, it checks the response status for failure.

Specified by:

logMetric in interface Experiment

Parameters:

metricName - The name for the metric to be logged

metricValue - The new value for the metric. If the values for a metric are plottable we will plot them

context - the context to be associated with the parameter.

Throws:

CometApiException - if received response with failure code.

logMetric

public void logMetric(String metricName,
                      Object metricValue,
                      long step,
                      long epoch)

Description copied from interface: Experiment

Logs a metric with Comet. For running experiment updates current step to one from param! Metrics are generally values that change from step to step.

Specified by:

logMetric in interface Experiment

Parameters:

metricName - The name for the metric to be logged

metricValue - The new value for the metric. If the values for a metric are plottable we will plot them

step - The current step for this metric, this will set the given step for this experiment

epoch - The current epoch for this metric, this will set the given epoch for this experiment.

logParameter

public void logParameter(String parameterName,
                         Object paramValue,
                         ExperimentContext context)

Synchronous version that waits for result or exception. Also, it checks the response status for failure.

Specified by:

logParameter in interface Experiment

Parameters:

parameterName - The name of the param being logged

paramValue - The value for the param being logged

context - the context to be associated with the parameter.

logParameter

public void logParameter(String parameterName,
                         Object paramValue,
                         long step)

Description copied from interface: Experiment

Logs a param with Comet. For running experiment updates current step to one from param! Params should be set at the start of the experiment.

Specified by:

logParameter in interface Experiment

Parameters:

parameterName - The name of the param being logged

paramValue - The value for the param being logged

step - The current step for this metric, this will set the given step for this experiment.

logLine

public void logLine(String line,
                    long offset,
                    boolean stderr,
                    String context)

Synchronous version that waits for result or exception. Also, it checks the response status for failure.

Specified by:

logLine in interface Experiment

Parameters:

line - Text to be logged

offset - Offset describes the place for current text to be inserted

stderr - the flag to indicate if this is StdErr message.

context - the context to be associated with the parameter.

logHtml

public void logHtml(@NonNull
                    @NonNull String html,
                    boolean override)

Synchronous version that waits for result or exception. Also, it checks the response status for failure.

Specified by:

logHtml in interface Experiment

Parameters:

html - A block of html to be sent to Comet

override - Whether previous html sent should be deleted. If true the old html will be deleted.

logOther

public void logOther(@NonNull
                     @NonNull String key,
                     @NonNull
                     @NonNull Object value)

Synchronous version that waits for result or exception. Also, it checks the response status for failure.

Specified by:

logOther in interface Experiment

Parameters:

key - The key for the data to be stored

value - The value for said key

addTag

public void addTag(@NonNull
                   @NonNull String tag)

Synchronous version that waits for result or exception. Also, it checks the response status for failure.

Specified by:

addTag in interface Experiment

Parameters:

tag - The tag to be added

logGraph

public void logGraph(@NonNull
                     @NonNull String graph)

Synchronous version that waits for result or exception. Also, it checks the response status for failure.

Specified by:

logGraph in interface Experiment

Parameters:

graph - The graph to be logged.

logStartTime

public void logStartTime(long startTimeMillis)

Synchronous version that waits for result or exception. Also, it checks the response status for failure.

Specified by:

logStartTime in interface Experiment

Parameters:

startTimeMillis - When you want to say that the experiment started

logEndTime

public void logEndTime(long endTimeMillis)

Synchronous version that waits for result or exception. Also, it checks the response status for failure.

Specified by:

logEndTime in interface Experiment

Parameters:

endTimeMillis - When you want to say that the experiment ended

logGitMetadata

public void logGitMetadata(GitMetaData gitMetaData)

Synchronous version that waits for result or exception. Also, it checks the response status for failure.

Specified by:

logGitMetadata in interface Experiment

Parameters:

gitMetaData - The Git Metadata for the experiment.

logCode

public void logCode(@NonNull
                    @NonNull String code,
                    @NonNull
                    @NonNull String logicalPath,
                    @NonNull
                    @NonNull ExperimentContext context)

Description copied from interface: Experiment

Allows you to report code for the experiment.

Specified by:

logCode in interface Experiment

Parameters:

code - Code to be sent to Comet

logicalPath - Name of source file to be displayed on UI 'code' tab

context - the context to be associated with the asset.

logCode

public void logCode(String code,
                    String logicalPath)

Description copied from interface: Experiment

Allows you to report code for the experiment.

Specified by:

logCode in interface Experiment

Parameters:

code - Code to be sent to Comet

logicalPath - Name of source file to be displayed on UI 'code' tab

logCode

public void logCode(@NonNull
                    @NonNull File file,
                    @NonNull
                    @NonNull ExperimentContext context)

Description copied from interface: Experiment

Allows you to report code for the experiment.

Specified by:

logCode in interface Experiment

Parameters:

file - Asset with source code to be sent

context - the context to be associated with the asset.

logCode

public void logCode(File file)

Description copied from interface: Experiment

Allows you to report code for the experiment.

Specified by:

logCode in interface Experiment

Parameters:

file - Asset with source code to be sent

logText

public void logText(@NonNull
                    @NonNull String text,
                    @NonNull
                    @NonNull ExperimentContext context,
                    Map<String,Object> metadata)

Description copied from interface: Experiment

Allows to log additional textual data associated with Comet Experiment. These strings appear on the Text Tab in the Comet UI.

Specified by:

logText in interface Experiment

Parameters:

text - the text data to be logged.

context - the current experiment context to be associated.

metadata - the additional metadata for the text.

logText

public void logText(String text,
                    @NonNull
                    @NonNull ExperimentContext context)

Specified by:

logText in interface Experiment

logText

public void logText(String text)

Specified by:

logText in interface Experiment

logCurve

public void logCurve(@NonNull
                     @NonNull Curve curve,
                     boolean overwrite,
                     @NonNull
                     @NonNull ExperimentContext context)

Description copied from interface: Experiment

Allows to log x/y curve into your Comet experiment. This can be, for example, the time-series data, etc.

Specified by:

logCurve in interface Experiment

Parameters:

curve - the Curve object holding the data points.

overwrite - allows to override the previously logged curve with the same name.

context - the experiment context to be associated with data record (step, epoch, context ID).

logCurve

public void logCurve(@NonNull
                     @NonNull Curve curve,
                     boolean overwrite)

Specified by:

logCurve in interface Experiment

logCurve

public void logCurve(@NonNull
                     @NonNull Curve curve)

Specified by:

logCurve in interface Experiment

uploadAsset

public void uploadAsset(@NonNull
                        @NonNull File file,
                        @NonNull
                        @NonNull String logicalPath,
                        boolean overwrite,
                        @NonNull
                        @NonNull ExperimentContext context)

Description copied from interface: Experiment

Upload an asset to be associated with the experiment, for example the trained weights of a neural net. For running experiment updates current step to one from param!

Specified by:

uploadAsset in interface Experiment

Parameters:

file - The asset to be stored

logicalPath - The file name under which the asset should be stored in Comet. E.g. "someFile.txt"

overwrite - Whether to overwrite files of the same name in Comet

context - the context to be associated with the asset.

uploadAsset

public void uploadAsset(@NonNull
                        @NonNull File asset,
                        String logicalPath,
                        boolean overwrite,
                        long step,
                        long epoch)

Description copied from interface: Experiment

Upload an asset to be associated with the experiment, for example the trained weights of a neural net. For running experiment updates current step to one from param!

Specified by:

uploadAsset in interface Experiment

Parameters:

asset - The asset to be stored

logicalPath - The file name under which the asset should be stored in Comet. E.g. "someFile.txt"

overwrite - Whether to overwrite files of the same name in Comet

step - the step to be associated with the asset

epoch - the epoch to be associated with the asset

uploadAsset

public void uploadAsset(@NonNull
                        @NonNull File asset,
                        boolean overwrite,
                        @NonNull
                        @NonNull ExperimentContext context)

Description copied from interface: Experiment

Upload an asset to be associated with the experiment, for example the trained weights of a neural net. For running experiment updates current step to one from param!

Specified by:

uploadAsset in interface Experiment

Parameters:

asset - The file asset to be stored. The name of the file will be used as assets identifier on Comet.

overwrite - Whether to overwrite files of the same name in Comet

context - the context to be associated with the asset.

uploadAsset

public void uploadAsset(@NonNull
                        @NonNull File asset,
                        boolean overwrite,
                        long step,
                        long epoch)

Description copied from interface: Experiment

Upload an asset to be associated with the experiment, for example the trained weights of a neural net. For running experiment updates current step to one from param!

Specified by:

uploadAsset in interface Experiment

Parameters:

asset - The file asset to be stored. The name of the file will be used as assets identifier on Comet.

overwrite - Whether to overwrite files of the same name in Comet

step - the step to be associated with the asset

epoch - the epoch to be associated with the asset

getArtifact

public LoggedArtifact getArtifact(@NonNull
                                  @NonNull String name,
                                  @NonNull
                                  @NonNull String workspace,
                                  @NonNull
                                  @NonNull String versionOrAlias)
                           throws ArtifactException

Description copied from interface: Experiment

Allows looking for logged artifact using provided search parameters.

Specified by:

getArtifact in interface Experiment

Parameters:

name - the short name of the artifact like 'artifact-name'.

workspace - the workspace where artifact was saved.

versionOrAlias - the artifact version or alias to be returned.

Returns:

the LoggedArtifact instance.

Throws:

ArtifactException - if failed to get comet artifact.

getArtifact

public LoggedArtifact getArtifact(@NonNull
                                  @NonNull String name,
                                  @NonNull
                                  @NonNull String workspace)
                           throws ArtifactException

Description copied from interface: Experiment

Allows looking for logged artifact using provided search parameters.

Specified by:

getArtifact in interface Experiment

Parameters:

name - the short name of the artifact like 'artifact-name' or the name of artifact with version or alias like 'artifact-name:versionOrAlias'.

workspace - the workspace where artifact was saved.

Returns:

the LoggedArtifact instance.

Throws:

ArtifactException - if failed to get comet artifact.

getArtifact

public LoggedArtifact getArtifact(@NonNull
                                  @NonNull String name)
                           throws ArtifactException

Description copied from interface: Experiment

Allows looking for logged artifact using provided search parameters.

Specified by:

getArtifact in interface Experiment

Parameters:

name - the name of the artifact. This could either be a fully qualified artifact name like 'workspace/artifact-name:versionOrAlias' or any short forms like 'artifact-name', 'artifact-name:versionOrAlias'.

Returns:

the LoggedArtifact instance.

Throws:

ArtifactException - if failed to get comet artifact.

getMetadata

public ExperimentMetadata getMetadata()

Description copied from interface: Experiment

Get experiment metadata.

Specified by:

getMetadata in interface Experiment

Returns:

the metadata associated with experiment.

getGitMetadata

public GitMetaData getGitMetadata()

Description copied from interface: Experiment

Get experiment git metadata.

Specified by:

getGitMetadata in interface Experiment

Returns:

the GIT metadata for this experiment.

getHtml

public Optional<String> getHtml()

Description copied from interface: Experiment

Get experiment html.

Specified by:

getHtml in interface Experiment

Returns:

the HTML of the experiment.

getOutput

public Optional<String> getOutput()

Description copied from interface: Experiment

Get experiment output data.

Specified by:

getOutput in interface Experiment

Returns:

the output data of the experiment.

getGraph

public Optional<String> getGraph()

Description copied from interface: Experiment

Get experiment graph data.

Specified by:

getGraph in interface Experiment

Returns:

the graph data associated with experiment.

getParameters

public List<Value> getParameters()

Description copied from interface: Experiment

Get experiment parameters.

Specified by:

getParameters in interface Experiment

Returns:

the parameters logged by experiment.

getMetrics

public List<Value> getMetrics()

Description copied from interface: Experiment

Get experiment metrics.

Specified by:

getMetrics in interface Experiment

Returns:

the metrics logged by experiment.

getLogOther

public List<Value> getLogOther()

Description copied from interface: Experiment

Get experiment log other data.

Specified by:

getLogOther in interface Experiment

Returns:

the other data logged with experiment.

getTags

public List<String> getTags()

Description copied from interface: Experiment

Get experiment tags.

Specified by:

getTags in interface Experiment

Returns:

the TAGs associated with experiment

getAssetList

public List<LoggedExperimentAsset> getAssetList(@NonNull
                                                @NonNull String type)

Description copied from interface: Experiment

Get list of the logged experiment assets with particular type.

Specified by:

getAssetList in interface Experiment

Parameters:

type - the type of assets to be included.

Returns:

the list of assets associated with experiment.

getAllAssetList

public List<LoggedExperimentAsset> getAllAssetList()

Description copied from interface: Experiment

Get list of all logged experiment assets.

Specified by:

getAllAssetList in interface Experiment

Returns:

the list of assets associated with experiment.