ml.comet.experiment.builder

Interface OnlineExperimentBuilder

All Superinterfaces:

BaseCometBuilder<OnlineExperiment>

public interface OnlineExperimentBuilder
extends BaseCometBuilder<OnlineExperiment>

Defines the public contract of the OnlineExperiment builder. This factory is preferred method to create properly initialized instance of the OnlineExperiment.

Method Summary

Modifier and Type	Method and Description
OnlineExperimentBuilder	interceptStdout() Turn on intercept of stdout and stderr and the logging of both in Comet.
OnlineExperimentBuilder	withExistingExperimentKey(String experimentKey) Allows to continue a previous experiment by providing the key of the existing experiment.
OnlineExperimentBuilder	withExperimentName(String experimentName) Sets the name the experiment.
OnlineExperimentBuilder	withMaxAuthRetries(int maxAuthRetries) Set the max auth retry attempts.
OnlineExperimentBuilder	withProjectName(String projectName) Set project name for the experiment.
OnlineExperimentBuilder	withUrlOverride(String urlOverride) Set the URL of your comet installation.
OnlineExperimentBuilder	withWorkspace(String workspace) Set workspace for the project.

Methods inherited from interface ml.comet.experiment.builder.BaseCometBuilder

build, withApiKey, withConfigOverride, withLogger

Method Detail

withProjectName

OnlineExperimentBuilder withProjectName(String projectName)

Set project name for the experiment.

Parameters:

projectName - The project under which the experiment should run

Returns:

the builder configured with specified project name.

withWorkspace

OnlineExperimentBuilder withWorkspace(String workspace)

Set workspace for the project.

Parameters:

workspace - The workspace under which the experiment should be run.

Returns:

the builder configured with specified workspace name.

withMaxAuthRetries

OnlineExperimentBuilder withMaxAuthRetries(int maxAuthRetries)

Set the max auth retry attempts.

Parameters:

maxAuthRetries - number of times to try auth calls on experiment creation

Returns:

the builder configured with specified maximal number of authenticate retries.

withUrlOverride

OnlineExperimentBuilder withUrlOverride(String urlOverride)

Set the URL of your comet installation.

Parameters:

urlOverride - full url of comet installation. Default is https://www.comet.ml

Returns:

the builder configured with specified URL of the Comet installation.

withExperimentName

OnlineExperimentBuilder withExperimentName(String experimentName)

Sets the name the experiment.

Parameters:

experimentName - name to be applied to the experiment

Returns:

the builder configured with specified experiment name.

withExistingExperimentKey

OnlineExperimentBuilder withExistingExperimentKey(String experimentKey)

Allows to continue a previous experiment by providing the key of the existing experiment.

Parameters:

experimentKey - The experiment key for the experiment that is being continued

Returns:

the builder configured with specified key of the previous experiment.

interceptStdout

OnlineExperimentBuilder interceptStdout()

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

Returns:

the builder configured with flag indicating that stdout and stderr stream should be intercepted.