Package org.tribuo.classification

Class MutableLabelInfo

java.lang.Object

org.tribuo.classification.LabelInfo

org.tribuo.classification.MutableLabelInfo

All Implemented Interfaces:

Serializable, MutableOutputInfo<Label>, OutputInfo<Label>, ProtoSerializable<org.tribuo.protos.core.OutputDomainProto>

public class MutableLabelInfo
extends LabelInfo
implements MutableOutputInfo<Label>

A mutable LabelInfo. Can record new observations of Labels, incrementing the appropriate counts.

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.tribuo.classification.LabelInfo

labelCounts, labels, unknownCount

Fields inherited from interface org.tribuo.protos.ProtoSerializable

DESERIALIZATION_METHOD_NAME, PROVENANCE_SERIALIZER

Constructor Summary

Constructors

Constructor	Description
MutableLabelInfo(LabelInfo info)	Constructs a mutable deep copy of the supplied label info.

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears the OutputInfo, removing all things it's observed.
MutableLabelInfo	copy()	Generates a copy of this OutputInfo, including it's mutability.
static MutableLabelInfo	deserializeFromProto(int version, String className, com.google.protobuf.Any message)	Deserialization factory.
boolean	equals(Object o)
int	hashCode()
void	observe(Label output)	Records an output value or statistics thereof.
org.tribuo.protos.core.OutputDomainProto	serialize()	Serializes this object to a protobuf.
String	toReadableString()	Generates a String form of this OutputInfo.
String	toString()

Methods inherited from class org.tribuo.classification.LabelInfo

generateImmutableOutputInfo, generateMutableOutputInfo, getDomain, getLabelCount, getLabelCount, getUnknownCount, outputCountsIterable, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.tribuo.OutputInfo

generateImmutableOutputInfo, generateMutableOutputInfo, getDomain, getUnknownCount, outputCountsIterable, size

Constructor Details

MutableLabelInfo

public MutableLabelInfo(LabelInfo info)

Constructs a mutable deep copy of the supplied label info.

Parameters:

info - The info to copy.

Method Details

deserializeFromProto

public static MutableLabelInfo 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.protos.core.OutputDomainProto serialize()

Description copied from interface: ProtoSerializable

Serializes this object to a protobuf.

Specified by:

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

Returns:

The protobuf.

observe

public void observe(Label output)

Description copied from interface: MutableOutputInfo

Records an output value or statistics thereof.

Specified by:

observe in interface MutableOutputInfo<Label>

Parameters:

output - The observed output.

clear

public void clear()

Description copied from interface: MutableOutputInfo

Clears the OutputInfo, removing all things it's observed.

Specified by:

clear in interface MutableOutputInfo<Label>

copy

public MutableLabelInfo copy()

Description copied from interface: OutputInfo

Generates a copy of this OutputInfo, including it's mutability.

Specified by:

copy in interface OutputInfo<Label>

Specified by:

copy in class LabelInfo

Returns:

A copy of the OutputInfo.

toReadableString

public String toReadableString()

Description copied from interface: OutputInfo

Generates a String form of this OutputInfo.

This String can contain newlines, tabs and other formatting.

Specified by:

toReadableString in interface OutputInfo<Label>

Returns:

A formatted String representing this OutputInfo.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object