ml.comet.experiment.builder.BaseCometBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of comet-java-client Show documentation

There is a newer version: 1.1.14

package ml.comet.experiment.builder;

import org.slf4j.Logger;

import java.io.File;

/**
 * Defines public contract of base interface for all experiment builders in the Comet Java SDK.
 */
public interface BaseCometBuilder {
    /**
     * Set the api key matched to the account you wish to use.
     *
     * @param apiKey The api key for the user running the experiment
     * @return the builder configured with specified API key.
     */
    BaseCometBuilder withApiKey(String apiKey);

    /**
     * Provide an override config to changeExperiment parameters being provided by the config.
     *
     * @param overrideConfig Config to override default values
     * @return the builder configured with specified configuration file to override default configuration options.
     */
    BaseCometBuilder withConfigOverride(File overrideConfig);

    /**
     * The slf4j Logger through which the instance can log its actions.
     *
     * @param logger The logger that instance should use.
     * @return the builder configured with specified logger to be used for logging.
     */
    BaseCometBuilder withLogger(Logger logger);

    /**
     * Instantiates the Comet experiment instance defined by {@code T}.
     *
     * @return the properly configured instance of the Comet experiment.
     */
    T build();
}