Package org.tribuo.classification.libsvm

Class LibSVMClassificationModel

java.lang.Object

org.tribuo.Model<T>

org.tribuo.common.libsvm.LibSVMModel<Label>

org.tribuo.classification.libsvm.LibSVMClassificationModel

All Implemented Interfaces:

com.oracle.labs.mlrg.olcut.provenance.Provenancable<ModelProvenance>, Serializable, ONNXExportable, ProtoSerializable<org.tribuo.protos.core.ModelProto>

public class LibSVMClassificationModel
extends LibSVMModel<Label>
implements ONNXExportable

A classification model that uses an underlying LibSVM model to make the predictions.

See:

 Chang CC, Lin CJ.
 "LIBSVM: a library for Support Vector Machines"
 ACM transactions on intelligent systems and technology (TIST), 2011.
 

for the nu-svc algorithm:

 Schölkopf B, Smola A, Williamson R, Bartlett P L.
 "New support vector algorithms"
 Neural Computation, 2000, 1207-1245.
 

and for the original algorithm:

 Cortes C, Vapnik V.
 "Support-Vector Networks"
 Machine Learning, 1995.
 

See Also:

• Serialized Form

Field Summary

Fields

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

Fields inherited from class org.tribuo.common.libsvm.LibSVMModel

models

Fields inherited from class org.tribuo.Model

ALL_OUTPUTS, BIAS_FEATURE, featureIDMap, generatesProbabilities, name, outputIDInfo, provenance, provenanceOutput

Fields inherited from interface org.tribuo.ONNXExportable

PROVENANCE_METADATA_FIELD, SERIALIZER

Fields inherited from interface org.tribuo.protos.ProtoSerializable

DESERIALIZATION_METHOD_NAME, PROVENANCE_SERIALIZER

Method Summary

Modifier and Type	Method	Description
protected LibSVMClassificationModel	copy(String newName, ModelProvenance newProvenance)	Copies a model, replacing its provenance and name with the supplied values.
static LibSVMClassificationModel	deserializeFromProto(int version, String className, com.google.protobuf.Any message)	Deserialization factory.
ai.onnx.proto.OnnxMl.ModelProto	exportONNXModel(String domain, long modelVersion)	Exports this Model as an ONNX protobuf.
int	getNumberOfSupportVectors()	Returns the number of support vectors.
Prediction<Label>	predict(Example<Label> example)	Uses the model to predict the output for a single example.
org.tribuo.protos.core.ModelProto	serialize()	Serializes this object to a protobuf.
ONNXNode	writeONNXGraph(ONNXRef<?> input)	Writes this Model into OnnxMl.GraphProto.Builder inside the input's ONNXContext.

Methods inherited from class org.tribuo.common.libsvm.LibSVMModel

copyModel, deserializeModel, deserializeParameters, getExcuse, getInnerModels, getModel, getTopFeatures, modelEquals, serializeModel, serializeParameters

Methods inherited from class org.tribuo.Model

castModel, copy, createDataCarrier, deserialize, deserializeFromFile, deserializeFromStream, generatesProbabilities, getExcuses, getFeatureIDMap, getName, getOutputIDInfo, getProvenance, innerPredict, predict, predict, serializeToFile, serializeToStream, setName, toString, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.tribuo.ONNXExportable

saveONNXModel, serializeProvenance

Field Details

CURRENT_VERSION

public static final int CURRENT_VERSION

Protobuf serialization version.

See Also:

• Constant Field Values

Method Details

deserializeFromProto

public static LibSVMClassificationModel 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.

getNumberOfSupportVectors

public int getNumberOfSupportVectors()

Returns the number of support vectors.

Returns:

The number of support vectors.

predict

public Prediction<Label> predict(Example<Label> example)

Description copied from class: Model

Uses the model to predict the output for a single example.

predict does not mutate the example.

Throws IllegalArgumentException if the example has no features or no feature overlap with the model.

Specified by:

predict in class Model<Label>

Parameters:

example - the example to predict.

Returns:

the result of the prediction.

copy

protected LibSVMClassificationModel copy(String newName,
 ModelProvenance newProvenance)

Description copied from class: Model

Copies a model, replacing its provenance and name with the supplied values.

Used to provide the provenance removal functionality.

Specified by:

copy in class Model<Label>

Parameters:

newName - The new name.

newProvenance - The new provenance.

Returns:

A copy of the model.

exportONNXModel

public ai.onnx.proto.OnnxMl.ModelProto exportONNXModel(String domain,
 long modelVersion)

Description copied from interface: ONNXExportable

Exports this Model as an ONNX protobuf.

Specified by:

exportONNXModel in interface ONNXExportable

Parameters:

domain - A reverse-DNS name to namespace the model (e.g., org.tribuo.classification.sgd.linear).

modelVersion - A version number for this model.

Returns:

The ONNX ModelProto representing this Tribuo Model.

writeONNXGraph

public ONNXNode writeONNXGraph(ONNXRef<?> input)

Description copied from interface: ONNXExportable

Writes this Model into OnnxMl.GraphProto.Builder inside the input's ONNXContext.

Specified by:

writeONNXGraph in interface ONNXExportable

Parameters:

input - The input to the model graph.

Returns:

the output node of the model graph.

serialize

public org.tribuo.protos.core.ModelProto serialize()

Description copied from interface: ProtoSerializable

Serializes this object to a protobuf.

Specified by:

serialize in interface ProtoSerializable<org.tribuo.protos.core.ModelProto>

Overrides:

serialize in class Model<Label>

Returns:

The protobuf.