ml.comet.experiment

Interface Experiment

All Known Subinterfaces:

OnlineExperiment

All Known Implementing Classes:

ApiExperiment, BaseExperiment, OnlineExperimentImpl

public interface Experiment

Describes the public contract of the Experiment.

Method Summary

Modifier and Type	Method and Description
void	addTag(String tag) Adds a tag to this experiment.
void	end() Tells Comet that the Experiment is complete and release all associated resources.
List<ExperimentAssetLink>	getAssetList(String type) Get experiment asset list.
String	getExperimentKey() Get the experiment key returned by Comet.
Optional<String>	getExperimentLink() Get the experiment link returned by Comet.
String	getExperimentName() Get experiment name.
GitMetadataRest	getGitMetadata() Get experiment git metadata.
Optional<String>	getGraph() Get experiment graph data.
Optional<String>	getHtml() Get experiment html.
List<ValueMinMaxDto>	getLogOther() Get experiment log other data.
ExperimentMetadataRest	getMetadata() Get experiment metadata.
List<ValueMinMaxDto>	getMetrics() Get experiment metrics.
Optional<String>	getOutput() Get experiment output data.
List<ValueMinMaxDto>	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(String code, String fileName) Allows you to report code for the experiment.
void	logEndTime(long endTimeMillis) Logs the start time of the experiment.
void	logGitMetadata(CreateGitMetadata gitMetadata) Logs Git Metadata for the experiment.
void	logGraph(String graph) Logs a graph to Comet.
void	logHtml(String html, boolean override) Allows you to create html report for the experiment.
void	logMetric(String metricName, Object metricValue, long step, long epoch) Logs a metric with Comet.
void	logOther(String key, Object value) Logs a key value pair with Comet.
void	logParameter(String parameterName, Object paramValue, long step) Logs a param with Comet.
void	logStartTime(long startTimeMillis) Logs the start time of the experiment.
void	setExperimentName(String experimentName) Sets the experiment name.
void	uploadAsset(File asset, boolean overwrite, long step, long epoch)
void	uploadAsset(File asset, String fileName, boolean overwrite, long step, long epoch) Upload an asset to be associated with the experiment, for example the trained weights of a neural net.

Method Detail

getExperimentKey

String getExperimentKey()

Get the experiment key returned by Comet.

Returns:

the experiment key assigned by Comet

getExperimentLink

Optional<String> getExperimentLink()

Get the experiment link returned by Comet.

Returns:

the experiment link assigned by Comet.

getProjectName

String getProjectName()

Get project name of the experiment.

Returns:

the project name of the experiment.

getWorkspaceName

String getWorkspaceName()

Get workspace name of the experiment.

Returns:

the workspace name of the experiment.

getExperimentName

String getExperimentName()

Get experiment name.

Returns:

the name of the experiment.

getMetadata

ExperimentMetadataRest getMetadata()

Get experiment metadata.

Returns:

the metadata associated with experiment.

getGitMetadata

GitMetadataRest getGitMetadata()

Get experiment git metadata.

Returns:

the GIT metadata for this experiment.

getHtml

Optional<String> getHtml()

Get experiment html.

Returns:

the HTML of the experiment.

getOutput

Optional<String> getOutput()

Get experiment output data.

Returns:

the output data of the experiment.

getGraph

Optional<String> getGraph()

Get experiment graph data.

Returns:

the graph data associated with experiment.

getParameters

List<ValueMinMaxDto> getParameters()

Get experiment parameters.

Returns:

the parameters logged by experiment.

getMetrics

List<ValueMinMaxDto> getMetrics()

Get experiment metrics.

Returns:

the metrics logged by experiment.

getLogOther

List<ValueMinMaxDto> getLogOther()

Get experiment log other data.

Returns:

the other data logged with experiment.

getTags

List<String> getTags()

Get experiment tags.

Returns:

the TAGs associated with experiment

getAssetList

List<ExperimentAssetLink> getAssetList(String type)

Get experiment asset list.

Parameters:

type - the type of assets to be included.

Returns:

the list of assets associated with experiment.

setExperimentName

void setExperimentName(String experimentName)

Sets the experiment name.

Parameters:

experimentName - The new name for the experiment

logMetric

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

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.

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

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

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.

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

logHtml

void logHtml(String html,
             boolean override)

Allows you to create html report for the 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. If false, it will have the new html appended onto the end.

logOther

void logOther(String key,
              Object value)

Logs a key value pair with Comet. This can be used for any sort of generic per experiment data you wish to track.

Parameters:

key - The key for the data to be stored

value - The value for said key

addTag

void addTag(String tag)

Adds a tag to this experiment.

Parameters:

tag - The tag to be added

logGraph

void logGraph(String graph)

Logs a graph to Comet.

Parameters:

graph - The graph to be logged

logStartTime

void logStartTime(long startTimeMillis)

Logs the start time of the experiment.

Parameters:

startTimeMillis - When you want to say that the experiment started

logEndTime

void logEndTime(long endTimeMillis)

Logs the start time of the experiment.

Parameters:

endTimeMillis - When you want to say that the experiment ended

logCode

void logCode(String code,
             String fileName)

Allows you to report code for the experiment.

Parameters:

code - Code to be sent to Comet

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

logCode

void logCode(File file)

Allows you to report code for the experiment.

Parameters:

file - Asset with source code to be sent

uploadAsset

void uploadAsset(File asset,
                 String fileName,
                 boolean overwrite,
                 long step,
                 long epoch)

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!

Parameters:

asset - The asset to be stored

fileName - 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 asset

epoch - the epoch to be associated with asset

uploadAsset

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

logGitMetadata

void logGitMetadata(CreateGitMetadata gitMetadata)

Logs Git Metadata for the experiment.

Parameters:

gitMetadata - The Git Metadata for the experiment

end

void end()

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