ml.comet.experiment.builder

Interface BaseCometBuilder<T>

All Known Subinterfaces:

ApiExperimentBuilder, CometApiBuilder, OnlineExperimentBuilder

All Known Implementing Classes:

ApiExperiment.ApiExperimentBuilderImpl, OnlineExperimentImpl.OnlineExperimentBuilderImpl

public interface BaseCometBuilder<T>

Defines public contract of base interface for all experiment builders in the Comet Java SDK.

Method Summary

Modifier and Type	Method and Description
T	build() Instantiates the Comet experiment instance defined by T.
BaseCometBuilder<T>	withApiKey(String apiKey) Set the api key matched to the account you wish to use.
BaseCometBuilder<T>	withConfigOverride(File overrideConfig) Provide an override config to changeExperiment parameters being provided by the config.
BaseCometBuilder<T>	withLogger(org.slf4j.Logger logger) The slf4j Logger through which the instance can log its actions.

Method Detail

withApiKey

BaseCometBuilder<T> 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:

the builder configured with specified API key.

withConfigOverride

BaseCometBuilder<T> withConfigOverride(File overrideConfig)

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

Parameters:

overrideConfig - Config to override default values

Returns:

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

withLogger

BaseCometBuilder<T> withLogger(org.slf4j.Logger logger)

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

Parameters:

logger - The logger that instance should use.

Returns:

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

build

T build()

Instantiates the Comet experiment instance defined by T.

Returns:

the properly configured instance of the Comet experiment.