org.apache.ignite.ml.optimization.updatecalculators

Class RPropParameterUpdate

java.lang.Object

org.apache.ignite.ml.optimization.updatecalculators.RPropParameterUpdate

All Implemented Interfaces:

Serializable

public class RPropParameterUpdate
extends Object
implements Serializable

Data needed for RProp updater.

See RProp.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Vector	deltas Previous iteration parameters deltas.
protected Vector	prevIterationGradient Previous iteration model partial derivatives by parameters.
protected Vector	prevIterationUpdates Previous iteration parameters updates.
protected Vector	updatesMask Updates mask (values by which updateCache is multiplied).

Constructor Summary

Constructors

Constructor and Description
RPropParameterUpdate(Vector prevIterationUpdates, Vector prevIterationGradient, Vector deltas, Vector updatesMask) Construct instance of this class by given parameters.

Method Summary

Modifier and Type	Method and Description
static RPropParameterUpdate	avg(List<RPropParameterUpdate> updates) Averages updates returned by different trainings.
RPropParameterUpdate	setDeltas(Vector deltas) Set previous iteration deltas.
RPropParameterUpdate	setUpdatesMask(Vector updatesMask) Set updates mask (values by which updateCache is multiplied).
static RPropParameterUpdate	sum(List<RPropParameterUpdate> updates) Sums updates returned by different trainings.
static RPropParameterUpdate	sumLocal(List<RPropParameterUpdate> updates) Sums updates during one training.
Vector	updatesMask() Get updates mask (values by which updateCache is multiplied).

Methods inherited from class java.lang.Object

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

Field Detail

prevIterationUpdates

protected Vector prevIterationUpdates

Previous iteration parameters updates. In original paper they are labeled with "delta w".

prevIterationGradient

protected Vector prevIterationGradient

Previous iteration model partial derivatives by parameters.

deltas

protected Vector deltas

Previous iteration parameters deltas. In original paper they are labeled with "delta".

updatesMask

protected Vector updatesMask

Updates mask (values by which updateCache is multiplied).

Constructor Detail

RPropParameterUpdate

public RPropParameterUpdate(Vector prevIterationUpdates,
                            Vector prevIterationGradient,
                            Vector deltas,
                            Vector updatesMask)

Construct instance of this class by given parameters.

Parameters:

prevIterationUpdates - Previous iteration parameters updates.

prevIterationGradient - Previous iteration model partial derivatives by parameters.

deltas - Previous iteration parameters deltas.

updatesMask - Updates mask.

Method Detail

updatesMask

public Vector updatesMask()

Get updates mask (values by which updateCache is multiplied).

Returns:

Updates mask (values by which updateCache is multiplied).

setUpdatesMask

public RPropParameterUpdate setUpdatesMask(Vector updatesMask)

Set updates mask (values by which updateCache is multiplied).

Parameters:

updatesMask - New updatesMask.

Returns:

This object.

setDeltas

public RPropParameterUpdate setDeltas(Vector deltas)

Set previous iteration deltas.

Parameters:

deltas - New deltas.

Returns:

This object.

sumLocal

public static RPropParameterUpdate sumLocal(List<RPropParameterUpdate> updates)

Sums updates during one training.

Parameters:

updates - Updates.

Returns:

Sum of updates during one training.

sum

public static RPropParameterUpdate sum(List<RPropParameterUpdate> updates)

Sums updates returned by different trainings.

Parameters:

updates - Updates.

Returns:

Sum of updates during returned by different trainings.

avg

public static RPropParameterUpdate avg(List<RPropParameterUpdate> updates)

Averages updates returned by different trainings.

Parameters:

updates - Updates.

Returns:

Averages of updates during returned by different trainings.