Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ml.inference.trainedmodel.ensemble

Class WeightedMode

java.lang.Object

org.elasticsearch.xpack.core.ml.inference.trainedmodel.ensemble.WeightedMode

All Implemented Interfaces:

org.apache.lucene.util.Accountable, NamedWriteable, Writeable, ToXContent, ToXContentObject, LenientlyParsedOutputAggregator, OutputAggregator, StrictlyParsedOutputAggregator, NamedXContentObject

public class WeightedMode
extends Object
implements StrictlyParsedOutputAggregator, LenientlyParsedOutputAggregator

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final ParseField	NAME
static final ParseField	NUM_CLASSES
static final ParseField	WEIGHTS

Fields inherited from interface org.apache.lucene.util.Accountable

NULL_ACCOUNTABLE

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
WeightedMode(double[] weights, Integer numClasses)
WeightedMode(StreamInput in)

Method Summary

Modifier and Type	Method	Description
double	aggregate(double[] values)	Function to aggregate the processed values into a single double This may be as simple as returning the index of the maximum value.
boolean	compatibleWith(TargetType targetType)
boolean	equals(Object o)
Integer	expectedValueSize()
static WeightedMode	fromXContentLenient(XContentParser parser)
static WeightedMode	fromXContentStrict(XContentParser parser)
String	getName()
String	getWriteableName()
int	hashCode()
double[]	processValues(double[][] values)	This pre-processes the values so that they may be passed directly to the OutputAggregator.aggregate(double[]) method.
long	ramBytesUsed()
XContentBuilder	toXContent(XContentBuilder builder, 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.apache.lucene.util.Accountable

getChildResources

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

NAME

public static final ParseField NAME

WEIGHTS

public static final ParseField WEIGHTS

NUM_CLASSES

public static final ParseField NUM_CLASSES

Constructor Details

WeightedMode

public WeightedMode(double[] weights,
 Integer numClasses)

WeightedMode

public WeightedMode(StreamInput in)
             throws IOException

Throws:

IOException

Method Details

fromXContentStrict

public static WeightedMode fromXContentStrict(XContentParser parser)

fromXContentLenient

public static WeightedMode fromXContentLenient(XContentParser parser)

expectedValueSize

public Integer expectedValueSize()

Specified by:

expectedValueSize in interface OutputAggregator

Returns:

The expected size of the values array when aggregating. `null` implies there is no expected size.

processValues

public double[] processValues(double[][] values)

Description copied from interface: OutputAggregator

This pre-processes the values so that they may be passed directly to the OutputAggregator.aggregate(double[]) method. Two major types of pre-processed values could be returned: - The confidence/probability scaled values given the input values (See: processValues(double[][]) - A simple transformation of the passed values in preparation for aggregation (See: WeightedSum.processValues(double[][])

Specified by:

processValues in interface OutputAggregator

Parameters:

values - the values to process

Returns:

A new list containing the processed values or the same list if no processing is required

aggregate

public double aggregate(double[] values)

Description copied from interface: OutputAggregator

Function to aggregate the processed values into a single double This may be as simple as returning the index of the maximum value. Or as complex as a mathematical reduction of all the passed values (i.e. summation, average, etc.).

Specified by:

aggregate in interface OutputAggregator

Parameters:

values - The values to aggregate

Returns:

the aggregated value.

getName

public String getName()

Specified by:

getName in interface NamedXContentObject

Specified by:

getName in interface OutputAggregator

Returns:

The name of the output aggregator

compatibleWith

public boolean compatibleWith(TargetType targetType)

Specified by:

compatibleWith in interface OutputAggregator

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 XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

ramBytesUsed

public long ramBytesUsed()

Specified by:

ramBytesUsed in interface org.apache.lucene.util.Accountable