ml.comet.experiment.context

Class ExperimentContext

java.lang.Object

ml.comet.experiment.context.ExperimentContext

public final class ExperimentContext
extends Object

Describes context of the Experiment.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExperimentContext.ExperimentContextBuilder Builder to create populated instance of the ExperimentContext.

Constructor Summary

Constructors

Constructor and Description
ExperimentContext(ExperimentContext other) The copy constructor.
ExperimentContext(long step) Creates new instance with specified parameters.
ExperimentContext(long step, long epoch) Creates new instance with specified parameters.
ExperimentContext(long step, long epoch, String context) Creates new instance with specified parameters.
ExperimentContext(String context) Creates new instance with specified parameters.

Method Summary

Modifier and Type	Method and Description
static ExperimentContext.ExperimentContextBuilder	builder() Returns builder to create populated instance of the ExperimentContext.
static ExperimentContext	empty() The factory to return empty ExperimentContext instance.
boolean	equals(Object obj) Indicates whether provided context object equals to this one.
boolean	isEmpty() Allows to check if this is empty context, i.e., has no value set.
void	mergeFrom(@NonNull ExperimentContext other) Merges not empty values from other context into this one.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExperimentContext

public ExperimentContext(String context)

Creates new instance with specified parameters.

Parameters:

context - the current context identifier of the data log operation.

ExperimentContext

public ExperimentContext(long step,
                         long epoch,
                         String context)

Creates new instance with specified parameters.

Parameters:

step - the current step of the experiment.

epoch - the current epoch of the experiment.

context - the current context identifier of the data log operation.

ExperimentContext

public ExperimentContext(long step,
                         long epoch)

Creates new instance with specified parameters.

Parameters:

step - the current step of the experiment.

epoch - the current epoch of the experiment.

ExperimentContext

public ExperimentContext(long step)

Creates new instance with specified parameters.

Parameters:

step - the current step of the experiment.

ExperimentContext

public ExperimentContext(ExperimentContext other)

The copy constructor.

Parameters:

other - the other ExperimentContext to be used as source.

Method Detail

mergeFrom

public void mergeFrom(@NonNull
                      @NonNull ExperimentContext other)

Merges not empty values from other context into this one.

Parameters:

other - the context to be merged into this.

isEmpty

public boolean isEmpty()

Allows to check if this is empty context, i.e., has no value set.

Returns:

true if this is empty context.

equals

public boolean equals(Object obj)

Indicates whether provided context object equals to this one.

Overrides:

equals in class Object

Parameters:

obj - the instance of ExperimentContext to check.

Returns:

true if provided context object equals to this one.

empty

public static ExperimentContext empty()

The factory to return empty ExperimentContext instance.

Returns:

the empty ExperimentContext

builder

public static ExperimentContext.ExperimentContextBuilder builder()

Returns builder to create populated instance of the ExperimentContext.

Returns:

the builder to create populated instance of the ExperimentContext.