ml.comet.experiment.impl

Class OnlineExperimentImpl

java.lang.Object

ml.comet.experiment.impl.OnlineExperimentImpl

All Implemented Interfaces:

AutoCloseable, Experiment, OnlineExperiment

public final class OnlineExperimentImpl
extends Object
implements OnlineExperiment

The implementation of the OnlineExperiment to work with Comet API asynchronously.

Method Summary

Modifier and Type	Method and Description
void	addTag(@NonNull String tag) Synchronous version that waits for result or exception.
void	addTag(@NonNull String tag, @NonNull Optional<io.reactivex.rxjava3.functions.Action> onComplete) Asynchronous version that only logs any received exceptions or failures.
static ml.comet.experiment.impl.OnlineExperimentBuilderImpl	builder() Returns builder to be used to create properly configured instance of this class.
void	close() Allows using OnlineExperiment with try-with-resources statement with automatic closing after usage.
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	getContext() Gets the current context identifier as recorded in the OnlineExperiment 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.
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.
long	getStep() Gets the current step as recorded by the Experiment object locally.
List<String>	getTags() Get experiment tags.
String	getWorkspaceName() Get workspace name of the experiment.
CompletableFuture<LoggedArtifact>	logArtifact(Artifact artifact) Logs an Artifact object.
void	logAssetFolder(@NonNull File folder, boolean logFilePath)
void	logAssetFolder(@NonNull File folder, boolean logFilePath, boolean recursive)
void	logAssetFolder(@NonNull File folder, boolean logFilePath, boolean recursive, @NonNull ExperimentContext context) Logs all the files located in the given folder as assets.
void	logCode(@NonNull 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(@NonNull String code, @NonNull 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) Send output logs to Comet.
void	logLine(String line, long offset, boolean stderr, String context) Synchronous version that waits for result or exception.
void	logMetric(String metricName, Object metricValue)
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) Logs a metric with Comet.
void	logMetric(String metricName, Object metricValue, long step, long epoch) Logs a metric with Comet.
void	logModel(@NonNull String modelName, byte[] data, @NonNull String logicalPath)
void	logModel(@NonNull String modelName, byte[] data, @NonNull String logicalPath, boolean overwrite)
void	logModel(@NonNull String modelName, byte[] data, @NonNull String logicalPath, boolean overwrite, Map<String,Object> metadata)
void	logModel(@NonNull String modelName, byte[] data, @NonNull String logicalPath, boolean overwrite, Map<String,Object> metadata, @NonNull ExperimentContext context) Logs the model data from specified file.
void	logModel(@NonNull String modelName, @NonNull File file)
void	logModel(@NonNull String modelName, @NonNull File file, @NonNull String logicalPath)
void	logModel(@NonNull String modelName, @NonNull File file, @NonNull String logicalPath, boolean overwrite)
void	logModel(@NonNull String modelName, @NonNull File file, @NonNull String logicalPath, boolean overwrite, Map<String,Object> metadata)
void	logModel(@NonNull String modelName, @NonNull File file, @NonNull String logicalPath, boolean overwrite, Map<String,Object> metadata, @NonNull ExperimentContext context) Logs the model data from specified file.
void	logModelFolder(@NonNull String modelName, @NonNull File folder)
void	logModelFolder(@NonNull String modelName, @NonNull File folder, boolean logFilePath, Map<String,Object> metadata)
void	logModelFolder(@NonNull String modelName, @NonNull File folder, boolean logFilePath, Map<String,Object> metadata, @NonNull ExperimentContext context) Logs the model data from specified folder.
void	logModelFolder(@NonNull String modelName, @NonNull File folder, Map<String,Object> metadata)
void	logOther(@NonNull String key, @NonNull Object value) Synchronous version that waits for result or exception.
void	logParameter(@NonNull String parameterName, @NonNull Object paramValue) Logs a param with Comet under the current experiment step.
void	logParameter(String parameterName, Object paramValue, @NonNull ExperimentContext context) Synchronous version that waits for result or exception.
void	logParameter(@NonNull String parameterName, @NonNull Object paramValue, long step) Logs a param with Comet.
void	logRemoteAsset(@NonNull URI uri, boolean overwrite)
void	logRemoteAsset(@NonNull URI uri, @NonNull String logicalPath, boolean overwrite)
void	logRemoteAsset(@NonNull URI uri, String logicalPath, boolean overwrite, Map<String,Object> metadata)
void	logRemoteAsset(@NonNull URI uri, String logicalPath, boolean overwrite, Map<String,Object> metadata, @NonNull ExperimentContext context) Logs a Remote Asset identified by a URI.
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	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 identifier for any logs and uploaded files.
void	setEpoch(long epoch) Sets the current epoch for the experiment.
void	setExperimentName(@NonNull String experimentName) Sets the experiment name.
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, 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 asset, @NonNull String logicalPath, boolean overwrite)
void	uploadAsset(@NonNull File asset, @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, @NonNull String logicalPath, 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.
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

getAllAssetList, getArtifact, getArtifact, getArtifact, getAssetList, getExperimentKey, getExperimentName, getGitMetadata, getGraph, getHtml, getLogOther, getMetadata, getMetrics, getOutput, getParameters, getProjectName, getTags, getWorkspaceName, setExperimentName, uploadAsset

Method Detail

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()
           throws Exception

Allows using OnlineExperiment with try-with-resources statement with automatic closing after usage.

Specified by:

close in interface AutoCloseable

Throws:

Exception - if an exception occurs.

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.

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

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.

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.

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.

setContext

public void setContext(String context)

Description copied from interface: OnlineExperiment

Sets the context identifier for any logs and uploaded files.

Specified by:

setContext in interface OnlineExperiment

Parameters:

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

getContext

public String getContext()

Description copied from interface: OnlineExperiment

Gets the current context identifier as recorded in the OnlineExperiment object locally.

Specified by:

getContext in interface OnlineExperiment

Returns:

the current context which associated with log records of this 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.

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.

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.

logMetric

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

Description copied from interface: OnlineExperiment

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 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 current step for this metric, this will set the given step for this experiment

logMetric

public void logMetric(String metricName,
                      Object metricValue)

Specified by:

logMetric in interface OnlineExperiment

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

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.

logParameter

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

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.

logLine

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

Description copied from interface: OnlineExperiment

Send output 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.

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.

logAssetFolder

public void logAssetFolder(@NonNull
                           @NonNull File folder,
                           boolean logFilePath,
                           boolean recursive,
                           @NonNull
                           @NonNull ExperimentContext context)

Description copied from interface: OnlineExperiment

Logs all the files located in the given folder as assets.

Specified by:

logAssetFolder in interface OnlineExperiment

Parameters:

folder - the folder you want to log.

logFilePath - if true, log the file path with each file.

recursive - if true, recurse the folder.

context - the experiment context to be associated with the logged assets.

logAssetFolder

public void logAssetFolder(@NonNull
                           @NonNull File folder,
                           boolean logFilePath,
                           boolean recursive)

Specified by:

logAssetFolder in interface OnlineExperiment

logAssetFolder

public void logAssetFolder(@NonNull
                           @NonNull File folder,
                           boolean logFilePath)

Specified by:

logAssetFolder in interface OnlineExperiment

uploadAsset

public void uploadAsset(@NonNull
                        @NonNull File asset,
                        @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:

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

context - the context 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

uploadAsset

public void uploadAsset(@NonNull
                        @NonNull File asset,
                        @NonNull
                        @NonNull String logicalPath,
                        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

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 asset

uploadAsset

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

Specified by:

uploadAsset in interface OnlineExperiment

uploadAsset

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

Specified by:

uploadAsset in interface OnlineExperiment

logRemoteAsset

public void logRemoteAsset(@NonNull
                           @NonNull URI uri,
                           String logicalPath,
                           boolean overwrite,
                           Map<String,Object> metadata,
                           @NonNull
                           @NonNull ExperimentContext context)

Description copied from interface: OnlineExperiment

Logs a Remote Asset identified by a URI. A Remote Asset is an asset but its content is not uploaded and stored on Comet. Rather a link for its location is stored, so you can identify and distinguish between two experiment using different version of a dataset stored somewhere else.

Specified by:

logRemoteAsset in interface OnlineExperiment

Parameters:

uri - the URI pointing to the remote asset location. There is no imposed format, and it could be a private link.

logicalPath - the optional "name" of the remote asset, could be a dataset name, a model file name.

overwrite - if true will overwrite all existing assets with the same name.

metadata - Some additional data to attach to the remote asset. The dictionary values must be JSON compatible.

context - the experiment context to be associated with the logged assets.

logRemoteAsset

public void logRemoteAsset(@NonNull
                           @NonNull URI uri,
                           String logicalPath,
                           boolean overwrite,
                           Map<String,Object> metadata)

Specified by:

logRemoteAsset in interface OnlineExperiment

logRemoteAsset

public void logRemoteAsset(@NonNull
                           @NonNull URI uri,
                           @NonNull
                           @NonNull String logicalPath,
                           boolean overwrite)

Specified by:

logRemoteAsset in interface OnlineExperiment

logRemoteAsset

public void logRemoteAsset(@NonNull
                           @NonNull URI uri,
                           boolean overwrite)

Specified by:

logRemoteAsset in interface OnlineExperiment

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(@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(@NonNull
                    @NonNull String code,
                    @NonNull
                    @NonNull 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)

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

logArtifact

public CompletableFuture<LoggedArtifact> logArtifact(Artifact artifact)
                                              throws ArtifactException

Description copied from interface: OnlineExperiment

Logs an Artifact object. First, it creates a new version of the artifact. After that, it uploads asynchronously all the local and remote assets attached to the artifact object.

Specified by:

logArtifact in interface OnlineExperiment

Parameters:

artifact - the Artifact instance.

Returns:

CompletableFuture which can be used to query for LoggedArtifact instance with details about new version of artifact that was logged.

Throws:

ArtifactException - if operation failed.

logModelFolder

public void logModelFolder(@NonNull
                           @NonNull String modelName,
                           @NonNull
                           @NonNull File folder,
                           boolean logFilePath,
                           Map<String,Object> metadata,
                           @NonNull
                           @NonNull ExperimentContext context)

Description copied from interface: OnlineExperiment

Logs the model data from specified folder.

Specified by:

logModelFolder in interface OnlineExperiment

Parameters:

modelName - the name of the model.

folder - the folder with model's data files.

logFilePath - if true than prefix file path of each data file with folder name.

metadata - the metadata to be associated with asset files of the model. The dictionary values must be JSON compatible.

context - the experiment context to be associated with the logged model.

logModelFolder

public void logModelFolder(@NonNull
                           @NonNull String modelName,
                           @NonNull
                           @NonNull File folder,
                           boolean logFilePath,
                           Map<String,Object> metadata)

Specified by:

logModelFolder in interface OnlineExperiment

logModelFolder

public void logModelFolder(@NonNull
                           @NonNull String modelName,
                           @NonNull
                           @NonNull File folder,
                           Map<String,Object> metadata)

Specified by:

logModelFolder in interface OnlineExperiment

logModelFolder

public void logModelFolder(@NonNull
                           @NonNull String modelName,
                           @NonNull
                           @NonNull File folder)

Specified by:

logModelFolder in interface OnlineExperiment

logModel

public void logModel(@NonNull
                     @NonNull String modelName,
                     @NonNull
                     @NonNull File file,
                     @NonNull
                     @NonNull String logicalPath,
                     boolean overwrite,
                     Map<String,Object> metadata,
                     @NonNull
                     @NonNull ExperimentContext context)

Description copied from interface: OnlineExperiment

Logs the model data from specified file.

Specified by:

logModel in interface OnlineExperiment

Parameters:

modelName - the name of the model

file - the file with model data.

logicalPath - the optional "name" of the model file, if missed the file name will be used.

overwrite - if true will overwrite all existing model with the same name.

metadata - the additional metadata to attach to the asset file of the model. The dictionary values must be JSON compatible.

context - the experiment context to be associated with the logged model.

logModel

public void logModel(@NonNull
                     @NonNull String modelName,
                     @NonNull
                     @NonNull File file,
                     @NonNull
                     @NonNull String logicalPath,
                     boolean overwrite,
                     Map<String,Object> metadata)

Specified by:

logModel in interface OnlineExperiment

logModel

public void logModel(@NonNull
                     @NonNull String modelName,
                     @NonNull
                     @NonNull File file,
                     @NonNull
                     @NonNull String logicalPath,
                     boolean overwrite)

Specified by:

logModel in interface OnlineExperiment

logModel

public void logModel(@NonNull
                     @NonNull String modelName,
                     @NonNull
                     @NonNull File file,
                     @NonNull
                     @NonNull String logicalPath)

Specified by:

logModel in interface OnlineExperiment

logModel

public void logModel(@NonNull
                     @NonNull String modelName,
                     @NonNull
                     @NonNull File file)

Specified by:

logModel in interface OnlineExperiment

logModel

public void logModel(@NonNull
                     @NonNull String modelName,
                     byte[] data,
                     @NonNull
                     @NonNull String logicalPath,
                     boolean overwrite,
                     Map<String,Object> metadata,
                     @NonNull
                     @NonNull ExperimentContext context)

Description copied from interface: OnlineExperiment

Logs the model data from specified file.

Specified by:

logModel in interface OnlineExperiment

Parameters:

modelName - the name of the model

data - the model's data.

logicalPath - the name of the model file.

overwrite - if true will overwrite all existing model with the same name.

metadata - the additional metadata to attach to the asset data of the model. The dictionary values must be JSON compatible.

context - the experiment context to be associated with the logged model.

logModel

public void logModel(@NonNull
                     @NonNull String modelName,
                     byte[] data,
                     @NonNull
                     @NonNull String logicalPath,
                     boolean overwrite,
                     Map<String,Object> metadata)

Specified by:

logModel in interface OnlineExperiment

logModel

public void logModel(@NonNull
                     @NonNull String modelName,
                     byte[] data,
                     @NonNull
                     @NonNull String logicalPath,
                     boolean overwrite)

Specified by:

logModel in interface OnlineExperiment

logModel

public void logModel(@NonNull
                     @NonNull String modelName,
                     byte[] data,
                     @NonNull
                     @NonNull String logicalPath)

Specified by:

logModel in interface OnlineExperiment

builder

public static ml.comet.experiment.impl.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.

addTag

public void addTag(@NonNull
                   @NonNull String tag,
                   @NonNull
                   @NonNull Optional<io.reactivex.rxjava3.functions.Action> onComplete)

Asynchronous version that only logs any received exceptions or failures.

Parameters:

tag - The tag to be added

onComplete - The optional action to be invoked when this operation asynchronously completes. Can be null if not interested in completion signal.

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

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.

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.

getExperimentName

public String getExperimentName()

Description copied from interface: Experiment

Get experiment name.

Specified by:

getExperimentName in interface Experiment

Returns:

the name of the experiment.

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

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

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.