ml.comet.experiment

Class OnlineExperimentImpl.OnlineExperimentBuilderImpl

java.lang.Object

ml.comet.experiment.OnlineExperimentImpl.OnlineExperimentBuilderImpl

All Implemented Interfaces:

OnlineExperimentBuilder

Enclosing class:

OnlineExperimentImpl

public static final class OnlineExperimentImpl.OnlineExperimentBuilderImpl
extends Object
implements OnlineExperimentBuilder

The builder to create properly configured instance of the OnlineExperimentImpl.

Method Summary

Modifier and Type	Method and Description
OnlineExperimentImpl	build() Instantiates the Experiment object and registers it with Comet.
OnlineExperimentImpl.OnlineExperimentBuilderImpl	interceptStdout() Turn on intercept of stdout and stderr and the logging of both in Comet
OnlineExperimentImpl.OnlineExperimentBuilderImpl	withApiKey(@NonNull String apiKey) Set the api key matched to the account you wish to use
OnlineExperimentImpl.OnlineExperimentBuilderImpl	withConfig(@NonNull File overrideConfig) Provide an override config to changeExperiment parameters being provided by the config
OnlineExperimentImpl.OnlineExperimentBuilderImpl	withExistingExperimentKey(@NonNull String experimentKey) Used to continue a previous experiment
OnlineExperimentImpl.OnlineExperimentBuilderImpl	withExperimentName(@NonNull String experimentName) Name the experiment
OnlineExperimentImpl.OnlineExperimentBuilderImpl	withLogger(@NonNull org.slf4j.Logger logger) slf4j Logger through which the Experiment object can log its actions
OnlineExperimentImpl.OnlineExperimentBuilderImpl	withMaxAuthRetries(int maxAuthRetries) Set the max auth retry attempts.
OnlineExperimentImpl.OnlineExperimentBuilderImpl	withProjectName(@NonNull String projectName) Set project name for the experiment
OnlineExperimentImpl.OnlineExperimentBuilderImpl	withUrlOverride(@NonNull String urlOverride) Set the URL of your comet installation.
OnlineExperimentImpl.OnlineExperimentBuilderImpl	withWorkspace(@NonNull String workspace) Set workspace for the project

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

withProjectName

public OnlineExperimentImpl.OnlineExperimentBuilderImpl withProjectName(@NonNull
                                                                        @NonNull String projectName)

Description copied from interface: OnlineExperimentBuilder

Set project name for the experiment

Specified by:

withProjectName in interface OnlineExperimentBuilder

Parameters:

projectName - The project under which the experiment should run

Returns:

the builder configured with specified project name.

withWorkspace

public OnlineExperimentImpl.OnlineExperimentBuilderImpl withWorkspace(@NonNull
                                                                      @NonNull String workspace)

Description copied from interface: OnlineExperimentBuilder

Set workspace for the project

Specified by:

withWorkspace in interface OnlineExperimentBuilder

Parameters:

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

Returns:

the builder configured with specified workspace name.

withApiKey

public OnlineExperimentImpl.OnlineExperimentBuilderImpl withApiKey(@NonNull
                                                                   @NonNull String apiKey)

Description copied from interface: OnlineExperimentBuilder

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

Specified by:

withApiKey in interface OnlineExperimentBuilder

Parameters:

apiKey - The api key for the user running the experiment

Returns:

the builder configured with specified API key.

withMaxAuthRetries

public OnlineExperimentImpl.OnlineExperimentBuilderImpl withMaxAuthRetries(int maxAuthRetries)

Description copied from interface: OnlineExperimentBuilder

Set the max auth retry attempts.

Specified by:

withMaxAuthRetries in interface OnlineExperimentBuilder

Parameters:

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

Returns:

the builder configured with specified maximal number of authenticate retries.

withUrlOverride

public OnlineExperimentImpl.OnlineExperimentBuilderImpl withUrlOverride(@NonNull
                                                                        @NonNull String urlOverride)

Description copied from interface: OnlineExperimentBuilder

Set the URL of your comet installation.

Specified by:

withUrlOverride in interface OnlineExperimentBuilder

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

public OnlineExperimentImpl.OnlineExperimentBuilderImpl withExperimentName(@NonNull
                                                                           @NonNull String experimentName)

Description copied from interface: OnlineExperimentBuilder

Name the experiment

Specified by:

withExperimentName in interface OnlineExperimentBuilder

Parameters:

experimentName - name to be applied to the experiment

Returns:

the builder configured with specified experiment name.

withExistingExperimentKey

public OnlineExperimentImpl.OnlineExperimentBuilderImpl withExistingExperimentKey(@NonNull
                                                                                  @NonNull String experimentKey)

Description copied from interface: OnlineExperimentBuilder

Used to continue a previous experiment

Specified by:

withExistingExperimentKey in interface OnlineExperimentBuilder

Parameters:

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

Returns:

the builder configured with specified key of the previous experiment.

withLogger

public OnlineExperimentImpl.OnlineExperimentBuilderImpl withLogger(@NonNull
                                                                   @NonNull org.slf4j.Logger logger)

Description copied from interface: OnlineExperimentBuilder

slf4j Logger through which the Experiment object can log its actions

Specified by:

withLogger in interface OnlineExperimentBuilder

Parameters:

logger - The logger that Experiment should use

Returns:

the builder configured with specified logger to be used within experiment.

withConfig

public OnlineExperimentImpl.OnlineExperimentBuilderImpl withConfig(@NonNull
                                                                   @NonNull File overrideConfig)

Description copied from interface: OnlineExperimentBuilder

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

Specified by:

withConfig in interface OnlineExperimentBuilder

Parameters:

overrideConfig - Config to override default values

Returns:

the builder configured with specified configuration file to override default configuration options.

interceptStdout

public OnlineExperimentImpl.OnlineExperimentBuilderImpl interceptStdout()

Description copied from interface: OnlineExperimentBuilder

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

Specified by:

interceptStdout in interface OnlineExperimentBuilder

Returns:

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

build

public OnlineExperimentImpl build()

Description copied from interface: OnlineExperimentBuilder

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

Specified by:

build in interface OnlineExperimentBuilder

Returns:

the fully configured instance of the OnlineExperiment.