ml.comet.experiment.builder

Interface OnlineExperimentBuilder

All Known Implementing Classes:

OnlineExperimentImpl.OnlineExperimentBuilderImpl

public interface OnlineExperimentBuilder

Method Summary

Modifier and Type	Method and Description
OnlineExperiment	build() Instantiates the Experiment object and registers it with Comet.
OnlineExperimentBuilder	interceptStdout() Turn on intercept of stdout and stderr and the logging of both in Comet
OnlineExperimentBuilder	withApiKey(String apiKey) Set the api key matched to the account you wish to use
OnlineExperimentBuilder	withConfig(File overrideConfig) Provide an override config to changeExperiment parameters being provided by the config
OnlineExperimentBuilder	withExistingExperimentKey(String experimentKey) Used to continue a previous experiment
OnlineExperimentBuilder	withExperimentName(String experimentName) Name the experiment
OnlineExperimentBuilder	withLogger(org.slf4j.Logger logger) slf4j Logger through which the Experiment object can log its actions
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

Method Detail

withProjectName

OnlineExperimentBuilder withProjectName(String projectName)

Set project name for the experiment

Parameters:

projectName - The project under which the experiment should run

Returns:

withWorkspace

OnlineExperimentBuilder withWorkspace(String workspace)

Set workspace for the project

Parameters:

workspace -

Returns:

The workspace under which the experiment should be run

withApiKey

OnlineExperimentBuilder withApiKey(String apiKey)

Set the api key matched to the account you wish to use

Parameters:

apiKey - The api key for the user running the experiment

Returns:

withMaxAuthRetries

OnlineExperimentBuilder withMaxAuthRetries(int maxAuthRetries)

Set the max auth retry attempts.

Parameters:

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

Returns:

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:

withExperimentName

OnlineExperimentBuilder withExperimentName(String experimentName)

Name the experiment

Parameters:

experimentName - name to be applied to the experiment

Returns:

withExistingExperimentKey

OnlineExperimentBuilder withExistingExperimentKey(String experimentKey)

Used to continue a previous experiment

Parameters:

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

Returns:

withLogger

OnlineExperimentBuilder withLogger(org.slf4j.Logger logger)

slf4j Logger through which the Experiment object can log its actions

Parameters:

logger - The logger that Experiment should use

Returns:

withConfig

OnlineExperimentBuilder withConfig(File overrideConfig)

Provide an override config to changeExperiment parameters being provided by the config

Parameters:

overrideConfig - Config to override default values

Returns:

interceptStdout

OnlineExperimentBuilder interceptStdout()

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

Returns:

build

OnlineExperiment build()

Instantiates the Experiment object and registers it with Comet. At this point the experiment will show up on Comet

Returns: