Module org.elasticsearch.xcore

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

Class ClassificationConfig

java.lang.Object

org.elasticsearch.xpack.core.ml.inference.trainedmodel.ClassificationConfig

All Implemented Interfaces:

NamedWriteable, VersionedNamedWriteable, Writeable, ToXContent, ToXContentObject, InferenceConfig, LenientlyParsedInferenceConfig, StrictlyParsedInferenceConfig, NamedXContentObject

public class ClassificationConfig
extends Object
implements LenientlyParsedInferenceConfig, StrictlyParsedInferenceConfig

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClassificationConfig.Builder

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 ClassificationConfig	EMPTY_PARAMS
static final ParseField	NAME
static final ParseField	NUM_TOP_CLASSES
static final ParseField	NUM_TOP_FEATURE_IMPORTANCE_VALUES
static final ParseField	PREDICTION_FIELD_TYPE
static final ParseField	TOP_CLASSES_RESULTS_FIELD

Fields inherited from interface org.elasticsearch.xpack.core.ml.inference.trainedmodel.InferenceConfig

DEFAULT_RESULTS_FIELD, DEFAULT_TOP_CLASSES_RESULTS_FIELD, RESULTS_FIELD

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY

Constructor Summary

Constructors

Constructor	Description
ClassificationConfig(Integer numTopClasses)
ClassificationConfig(Integer numTopClasses, String resultsField, String topClassesResultsField, Integer featureImportance, PredictionFieldType predictionFieldType)
ClassificationConfig(StreamInput in)

Method Summary

Modifier and Type	Method	Description
InferenceConfig	apply(InferenceConfigUpdate update)	Return a copy of this with the settings updated by the values in update.
static ClassificationConfig.Builder	builder()
boolean	equals(Object o)
static ClassificationConfig	fromXContentLenient(XContentParser parser)
static ClassificationConfig	fromXContentStrict(XContentParser parser)
MlConfigVersion	getMinimalSupportedMlConfigVersion()	All nodes in the cluster must have at least this MlConfigVersion attribute
TransportVersion	getMinimalSupportedTransportVersion()	All communication in the cluster must use at least this version
String	getName()
int	getNumTopClasses()
int	getNumTopFeatureImportanceValues()
PredictionFieldType	getPredictionFieldType()
String	getResultsField()
String	getTopClassesResultsField()
String	getWriteableName()
int	hashCode()
boolean	isAllocateOnly()
boolean	isTargetTypeSupported(TargetType targetType)
boolean	requestingImportance()
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.elasticsearch.xpack.core.ml.inference.trainedmodel.InferenceConfig

getDefaultInput, getMinimalSupportedVersion, getMinLicenseSupported, getMinLicenseSupportedForAction, incompatibleUpdateException, supportsIngestPipeline, supportsPipelineAggregation, supportsSearchRescorer, validateTrainedModelInput

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Methods inherited from interface org.elasticsearch.common.io.stream.VersionedNamedWriteable

supportsVersion

Field Details

NAME

public static final ParseField NAME

NUM_TOP_CLASSES

public static final ParseField NUM_TOP_CLASSES

TOP_CLASSES_RESULTS_FIELD

public static final ParseField TOP_CLASSES_RESULTS_FIELD

NUM_TOP_FEATURE_IMPORTANCE_VALUES

public static final ParseField NUM_TOP_FEATURE_IMPORTANCE_VALUES

PREDICTION_FIELD_TYPE

public static final ParseField PREDICTION_FIELD_TYPE

EMPTY_PARAMS

public static final ClassificationConfig EMPTY_PARAMS

Constructor Details

ClassificationConfig

public ClassificationConfig(Integer numTopClasses)

ClassificationConfig

public ClassificationConfig(Integer numTopClasses,
 String resultsField,
 String topClassesResultsField,
 Integer featureImportance,
 PredictionFieldType predictionFieldType)

ClassificationConfig

public ClassificationConfig(StreamInput in)
                     throws IOException

Throws:

IOException

Method Details

fromXContentStrict

public static ClassificationConfig fromXContentStrict(XContentParser parser)

fromXContentLenient

public static ClassificationConfig fromXContentLenient(XContentParser parser)

apply

public InferenceConfig apply(InferenceConfigUpdate update)

Description copied from interface: InferenceConfig

Return a copy of this with the settings updated by the values in update.

Specified by:

apply in interface InferenceConfig

Parameters:

update - The update to apply

Returns:

A new updated config

getNumTopClasses

public int getNumTopClasses()

getTopClassesResultsField

public String getTopClassesResultsField()

getResultsField

public String getResultsField()

Specified by:

getResultsField in interface InferenceConfig

getNumTopFeatureImportanceValues

public int getNumTopFeatureImportanceValues()

getPredictionFieldType

public PredictionFieldType getPredictionFieldType()

requestingImportance

public boolean requestingImportance()

Specified by:

requestingImportance in interface InferenceConfig

isAllocateOnly

public boolean isAllocateOnly()

Specified by:

isAllocateOnly in interface InferenceConfig

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

Specified by:

getWriteableName in interface VersionedNamedWriteable

getName

public String getName()

Specified by:

getName in interface NamedXContentObject

Returns:

The name of the XContentObject that is to be serialized

isTargetTypeSupported

public boolean isTargetTypeSupported(TargetType targetType)

Specified by:

isTargetTypeSupported in interface InferenceConfig

getMinimalSupportedMlConfigVersion

public MlConfigVersion getMinimalSupportedMlConfigVersion()

Description copied from interface: InferenceConfig

All nodes in the cluster must have at least this MlConfigVersion attribute

Specified by:

getMinimalSupportedMlConfigVersion in interface InferenceConfig

getMinimalSupportedTransportVersion

public TransportVersion getMinimalSupportedTransportVersion()

Description copied from interface: InferenceConfig

All communication in the cluster must use at least this version

Specified by:

getMinimalSupportedTransportVersion in interface InferenceConfig

builder

public static ClassificationConfig.Builder builder()