ml.comet.experiment.context

Class ExperimentContext.ExperimentContextBuilder

java.lang.Object

ml.comet.experiment.context.ExperimentContext.ExperimentContextBuilder

Enclosing class:

ExperimentContext

public static final class ExperimentContext.ExperimentContextBuilder
extends Object

Builder to create populated instance of the ExperimentContext.

Method Summary

Modifier and Type	Method and Description
ExperimentContext	build() Creates fully initialized ExperimentContext instance.
ExperimentContext.ExperimentContextBuilder	withContext(String context) Populates context with specified context identifier string.
ExperimentContext.ExperimentContextBuilder	withEpoch(long epoch) Populates context with specified epoch of the experiment.
ExperimentContext.ExperimentContextBuilder	withStep(long step) Populates context with specified step of the experiment.

Methods inherited from class java.lang.Object

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

Method Detail

withStep

public ExperimentContext.ExperimentContextBuilder withStep(long step)

Populates context with specified step of the experiment.

Parameters:

step - the experiment's step.

Returns:

the instance of this builder.

withEpoch

public ExperimentContext.ExperimentContextBuilder withEpoch(long epoch)

Populates context with specified epoch of the experiment.

Parameters:

epoch - the epoch of the experiment.

Returns:

the instance of this builder.

withContext

public ExperimentContext.ExperimentContextBuilder withContext(String context)

Populates context with specified context identifier string.

Parameters:

context - the context identifier string.

Returns:

the instance of this builder.

build

public ExperimentContext build()

Creates fully initialized ExperimentContext instance.

Returns:

the fully initialized ExperimentContext instance.