hex.genmodel.algos.glrm

Enum GlrmRegularizer

java.lang.Object

java.lang.Enum<GlrmRegularizer>

hex.genmodel.algos.glrm.GlrmRegularizer

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<GlrmRegularizer>

public enum GlrmRegularizer
extends java.lang.Enum<GlrmRegularizer>

Regularization method for matrices X and Y in the GLRM algorithm. Examples: + Non-negative matrix factorization (NNMF): r_x = r_y = NonNegative + Orthogonal NNMF: r_x = OneSparse, r_y = NonNegative + K-means clustering: r_x = UnitOneSparse, r_y = 0 (\gamma_y = 0) + Quadratic mixture: r_x = Simplex, r_y = 0 (\gamma_y = 0)

Enum Constant Summary

Enum Constants

Enum Constant and Description
L1
L2
None
NonNegative
OneSparse
Quadratic
Simplex
UnitOneSparse

Method Summary

Modifier and Type	Method and Description
abstract double[]	project(double[] u, java.util.Random rand) Project X,Y matrices into appropriate subspace so regularizer is finite.
abstract double	regularize(double[] u) Regularization function applied to a single row x_i or column y_j
double	regularize(double[][] u) Regularization applied to an entire matrix (sum over rows)
abstract double[]	rproxgrad(double[] u, double delta, java.util.Random rand) \prox_{\alpha_k*r}(u): Proximal gradient of (step size) * (regularization function) evaluated at vector u
static GlrmRegularizer	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static GlrmRegularizer[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

None

public static final GlrmRegularizer None

Quadratic

public static final GlrmRegularizer Quadratic

L2

public static final GlrmRegularizer L2

L1

public static final GlrmRegularizer L1

NonNegative

public static final GlrmRegularizer NonNegative

OneSparse

public static final GlrmRegularizer OneSparse

UnitOneSparse

public static final GlrmRegularizer UnitOneSparse

Simplex

public static final GlrmRegularizer Simplex

Method Detail

values

public static GlrmRegularizer[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (GlrmRegularizer c : GlrmRegularizer.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static GlrmRegularizer valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

regularize

public abstract double regularize(double[] u)

Regularization function applied to a single row x_i or column y_j

regularize

public final double regularize(double[][] u)

Regularization applied to an entire matrix (sum over rows)

rproxgrad

public abstract double[] rproxgrad(double[] u,
                                   double delta,
                                   java.util.Random rand)

\prox_{\alpha_k*r}(u): Proximal gradient of (step size) * (regularization function) evaluated at vector u

project

public abstract double[] project(double[] u,
                                 java.util.Random rand)

Project X,Y matrices into appropriate subspace so regularizer is finite. Used during initialization.