Package org.opensearch.ml.common.input.parameter.regression

Class LinearRegressionParams

java.lang.Object

org.opensearch.ml.common.input.parameter.regression.LinearRegressionParams

All Implemented Interfaces:

org.opensearch.core.common.io.stream.NamedWriteable, org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject, MLAlgoParams

public class LinearRegressionParams
extends Object
implements MLAlgoParams

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LinearRegressionParams.LinearRegressionParamsBuilder
static enum	LinearRegressionParams.MomentumType
static enum	LinearRegressionParams.ObjectiveType
static enum	LinearRegressionParams.OptimizerType

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

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

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BATCH_SIZE_FIELD
static final String	BETA1_FIELD
static final String	BETA2_FIELD
static final String	DECAY_RATE_FIELD
static final String	EPOCHS_FIELD
static final String	EPSILON_FIELD
static final String	LEARNING_RATE_FIELD
static final String	LOGGING_INTERVAL_FIELD
static final String	MOMENTUM_FACTOR_FIELD
static final String	MOMENTUM_TYPE_FIELD
static final String	OBJECTIVE_FIELD
static final String	OPTIMISER_FIELD
static final String	PARSE_FIELD_NAME
static final String	SEED_FIELD
static final String	TARGET_FIELD
static final org.opensearch.core.xcontent.NamedXContentRegistry.Entry	XCONTENT_REGISTRY

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
LinearRegressionParams(org.opensearch.core.common.io.stream.StreamInput in)
LinearRegressionParams(LinearRegressionParams.ObjectiveType objectiveType, LinearRegressionParams.OptimizerType optimizerType, Double learningRate, LinearRegressionParams.MomentumType momentumType, Double momentumFactor, Double epsilon, Double beta1, Double beta2, Double decayRate, Integer epochs, Integer batchSize, Integer loggingInterval, Long seed, String target)

Method Summary

Modifier and Type	Method	Description
static LinearRegressionParams.LinearRegressionParamsBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Integer	getBatchSize()
Double	getBeta1()
Double	getBeta2()
Double	getDecayRate()
Integer	getEpochs()
Double	getEpsilon()
Double	getLearningRate()
Integer	getLoggingInterval()
Double	getMomentumFactor()
LinearRegressionParams.MomentumType	getMomentumType()
LinearRegressionParams.ObjectiveType	getObjectiveType()
LinearRegressionParams.OptimizerType	getOptimizerType()
Long	getSeed()
String	getTarget()
int	getVersion()
String	getWriteableName()
int	hashCode()
static MLAlgoParams	parse(org.opensearch.core.xcontent.XContentParser parser)
void	setBatchSize(Integer batchSize)
void	setBeta1(Double beta1)
void	setBeta2(Double beta2)
void	setDecayRate(Double decayRate)
void	setEpochs(Integer epochs)
void	setEpsilon(Double epsilon)
void	setLearningRate(Double learningRate)
void	setLoggingInterval(Integer loggingInterval)
void	setMomentumFactor(Double momentumFactor)
void	setMomentumType(LinearRegressionParams.MomentumType momentumType)
void	setObjectiveType(LinearRegressionParams.ObjectiveType objectiveType)
void	setOptimizerType(LinearRegressionParams.OptimizerType optimizerType)
void	setSeed(Long seed)
void	setTarget(String target)
LinearRegressionParams.LinearRegressionParamsBuilder	toBuilder()
String	toString()
org.opensearch.core.xcontent.XContentBuilder	toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opensearch.core.xcontent.ToXContentObject

isFragment

Field Details

PARSE_FIELD_NAME

public static final String PARSE_FIELD_NAME

XCONTENT_REGISTRY

public static final org.opensearch.core.xcontent.NamedXContentRegistry.Entry XCONTENT_REGISTRY

OBJECTIVE_FIELD

public static final String OBJECTIVE_FIELD

See Also:

• Constant Field Values

OPTIMISER_FIELD

public static final String OPTIMISER_FIELD

See Also:

• Constant Field Values

LEARNING_RATE_FIELD

public static final String LEARNING_RATE_FIELD

See Also:

• Constant Field Values

MOMENTUM_TYPE_FIELD

