ml.comet.experiment.builder

Interface ApiExperimentBuilder

All Known Implementing Classes:

ApiExperiment.ApiExperimentBuilderImpl

public interface ApiExperimentBuilder

Method Summary

Modifier and Type	Method and Description
ApiExperiment	build() Instantiates the ApiExperiment object and registers it with Comet.
ApiExperimentBuilder	withApiKey(String apiKey) Set the api key matched to the account you wish to use
ApiExperimentBuilder	withConfig(File overrideConfig) Provide an override config to changeExperiment parameters being provided by the config
ApiExperimentBuilder	withLogger(org.slf4j.Logger logger) slf4j Logger through which the Experiment object can log its actions

Method Detail

withApiKey

ApiExperimentBuilder 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 with given API key.

withLogger

ApiExperimentBuilder 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:

the builder with logger that Experiment should use

withConfig

ApiExperimentBuilder withConfig(File overrideConfig)

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

Parameters:

overrideConfig - Config to override default values

Returns:

the builder with provided configuration file.

build

ApiExperiment build()

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

Returns:

the ApiExperiment instance built with parameters provided to the builder.