Module org.elasticsearch.xcore

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

Class BoostedTreeParams

java.lang.Object

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

All Implemented Interfaces:

Writeable, ToXContent, ToXContentFragment

public class BoostedTreeParams
extends Object
implements ToXContentFragment, Writeable

Parameters used by both Classification and Regression analyses.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BoostedTreeParams.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 ParseField	ALPHA
static final ParseField	DOWNSAMPLE_FACTOR
static final ParseField	ETA
static final ParseField	ETA_GROWTH_RATE_PER_TREE
static final ParseField	FEATURE_BAG_FRACTION
static final ParseField	GAMMA
static final ParseField	LAMBDA
static final ParseField	MAX_OPTIMIZATION_ROUNDS_PER_HYPERPARAMETER
static final ParseField	MAX_TREES
static final ParseField	NUM_TOP_FEATURE_IMPORTANCE_VALUES
static final ParseField	SOFT_TREE_DEPTH_LIMIT
static final ParseField	SOFT_TREE_DEPTH_TOLERANCE

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
BoostedTreeParams(Double lambda, Double gamma, Double eta, Integer maxTrees, Double featureBagFraction, Integer numTopFeatureImportanceValues, Double alpha, Double etaGrowthRatePerTree, Double softTreeDepthLimit, Double softTreeDepthTolerance, Double downsampleFactor, Integer maxOptimizationRoundsPerHyperparameter)

Method Summary

Modifier and Type	Method	Description
static BoostedTreeParams.Builder	builder()
boolean	equals(Object o)
Double	getAlpha()
Double	getDownsampleFactor()
Double	getEta()
Double	getEtaGrowthRatePerTree()
Double	getFeatureBagFraction()
Double	getGamma()
Double	getLambda()
Integer	getMaxOptimizationRoundsPerHyperparameter()
Integer	getMaxTrees()
Integer	getNumTopFeatureImportanceValues()
Double	getSoftTreeDepthLimit()
Double	getSoftTreeDepthTolerance()
int	hashCode()
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.ToXContentFragment

isFragment

Field Details

LAMBDA

public static final ParseField LAMBDA

GAMMA

public static final ParseField GAMMA

ETA

public static final ParseField ETA

MAX_TREES

public static final ParseField MAX_TREES

FEATURE_BAG_FRACTION

public static final ParseField FEATURE_BAG_FRACTION

NUM_TOP_FEATURE_IMPORTANCE_VALUES

public static final ParseField NUM_TOP_FEATURE_IMPORTANCE_VALUES

ALPHA

public static final ParseField ALPHA

ETA_GROWTH_RATE_PER_TREE

public static final ParseField ETA_GROWTH_RATE_PER_TREE

SOFT_TREE_DEPTH_LIMIT

public static final ParseField SOFT_TREE_DEPTH_LIMIT

SOFT_TREE_DEPTH_TOLERANCE

public static final ParseField SOFT_TREE_DEPTH_TOLERANCE

DOWNSAMPLE_FACTOR

public static final ParseField DOWNSAMPLE_FACTOR

MAX_OPTIMIZATION_ROUNDS_PER_HYPERPARAMETER

public static final ParseField MAX_OPTIMIZATION_ROUNDS_PER_HYPERPARAMETER

Constructor Details

BoostedTreeParams

public BoostedTreeParams(@Nullable
 Double lambda,
 @Nullable
 Double gamma,
 @Nullable
 Double eta,
 @Nullable
 Integer maxTrees,
 @Nullable
 Double featureBagFraction,
 @Nullable
 Integer numTopFeatureImportanceValues,
 @Nullable
 Double alpha,
 @Nullable
 Double etaGrowthRatePerTree,
 @Nullable
 Double softTreeDepthLimit,
 @Nullable
 Double softTreeDepthTolerance,
 @Nullable
 Double downsampleFactor,
 @Nullable
 Integer maxOptimizationRoundsPerHyperparameter)

Method Details

getLambda

public Double getLambda()

getGamma

public Double getGamma()

getEta

public Double getEta()

getMaxTrees

public Integer getMaxTrees()

getFeatureBagFraction

public Double getFeatureBagFraction()

getNumTopFeatureImportanceValues

public Integer getNumTopFeatureImportanceValues()

getAlpha

public Double getAlpha()

getEtaGrowthRatePerTree

public Double getEtaGrowthRatePerTree()

getSoftTreeDepthLimit

public Double getSoftTreeDepthLimit()

getSoftTreeDepthTolerance

public Double getSoftTreeDepthTolerance()

getDownsampleFactor

public Double getDownsampleFactor()

getMaxOptimizationRoundsPerHyperparameter

public Integer getMaxOptimizationRoundsPerHyperparameter()

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

builder

public static BoostedTreeParams.Builder builder()