Package org.tribuo.math.kernel

Class Sigmoid

java.lang.Object

org.tribuo.math.kernel.Sigmoid

All Implemented Interfaces:

com.oracle.labs.mlrg.olcut.config.Configurable, com.oracle.labs.mlrg.olcut.provenance.Provenancable<com.oracle.labs.mlrg.olcut.provenance.ConfiguredObjectProvenance>, Serializable, Kernel, ProtoSerializable<org.tribuo.math.protos.KernelProto>

public class Sigmoid
extends Object
implements Kernel

A sigmoid kernel, tanh(gamma*u.dot(v) + intercept).

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CURRENT_VERSION	Protobuf serialization version.

Fields inherited from interface org.tribuo.protos.ProtoSerializable

DESERIALIZATION_METHOD_NAME, PROVENANCE_SERIALIZER

Constructor Summary

Constructors

Constructor	Description
Sigmoid(double gamma, double intercept)	A sigmoid kernel, tanh(gamma*u.dot(v) + intercept).

Method Summary

Modifier and Type	Method	Description
static Sigmoid	deserializeFromProto(int version, String className, com.google.protobuf.Any message)	Deserialization factory.
boolean	equals(Object o)
com.oracle.labs.mlrg.olcut.provenance.ConfiguredObjectProvenance	getProvenance()
int	hashCode()
org.tribuo.math.protos.KernelProto	serialize()	Serializes this object to a protobuf.
double	similarity(SparseVector a, SparseVector b)	Calculates the similarity between two SparseVectors.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.oracle.labs.mlrg.olcut.config.Configurable

postConfig

Field Details

CURRENT_VERSION

public static final int CURRENT_VERSION

Protobuf serialization version.

See Also:

• Constant Field Values

Constructor Details

Sigmoid

public Sigmoid(double gamma,
 double intercept)

A sigmoid kernel, tanh(gamma*u.dot(v) + intercept).

Parameters:

gamma - A scalar coefficient.

intercept - An additive coefficient.

Method Details

deserializeFromProto

public static Sigmoid deserializeFromProto(int version,
 String className,
 com.google.protobuf.Any message)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Deserialization factory.

Parameters:

version - The serialized object version.

className - The class name.

message - The serialized data.

Returns:

The deserialized object.

Throws:

com.google.protobuf.InvalidProtocolBufferException - If the protobuf could not be parsed from the message.

serialize

public org.tribuo.math.protos.KernelProto serialize()

Description copied from interface: ProtoSerializable

Serializes this object to a protobuf.

Specified by:

serialize in interface ProtoSerializable<org.tribuo.math.protos.KernelProto>

Returns:

The protobuf.

similarity

public double similarity(SparseVector a,
 SparseVector b)

Description copied from interface: Kernel

Calculates the similarity between two SparseVectors.

Specified by:

similarity in interface Kernel

Parameters:

a - The first SparseVector.

b - The second SparseVector.

Returns:

A value between 0 and 1, where 1 is most similar and 0 is least similar.

toString

public String toString()

Overrides:

toString in class Object

getProvenance

public com.oracle.labs.mlrg.olcut.provenance.ConfiguredObjectProvenance getProvenance()

Specified by:

getProvenance in interface com.oracle.labs.mlrg.olcut.provenance.Provenancable<com.oracle.labs.mlrg.olcut.provenance.ConfiguredObjectProvenance>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object