ml.comet.experiment

Class ApiExperiment.ApiExperimentBuilderImpl

java.lang.Object

ml.comet.experiment.ApiExperiment.ApiExperimentBuilderImpl

All Implemented Interfaces:

ApiExperimentBuilder

Enclosing class:

ApiExperiment

public static final class ApiExperiment.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 ApiExperiment object and registers it with Comet.
ApiExperiment.ApiExperimentBuilderImpl	withApiKey(@NonNull String anApiKey) Set the api key matched to the account you wish to use
ApiExperiment.ApiExperimentBuilderImpl	withConfig(@NonNull File overrideConfig) Provide an override config to changeExperiment parameters being provided by the config
ApiExperiment.ApiExperimentBuilderImpl	withLogger(@NonNull org.slf4j.Logger logger) slf4j Logger through which the Experiment object can log its actions

Methods inherited from class java.lang.Object

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

Method Detail

withApiKey

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

Description copied from interface: ApiExperimentBuilder

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

Specified by:

withApiKey in interface ApiExperimentBuilder

Parameters:

anApiKey - The api key for the user running the experiment

Returns:

the builder with given API key.

withLogger

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

Description copied from interface: ApiExperimentBuilder

slf4j Logger through which the Experiment object can log its actions

Specified by:

withLogger in interface ApiExperimentBuilder

Parameters:

logger - The logger that Experiment should use

Returns:

the builder with logger that Experiment should use

withConfig

public ApiExperiment.ApiExperimentBuilderImpl withConfig(@NonNull
                                                         @NonNull File overrideConfig)

Description copied from interface: ApiExperimentBuilder

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

Specified by:

withConfig in interface ApiExperimentBuilder

Parameters:

overrideConfig - Config to override default values

Returns:

the builder with provided configuration file.

build

public ApiExperiment build()

Description copied from interface: ApiExperimentBuilder

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

Specified by:

build in interface ApiExperimentBuilder

Returns:

the ApiExperiment instance built with parameters provided to the builder.