org.tribuo.data.columnar.processors.response

Class QuartileResponseProcessor<T extends Output<T>>

java.lang.Object

org.tribuo.data.columnar.processors.response.QuartileResponseProcessor<T>

All Implemented Interfaces:

com.oracle.labs.mlrg.olcut.config.Configurable, com.oracle.labs.mlrg.olcut.provenance.Provenancable<com.oracle.labs.mlrg.olcut.provenance.ConfiguredObjectProvenance>, ResponseProcessor<T>

public class QuartileResponseProcessor<T extends Output<T>>
extends Object
implements ResponseProcessor<T>

Processes the response into quartiles and emits them as classification outputs.

The emitted outputs are of the form {<name>:first, <name>:second, <name>:third, <name>:fourth} .

Constructor Summary

Constructors

Constructor and Description
QuartileResponseProcessor(String name, String fieldName, Quartile quartile, OutputFactory<T> outputFactory) Constructs a repsonse processor which emits 4 distinct bins for the output factory to process.

Method Summary

Modifier and Type	Method and Description
String	getFieldName() Gets the field name this ResponseProcessor uses.
OutputFactory<T>	getOutputFactory() Gets the OutputFactory this ResponseProcessor uses.
com.oracle.labs.mlrg.olcut.provenance.ConfiguredObjectProvenance	getProvenance()
Optional<T>	process(String value) Returns Optional.empty() if it failed to process out a response.
void	setFieldName(String fieldName) Deprecated.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.oracle.labs.mlrg.olcut.config.Configurable

postConfig

Constructor Detail

QuartileResponseProcessor

public QuartileResponseProcessor(String name,
                                 String fieldName,
                                 Quartile quartile,
                                 OutputFactory<T> outputFactory)

Constructs a repsonse processor which emits 4 distinct bins for the output factory to process.

This works best with classification outputs as the discrete binning is tricky to do in other output types.

Parameters:

name - The output string to emit.

fieldName - The field to read.

quartile - The quartile range to use.

outputFactory - The output factory to use.

Method Detail

setFieldName

@Deprecated
public void setFieldName(String fieldName)

Deprecated.

Specified by:

setFieldName in interface ResponseProcessor<T extends Output<T>>

Parameters:

fieldName - The field name.

getOutputFactory

public OutputFactory<T> getOutputFactory()

Description copied from interface: ResponseProcessor

Gets the OutputFactory this ResponseProcessor uses.

Specified by:

getOutputFactory in interface ResponseProcessor<T extends Output<T>>

Returns:

The output factory.

getFieldName

public String getFieldName()

Description copied from interface: ResponseProcessor

Gets the field name this ResponseProcessor uses.

Specified by:

getFieldName in interface ResponseProcessor<T extends Output<T>>

Returns:

The field name.

process

public Optional<T> process(String value)

Description copied from interface: ResponseProcessor

Returns Optional.empty() if it failed to process out a response.

Specified by:

process in interface ResponseProcessor<T extends Output<T>>

Parameters:

value - The value to process.

Returns:

The response value if found.

toString

public String toString()

Overrides:

toString in class Object

getProvenance

public com.oracle.labs.mlrg.olcut.provenance.ConfiguredObjectProvenance getProvenance()

Specified by:

getProvenance in interface com.oracle.labs.mlrg.olcut.provenance.Provenancable<com.oracle.labs.mlrg.olcut.provenance.ConfiguredObjectProvenance>