ml.comet.experiment.builder

Interface ApiExperimentBuilder

All Superinterfaces:

BaseCometBuilder<ApiExperiment>

All Known Implementing Classes:

ApiExperimentImpl.ApiExperimentBuilderImpl

public interface ApiExperimentBuilder
extends BaseCometBuilder<ApiExperiment>

Defines the public contract of the factory to create initialized instances of the ApiExperiment allowing to work with Comet API synchronously.

Method Summary

Modifier and Type	Method and Description
ApiExperimentBuilder	withExistingExperimentKey(String experimentKey) Allows to continue a previous experiment by providing the key of the existing experiment.
ApiExperimentBuilder	withProjectName(String projectName) Set project name for the experiment.
ApiExperimentBuilder	withWorkspace(String workspace) Set workspace for the project.

Methods inherited from interface ml.comet.experiment.builder.BaseCometBuilder

build, withApiKey, withConfigOverride, withLogger

Method Detail

withExistingExperimentKey

ApiExperimentBuilder withExistingExperimentKey(String experimentKey)

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

Parameters:

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

Returns:

the builder configured with specified key of the previous experiment.

withProjectName

ApiExperimentBuilder withProjectName(String projectName)

Set project name for the experiment.

Parameters:

projectName - The project under which the experiment should run

Returns:

the builder configured with specified project name.

withWorkspace

ApiExperimentBuilder withWorkspace(String workspace)

Set workspace for the project.

Parameters:

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

Returns:

the builder configured with specified workspace name.