Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ml.dataframe.analyses

Class Classification

java.lang.Object

org.elasticsearch.xpack.core.ml.dataframe.analyses.Classification

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentObject, DataFrameAnalysis

public class Classification
extends Object
implements DataFrameAnalysis

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Classification.ClassAssignmentObjective

Nested classes/interfaces inherited from interface org.elasticsearch.xpack.core.ml.dataframe.analyses.DataFrameAnalysis

DataFrameAnalysis.FieldInfo

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	CLASS_ASSIGNMENT_OBJECTIVE
static final ParseField	DEPENDENT_VARIABLE
static final ParseField	EARLY_STOPPING_ENABLED
static final ParseField	FEATURE_PROCESSORS
static final int	MAX_DEPENDENT_VARIABLE_CARDINALITY	The max number of classes classification supports
static final ParseField	NAME
static final ParseField	NUM_TOP_CLASSES
static final ParseField	PREDICTION_FIELD_NAME
static final ParseField	RANDOMIZE_SEED
static final ParseField	TRAINING_PERCENT

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Classification(String dependentVariable)
Classification(String dependentVariable, BoostedTreeParams boostedTreeParams, String predictionFieldName, Classification.ClassAssignmentObjective classAssignmentObjective, Integer numTopClasses, Double trainingPercent, Long randomizeSeed, List<PreProcessor> featureProcessors, Boolean earlyStoppingEnabled)
Classification(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static String	extractJobIdFromStateDoc(String stateDocId)
static Classification	fromXContent(XContentParser parser, boolean ignoreUnknownFields)
Set<String>	getAllowedCategoricalTypes(String fieldName)
BoostedTreeParams	getBoostedTreeParams()
Classification.ClassAssignmentObjective	getClassAssignmentObjective()
String	getDependentVariable()
Boolean	getEarlyStoppingEnabled()
List<PreProcessor>	getFeatureProcessors()
List<FieldCardinalityConstraint>	getFieldCardinalityConstraints()
int	getNumTopClasses()
Map<String,Object>	getParams(DataFrameAnalysis.FieldInfo fieldInfo)
String	getPredictionFieldName()
static PredictionFieldType	getPredictionFieldType(Set<String> dependentVariableTypes)
List<String>	getProgressPhases()	Returns the progress phases the analysis goes through in order
long	getRandomizeSeed()
List<RequiredField>	getRequiredFields()
Map<String,Object>	getResultMappings(String resultsFieldName, FieldCapabilitiesResponse fieldCapabilitiesResponse)	Returns fields for which the mappings should be either predefined or copied from source index to destination index.
String	getStateDocIdPrefix(String jobId)	Returns the document id prefix for the analysis state
double	getTrainingPercent()
String	getWriteableName()
int	hashCode()
InferenceConfig	inferenceConfig(DataFrameAnalysis.FieldInfo fieldInfo)
boolean	persistsState()
boolean	supportsCategoricalFields()
boolean	supportsInference()
boolean	supportsMissingValues()
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.xcontent.ToXContentObject

isFragment

Field Details

NAME

public static final ParseField NAME

DEPENDENT_VARIABLE

public static final ParseField DEPENDENT_VARIABLE

PREDICTION_FIELD_NAME

public static final ParseField PREDICTION_FIELD_NAME

CLASS_ASSIGNMENT_OBJECTIVE

public static final ParseField CLASS_ASSIGNMENT_OBJECTIVE

NUM_TOP_CLASSES

public static final ParseField NUM_TOP_CLASSES

TRAINING_PERCENT

public static final ParseField TRAINING_PERCENT

RANDOMIZE_SEED

public static final ParseField RANDOMIZE_SEED

FEATURE_PROCESSORS

public static final ParseField FEATURE_PROCESSORS

EARLY_STOPPING_ENABLED

public static final ParseField EARLY_STOPPING_ENABLED

MAX_DEPENDENT_VARIABLE_CARDINALITY

public static final int MAX_DEPENDENT_VARIABLE_CARDINALITY

The max number of classes classification supports

See Also:

• Constant Field Values

Constructor Details

Classification

public Classification(String dependentVariable,
 BoostedTreeParams boostedTreeParams,
 @Nullable
 String predictionFieldName,
 @Nullable
 Classification.ClassAssignmentObjective classAssignmentObjective,
 @Nullable
 Integer numTopClasses,
 @Nullable
 Double trainingPercent,
 @Nullable
 Long randomizeSeed,
 @Nullable
 List<PreProcessor> featureProcessors,
 @Nullable
 Boolean earlyStoppingEnabled)

Classification

public Classification(String dependentVariable)

Classification

public Classification(StreamInput in)
               throws IOException

Throws:

IOException

Method Details

fromXContent

public static Classification fromXContent(XContentParser parser,
 boolean ignoreUnknownFields)

getDependentVariable

public String getDependentVariable()

getBoostedTreeParams

public BoostedTreeParams getBoostedTreeParams()

getPredictionFieldName

public String getPredictionFieldName()

getClassAssignmentObjective

public Classification.ClassAssignmentObjective getClassAssignmentObjective()

getNumTopClasses

public int getNumTopClasses()

getTrainingPercent

public double getTrainingPercent()

Specified by:

getTrainingPercent in interface DataFrameAnalysis

Returns:

the percentage of data to use for training

getRandomizeSeed

public long getRandomizeSeed()

getFeatureProcessors

public List<PreProcessor> getFeatureProcessors()

getEarlyStoppingEnabled

public Boolean getEarlyStoppingEnabled()

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

getParams

public Map<String,Object> getParams(DataFrameAnalysis.FieldInfo fieldInfo)

Specified by:

getParams in interface DataFrameAnalysis

Parameters:

fieldInfo - Information about the fields like types and cardinalities

Returns:

The analysis parameters as a map

getPredictionFieldType

public static PredictionFieldType getPredictionFieldType(Set<String> dependentVariableTypes)

supportsCategoricalFields

public boolean supportsCategoricalFields()

Specified by:

supportsCategoricalFields in interface DataFrameAnalysis

Returns:

true if this analysis supports fields with categorical values (i.e. text, keyword, ip)

getAllowedCategoricalTypes

public Set<String> getAllowedCategoricalTypes(String fieldName)

Specified by:

getAllowedCategoricalTypes in interface DataFrameAnalysis

Parameters:

fieldName - field for which the allowed categorical types should be returned

Returns:

The types treated as categorical for the given field

getRequiredFields

public List<RequiredField> getRequiredFields()

Specified by:

getRequiredFields in interface DataFrameAnalysis

Returns:

The names and types of the fields that analyzed documents must have for the analysis to operate

getFieldCardinalityConstraints

public List<FieldCardinalityConstraint> getFieldCardinalityConstraints()

Specified by:

getFieldCardinalityConstraints in interface DataFrameAnalysis

Returns:

List containing cardinality constraints for the selected (analysis-specific) fields

getResultMappings

public Map<String,Object> getResultMappings(String resultsFieldName,
 FieldCapabilitiesResponse fieldCapabilitiesResponse)

Description copied from interface: DataFrameAnalysis

Returns fields for which the mappings should be either predefined or copied from source index to destination index.

Specified by:

getResultMappings in interface DataFrameAnalysis

Parameters:

resultsFieldName - name of the results field under which all the results are stored

fieldCapabilitiesResponse - field capabilities fetched for this analysis' required fields

Returns:

Map containing fields for which the mappings should be handled explicitly

supportsMissingValues

public boolean supportsMissingValues()

Specified by:

supportsMissingValues in interface DataFrameAnalysis

Returns:

true if this analysis supports data frame rows with missing values

persistsState

public boolean persistsState()

Specified by:

persistsState in interface DataFrameAnalysis

Returns:

true if this analysis persists state that can later be used to restore from a given point

getStateDocIdPrefix

public String getStateDocIdPrefix(String jobId)

Description copied from interface: DataFrameAnalysis

Returns the document id prefix for the analysis state

Specified by:

getStateDocIdPrefix in interface DataFrameAnalysis

getProgressPhases

public List<String> getProgressPhases()

Description copied from interface: DataFrameAnalysis

Returns the progress phases the analysis goes through in order

Specified by:

getProgressPhases in interface DataFrameAnalysis

inferenceConfig

public InferenceConfig inferenceConfig(DataFrameAnalysis.FieldInfo fieldInfo)

Specified by:

inferenceConfig in interface DataFrameAnalysis

Returns:

the analysis inference config or null if inference is not supported

supportsInference

public boolean supportsInference()

Specified by:

supportsInference in interface DataFrameAnalysis

Returns:

true if this analysis trains a model that can be used for inference

extractJobIdFromStateDoc

public static String extractJobIdFromStateDoc(String stateDocId)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object