Package com.tnsai.evaluation.model

Record Class Baseline

java.lang.Object

java.lang.Record

com.tnsai.evaluation.model.Baseline

public record Baseline(String datasetName, String runId, Instant timestamp, Map<String,Double> scores, Map<String,Object> metadata)
extends Record

A saved baseline from a benchmark run, used for regression detection.

Since:

0.1.0

Constructor Summary

Constructors

Constructor	Description
Baseline(String datasetName, String runId, Instant timestamp, Map<String,Double> scores, Map<String,Object> metadata)	Creates an instance of a Baseline record class.

Method Summary

Modifier and Type	Method	Description
String	datasetName()	Returns the value of the datasetName record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static Baseline	fromBenchmarkResult(BenchmarkResult result)
final int	hashCode()	Returns a hash code value for this object.
static Baseline	loadFrom(Path path)
Map<String,Object>	metadata()	Returns the value of the metadata record component.
String	runId()	Returns the value of the runId record component.
void	saveTo(Path path)
Map<String,Double>	scores()	Returns the value of the scores record component.
Instant	timestamp()	Returns the value of the timestamp record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Baseline

public Baseline(String datasetName,
 String runId,
 Instant timestamp,
 Map<String,Double> scores,
 Map<String,Object> metadata)

Creates an instance of a Baseline record class.

Parameters:

datasetName - the value for the datasetName record component

runId - the value for the runId record component

timestamp - the value for the timestamp record component

scores - the value for the scores record component

metadata - the value for the metadata record component

Method Details

fromBenchmarkResult

public static Baseline fromBenchmarkResult(BenchmarkResult result)

saveTo

public void saveTo(Path path)
            throws IOException

Throws:

IOException

loadFrom

public static Baseline loadFrom(Path path)
                         throws IOException

Throws:

IOException

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

datasetName

public String datasetName()

Returns the value of the datasetName record component.

Returns:

the value of the datasetName record component

runId

public String runId()

Returns the value of the runId record component.

Returns:

the value of the runId record component

timestamp

public Instant timestamp()

Returns the value of the timestamp record component.

Returns:

the value of the timestamp record component

scores

public Map<String,Double> scores()

Returns the value of the scores record component.

Returns:

the value of the scores record component

metadata

public Map<String,Object> metadata()

Returns the value of the metadata record component.

Returns:

the value of the metadata record component