hex

Class LinkFunction

java.lang.Object

water.Iced<LinkFunction>

hex.LinkFunction

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, Freezable<LinkFunction>

public abstract class LinkFunction
extends Iced<LinkFunction>

Link function class to calculate link, link inverse and string link inverse functions.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
hex.genmodel.utils.LinkFunctionType	linkFunctionType

Constructor Summary

Constructors

Constructor and Description
LinkFunction()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	expString(java.lang.String x) Return x as e^x string - helper function
abstract double	link(double f) Canonical link
abstract double	linkInv(double f) Canonical link inverse Be careful if you are changing code here - you have to change it in DeeplearningMojoModel and GbmMojoModel too
abstract java.lang.String	linkInvString(java.lang.String f) String version of link inverse (for POJO scoring code generation)
java.lang.String	linkInvStringFloat(java.lang.String f)

Methods inherited from class water.Iced

asBytes, clone, copyOver, frozenType, read, readExternal, readJSON, reloadFromBytes, toJsonBytes, toJsonString, write, writeExternal, writeJSON

Methods inherited from class java.lang.Object

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

Field Detail

linkFunctionType

public hex.genmodel.utils.LinkFunctionType linkFunctionType

Constructor Detail

LinkFunction

public LinkFunction()

Method Detail

expString

public static java.lang.String expString(java.lang.String x)

Return x as e^x string - helper function

Parameters:

x -

Returns:

converted x to e^x string

link

public abstract double link(double f)

Canonical link

Parameters:

f - value in original space, to be transformed to link space

Returns:

link(f)

linkInv

public abstract double linkInv(double f)

Canonical link inverse Be careful if you are changing code here - you have to change it in DeeplearningMojoModel and GbmMojoModel too

Parameters:

f - value in link space, to be transformed back to original space

Returns:

linkInv(f)

linkInvString

public abstract java.lang.String linkInvString(java.lang.String f)

String version of link inverse (for POJO scoring code generation)

Parameters:

f - value to be transformed by link inverse

Returns:

String that turns into compilable expression of linkInv(f)

linkInvStringFloat

public java.lang.String linkInvStringFloat(java.lang.String f)