ml.comet.experiment

Interface OnlineExperiment

All Superinterfaces:

Experiment

All Known Implementing Classes:

OnlineExperimentImpl

public interface OnlineExperiment
extends Experiment

Method Summary

Modifier and Type	Method and Description
void	end() Tells Comet that the Experiment is complete.
String	getContext() Gets the current context as recorded in the Experiment object locally
long	getEpoch() Gets the current epoch as recorded by the Experiment object locally
long	getStep() Gets the current step as recorded by the Experiment object locally
void	logLine(String line, long offset, boolean stderr) Send logs to Comet.
void	logMetric(String metricName, Object metricValue)
void	logMetric(String metricName, Object metricValue, long step) Logs a metric with Comet under the current experiment step.
void	logParameter(String parameterName, Object paramValue) Logs a param with Comet under the current experiment step.
void	nextEpoch() Increments the epoch that the experiment is on
void	nextStep() Increments the step that the experiment is on
void	setContext(String context) Sets the context for any logs and uploaded files
void	setEpoch(long epoch) Sets the current epoch for the experiment.
void	setInterceptStdout() Turn on intercept of stdout and stderr and the logging of both in Comet
void	setStep(long step) Sets the current step for the experiment.
void	stopInterceptStdout() Turn off intercept of stdout and stderr and turns off their logging in Comet
void	uploadAsset(File asset, boolean overwrite)
void	uploadAsset(File asset, String fileName, boolean overwrite)
void	uploadAsset(File asset, String fileName, boolean overwrite, long step) Upload an asset under the current experiment step to be associated with the experiment, for example the trained weights of a neural net

Methods inherited from interface ml.comet.experiment.Experiment

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

Method Detail

end

void end()

Tells Comet that the Experiment is complete.

setInterceptStdout

void setInterceptStdout()
                 throws IOException

Turn on intercept of stdout and stderr and the logging of both in Comet

Throws:

IOException

stopInterceptStdout

void stopInterceptStdout()

Turn off intercept of stdout and stderr and turns off their logging in Comet

logLine

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

Send logs to Comet.

Parameters:

line - Text to be logged

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

stderr -

setStep

void setStep(long step)

Sets the current step for the experiment. This is used when logging metrics and params

nextStep

void nextStep()

Increments the step that the experiment is on

getStep

long getStep()

Gets the current step as recorded by the Experiment object locally

Returns:

setEpoch

void setEpoch(long epoch)

Sets the current epoch for the experiment.

nextEpoch

void nextEpoch()

Increments the epoch that the experiment is on

getEpoch

long getEpoch()

Gets the current epoch as recorded by the Experiment object locally

Returns:

setContext

void setContext(String context)

Sets the context for any logs and uploaded files

getContext

String getContext()

Gets the current context as recorded in the Experiment object locally

Returns:

logMetric

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

Logs a metric with Comet under the current experiment step. 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 step to be associated with this metric

logMetric

void logMetric(String metricName,
               Object metricValue)

logParameter

void logParameter(String parameterName,
                  Object paramValue)

Logs a param with Comet under the current experiment step. 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

uploadAsset

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

Upload an asset under the current experiment step to be associated with the experiment, for example the trained weights of a neural net

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

uploadAsset

void uploadAsset(File asset,
                 String fileName,
                 boolean overwrite)

uploadAsset

void uploadAsset(File asset,
                 boolean overwrite)