ml.comet.experiment

Class OnlineExperimentImpl

java.lang.Object

ml.comet.experiment.BaseExperiment

ml.comet.experiment.OnlineExperimentImpl

All Implemented Interfaces:

Experiment, OnlineExperiment

public class OnlineExperimentImpl
extends BaseExperiment
implements OnlineExperiment

The implementation of the OnlineExperiment.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OnlineExperimentImpl.OnlineExperimentBuilderImpl The builder to create properly configured instance of the OnlineExperimentImpl.

Constructor Summary

Constructors

Constructor and Description
OnlineExperimentImpl() Default constructor which reads all configuration parameters of the experiment either from configuration file or from environment variables.

Method Summary

Modifier and Type	Method and Description
static OnlineExperimentImpl.OnlineExperimentBuilderImpl	builder() Returns builder to be used to create properly configured instance of this class.
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.
long	getEpoch() Gets the current epoch as recorded by 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.
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(@NonNull String metricName, @NonNull Object metricValue)
void	logMetric(@NonNull String metricName, @NonNull Object metricValue, long step) Logs a metric with Comet under the current experiment step.
void	logMetric(@NonNull String metricName, @NonNull Object metricValue, long step, long epoch) Logs a metric with Comet.
void	logParameter(@NonNull String parameterName, @NonNull Object paramValue) Logs a param with Comet under the current experiment step.
void	logParameter(@NonNull String parameterName, @NonNull Object paramValue, long step) Logs a param with Comet.
void	nextEpoch() Increments the epoch that the experiment is on.
void	nextStep() Increments the step that the experiment is on.
protected void	sendHeartbeat()
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(@NonNull File asset, boolean overwrite)
void	uploadAsset(@NonNull File asset, @NonNull String fileName, boolean overwrite)
void	uploadAsset(@NonNull File asset, @NonNull 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 class ml.comet.experiment.BaseExperiment

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

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, getAssetList, getGitMetadata, getGraph, getHtml, getLogOther, getMetadata, getMetrics, getOutput, getParameters, getProjectName, getTags, getWorkspaceName, logCode, logCode, logEndTime, logGitMetadata, logGraph, logHtml, logOther, logStartTime, setExperimentName, uploadAsset, uploadAsset

Constructor Detail

OnlineExperimentImpl

public OnlineExperimentImpl()
                     throws ConfigException

Default constructor which reads all configuration parameters of the experiment either from configuration file or from environment variables.

Throws:

ConfigException - If the Comet API key, project name, and workspace are missing from the configuration source or wrong types of the values defined.

Method Detail

getExperimentName

public String getExperimentName()

Description copied from interface: Experiment

Get experiment name.

Specified by:

getExperimentName in interface Experiment

Returns:

the name of the experiment.

builder

public static OnlineExperimentImpl.OnlineExperimentBuilderImpl builder()

Returns builder to be used to create properly configured instance of this class.

Returns:

the builder to be used to create properly configured instance of this class.

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.

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

setInterceptStdout

public void setInterceptStdout()
                        throws IOException

Description copied from interface: OnlineExperiment

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

Specified by:

setInterceptStdout in interface OnlineExperiment

Throws:

IOException - if an I/O exception occurs.

stopInterceptStdout

public void stopInterceptStdout()
                         throws IOException

Description copied from interface: OnlineExperiment

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

Specified by:

stopInterceptStdout in interface OnlineExperiment

Throws:

IOException - if an I/O exception occurs.

logLine

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

Description copied from interface: OnlineExperiment

Send logs to Comet.

Specified by:

logLine in interface OnlineExperiment

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.

setStep

public void setStep(long step)

Description copied from interface: OnlineExperiment

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

Specified by:

setStep in interface OnlineExperiment

Parameters:

step - the current step of the experiment.

nextStep

public void nextStep()

Description copied from interface: OnlineExperiment

Increments the step that the experiment is on.

Specified by:

nextStep in interface OnlineExperiment

getStep

public long getStep()

Description copied from interface: OnlineExperiment

Gets the current step as recorded by the Experiment object locally.

Specified by:

getStep in interface OnlineExperiment

Returns:

the current step of the experiment

setEpoch

public void setEpoch(long epoch)

Description copied from interface: OnlineExperiment

Sets the current epoch for the experiment.

Specified by:

setEpoch in interface OnlineExperiment

Parameters:

epoch - the current epoch for the experiment.

nextEpoch

public void nextEpoch()

Description copied from interface: OnlineExperiment

Increments the epoch that the experiment is on.

Specified by:

nextEpoch in interface OnlineExperiment

getEpoch

public long getEpoch()

Description copied from interface: OnlineExperiment

Gets the current epoch as recorded by the Experiment object locally.

Specified by:

getEpoch in interface OnlineExperiment

Returns:

the current epoch of the experiment.

setContext

public void setContext(String context)

Description copied from interface: OnlineExperiment

Sets the context for any logs and uploaded files.

Specified by:

setContext in interface OnlineExperiment

Parameters:

context - the context to be associated with any log records, files, and assets.

getContext

public String getContext()

Description copied from class: BaseExperiment

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

Specified by:

getContext in interface OnlineExperiment

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

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

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.

logMetric

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

Description copied from interface: OnlineExperiment

Logs a metric with Comet under the current experiment step. Metrics are generally values that change from step to step.

Specified by:

logMetric in interface OnlineExperiment

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

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

Specified by:

logMetric in interface OnlineExperiment

logMetric

public void logMetric(@NonNull
                      @NonNull String metricName,
                      @NonNull
                      @NonNull 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

Overrides:

logMetric in class BaseExperiment

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(@NonNull
                         @NonNull String parameterName,
                         @NonNull
                         @NonNull Object paramValue)

Description copied from interface: OnlineExperiment

Logs a param with Comet under the current experiment step. Params should be set at the start of the experiment.

Specified by:

logParameter in interface OnlineExperiment

Parameters:

parameterName - The name of the param being logged

paramValue - The value for the param being logged

logParameter

public void logParameter(@NonNull
                         @NonNull String parameterName,
                         @NonNull
                         @NonNull 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

Overrides:

logParameter in class BaseExperiment

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

uploadAsset

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

Description copied from interface: OnlineExperiment

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

Specified by:

uploadAsset in interface OnlineExperiment

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

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

Specified by:

uploadAsset in interface OnlineExperiment

uploadAsset

public void uploadAsset(@NonNull
                        @NonNull File asset,
                        @NonNull
                        @NonNull String fileName,
                        boolean overwrite)

Specified by:

uploadAsset in interface OnlineExperiment

sendHeartbeat

protected void sendHeartbeat()