Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ml.dataframe.evaluation.regression

Class RSquared

java.lang.Object

org.elasticsearch.xpack.core.ml.dataframe.evaluation.regression.RSquared

All Implemented Interfaces:

NamedWriteable, Writeable, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject, EvaluationMetric

public class RSquared
extends Object
implements EvaluationMetric

Calculates R-Squared between two known numerical fields. equation: R-Squared = 1 - SSres/SStot such that, SSres = Σ(y - y´)^2, The residual sum of squares SStot = Σ(y - y_mean)^2, The total sum of squares

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RSquared.Result

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V extends Object>, Writeable.Writer<V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static final org.elasticsearch.xcontent.ParseField	NAME

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
RSquared()
RSquared(StreamInput in)

Method Summary

Modifier and Type	Method	Description
org.elasticsearch.core.Tuple<List<AggregationBuilder>,List<PipelineAggregationBuilder>>	aggs(EvaluationParameters parameters, EvaluationFields fields)	Builds the aggregation that collect required data to compute the metric
boolean	equals(Object o)
static RSquared	fromXContent(org.elasticsearch.xcontent.XContentParser parser)
String	getName()	Returns the name of the metric (which may differ to the writeable name)
Set<String>	getRequiredFields()	Returns the set of fields that this metric requires in order to be calculated.
Optional<EvaluationMetricResult>	getResult()	Gets the evaluation result for this metric.
String	getWriteableName()
int	hashCode()
void	process(InternalAggregations aggs)	Processes given aggregations as a step towards computing result
org.elasticsearch.xcontent.XContentBuilder	toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

NAME

public static final org.elasticsearch.xcontent.ParseField NAME

Constructor Details

RSquared

public RSquared(StreamInput in)

RSquared

public RSquared()

Method Details

fromXContent

public static RSquared fromXContent(org.elasticsearch.xcontent.XContentParser parser)

getName

public String getName()

Description copied from interface: EvaluationMetric

Returns the name of the metric (which may differ to the writeable name)

Specified by:

getName in interface EvaluationMetric

getRequiredFields

public Set<String> getRequiredFields()

Description copied from interface: EvaluationMetric

Returns the set of fields that this metric requires in order to be calculated.

Specified by:

getRequiredFields in interface EvaluationMetric

aggs

public org.elasticsearch.core.Tuple<List<AggregationBuilder>,List<PipelineAggregationBuilder>> aggs(EvaluationParameters parameters,
 EvaluationFields fields)

Description copied from interface: EvaluationMetric

Builds the aggregation that collect required data to compute the metric

Specified by:

aggs in interface EvaluationMetric

Parameters:

parameters - settings that may be needed by aggregations

fields - fields that may be needed by aggregations

Returns:

the aggregations required to compute the metric

process

public void process(InternalAggregations aggs)

Description copied from interface: EvaluationMetric

Processes given aggregations as a step towards computing result

Specified by:

process in interface EvaluationMetric

Parameters:

aggs - aggregations from SearchResponse

getResult

public Optional<EvaluationMetricResult> getResult()

Description copied from interface: EvaluationMetric

Gets the evaluation result for this metric.

Specified by:

getResult in interface EvaluationMetric

Returns:

Optional.empty() if the result is not available yet, Optional.of(result) otherwise

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder,
 org.elasticsearch.xcontent.ToXContent.Params params)
                                                      throws IOException

Specified by:

toXContent in interface org.elasticsearch.xcontent.ToXContent

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object