ml.comet.experiment.impl

Class ApiExperimentImpl.ApiExperimentBuilderImpl

java.lang.Object

ml.comet.experiment.impl.ApiExperimentImpl.ApiExperimentBuilderImpl

All Implemented Interfaces:

ApiExperimentBuilder, BaseCometBuilder<ApiExperiment>

Enclosing class:

ApiExperimentImpl

public static final class ApiExperimentImpl.ApiExperimentBuilderImpl
extends Object
implements ApiExperimentBuilder

The builder to create properly configured ApiExperiment instance.

Method Summary

Modifier and Type	Method and Description
ApiExperiment	build() Instantiates the Comet experiment instance defined by T.
ApiExperimentImpl.ApiExperimentBuilderImpl	withApiKey(@NonNull String anApiKey) Set the api key matched to the account you wish to use.
ApiExperimentImpl.ApiExperimentBuilderImpl	withConfigOverride(@NonNull File overrideConfig) Provide an override config to changeExperiment parameters being provided by the config.
ApiExperimentImpl.ApiExperimentBuilderImpl	withExistingExperimentKey(@NonNull String experimentKey) Allows to continue a previous experiment by providing the key of the existing experiment.
ApiExperimentImpl.ApiExperimentBuilderImpl	withLogger(@NonNull org.slf4j.Logger logger) The slf4j Logger through which the instance can log its actions.
ApiExperimentImpl.ApiExperimentBuilderImpl	withProjectName(@NonNull String projectName) Set project name for the experiment.
ApiExperimentImpl.ApiExperimentBuilderImpl	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

withExistingExperimentKey

public ApiExperimentImpl.ApiExperimentBuilderImpl withExistingExperimentKey(@NonNull
                                                                            @NonNull String experimentKey)

Description copied from interface: ApiExperimentBuilder

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

Specified by:

withExistingExperimentKey in interface ApiExperimentBuilder

Parameters:

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

Returns:

the builder configured with specified key of the previous experiment.

withApiKey

public ApiExperimentImpl.ApiExperimentBuilderImpl withApiKey(@NonNull
                                                             @NonNull String anApiKey)

Description copied from interface: BaseCometBuilder

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

Specified by:

withApiKey in interface BaseCometBuilder<ApiExperiment>

Parameters:

anApiKey - The api key for the user running the experiment

Returns:

the builder configured with specified API key.

withProjectName

public ApiExperimentImpl.ApiExperimentBuilderImpl withProjectName(@NonNull
                                                                  @NonNull String projectName)

Description copied from interface: ApiExperimentBuilder

Set project name for the experiment.

Specified by:

withProjectName in interface ApiExperimentBuilder

Parameters:

projectName - The project under which the experiment should run

Returns:

the builder configured with specified project name.

withWorkspace

public ApiExperimentImpl.ApiExperimentBuilderImpl withWorkspace(@NonNull
                                                                @NonNull String workspace)

Description copied from interface: ApiExperimentBuilder

Set workspace for the project.

Specified by:

withWorkspace in interface ApiExperimentBuilder

Parameters:

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

Returns:

the builder configured with specified workspace name.

withLogger

public ApiExperimentImpl.ApiExperimentBuilderImpl withLogger(@NonNull
                                                             @NonNull org.slf4j.Logger logger)

Description copied from interface: BaseCometBuilder

The slf4j Logger through which the instance can log its actions.

Specified by:

withLogger in interface BaseCometBuilder<ApiExperiment>

Parameters:

logger - The logger that instance should use.

Returns:

the builder configured with specified logger to be used for logging.

withConfigOverride

public ApiExperimentImpl.ApiExperimentBuilderImpl withConfigOverride(@NonNull
                                                                     @NonNull File overrideConfig)

Description copied from interface: BaseCometBuilder

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

Specified by:

withConfigOverride in interface BaseCometBuilder<ApiExperiment>

Parameters:

overrideConfig - Config to override default values

Returns:

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

build

public ApiExperiment build()

Description copied from interface: BaseCometBuilder

Instantiates the Comet experiment instance defined by T.

Specified by:

build in interface BaseCometBuilder<ApiExperiment>

Returns:

the properly configured instance of the Comet experiment.