public static final String MOMENTUM_TYPE_FIELD

See Also:

• Constant Field Values

MOMENTUM_FACTOR_FIELD

public static final String MOMENTUM_FACTOR_FIELD

See Also:

• Constant Field Values

EPSILON_FIELD

public static final String EPSILON_FIELD

See Also:

• Constant Field Values

BETA1_FIELD

public static final String BETA1_FIELD

See Also:

• Constant Field Values

BETA2_FIELD

public static final String BETA2_FIELD

See Also:

• Constant Field Values

DECAY_RATE_FIELD

public static final String DECAY_RATE_FIELD

See Also:

• Constant Field Values

EPOCHS_FIELD

public static final String EPOCHS_FIELD

See Also:

• Constant Field Values

BATCH_SIZE_FIELD

public static final String BATCH_SIZE_FIELD

See Also:

• Constant Field Values

LOGGING_INTERVAL_FIELD

public static final String LOGGING_INTERVAL_FIELD

See Also:

• Constant Field Values

SEED_FIELD

public static final String SEED_FIELD

See Also:

• Constant Field Values

TARGET_FIELD

public static final String TARGET_FIELD

See Also:

• Constant Field Values

Constructor Details

LinearRegressionParams

public LinearRegressionParams(LinearRegressionParams.ObjectiveType objectiveType,
 LinearRegressionParams.OptimizerType optimizerType,
 Double learningRate,
 LinearRegressionParams.MomentumType momentumType,
 Double momentumFactor,
 Double epsilon,
 Double beta1,
 Double beta2,
 Double decayRate,
 Integer epochs,
 Integer batchSize,
 Integer loggingInterval,
 Long seed,
 String target)

LinearRegressionParams

public LinearRegressionParams(org.opensearch.core.common.io.stream.StreamInput in)
                       throws IOException

Throws:

IOException

Method Details

parse

public static MLAlgoParams parse(org.opensearch.core.xcontent.XContentParser parser)
                          throws IOException

Throws:

IOException

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface org.opensearch.core.common.io.stream.NamedWriteable

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Throws:

IOException

toXContent

public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                        throws IOException

Specified by:

toXContent in interface org.opensearch.core.xcontent.ToXContent

Throws:

IOException

getVersion

public int getVersion()

Specified by:

getVersion in interface MLAlgoParams

builder

public static LinearRegressionParams.LinearRegressionParamsBuilder builder()

toBuilder

public LinearRegressionParams.LinearRegressionParamsBuilder toBuilder()

getObjectiveType

public LinearRegressionParams.ObjectiveType getObjectiveType()

getOptimizerType

public LinearRegressionParams.OptimizerType getOptimizerType()

getLearningRate

public Double getLearningRate()

getMomentumType

public LinearRegressionParams.MomentumType getMomentumType()

getMomentumFactor

public Double getMomentumFactor()

getEpsilon

public Double getEpsilon()

getBeta1

public Double getBeta1()

getBeta2

public Double getBeta2()

getDecayRate

public Double getDecayRate()

getEpochs

public Integer getEpochs()

getBatchSize

public Integer getBatchSize()

getLoggingInterval

public Integer getLoggingInterval()

getSeed

public Long getSeed()

getTarget

public String getTarget()

setObjectiveType

public void setObjectiveType(LinearRegressionParams.ObjectiveType objectiveType)

setOptimizerType

public void setOptimizerType(LinearRegressionParams.OptimizerType optimizerType)

setLearningRate

public void setLearningRate(Double learningRate)

setMomentumType

public void setMomentumType(LinearRegressionParams.MomentumType momentumType)

setMomentumFactor

public void setMomentumFactor(Double momentumFactor)

setEpsilon

public void setEpsilon(Double epsilon)

setBeta1

public void setBeta1(Double beta1)

setBeta2

public void setBeta2(Double beta2)

setDecayRate

public void setDecayRate(Double decayRate)

setEpochs

public void setEpochs(Integer epochs)

setBatchSize

public void setBatchSize(Integer batchSize)

setLoggingInterval

public void setLoggingInterval(Integer loggingInterval)

setSeed

public void setSeed(Long seed)

setTarget

public void setTarget(String target)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object