Package org.tribuo.classification

Class ImmutableLabelInfo

java.lang.Object
org.tribuo.classification.LabelInfo
org.tribuo.classification.ImmutableLabelInfo
All Implemented Interfaces:
Serializable, Iterable<com.oracle.labs.mlrg.olcut.util.Pair<Integer,Label>>, ImmutableOutputInfo<Label>, OutputInfo<Label>, ProtoSerializable<org.tribuo.protos.core.OutputDomainProto>
public class ImmutableLabelInfo extends LabelInfo implements ImmutableOutputInfo<Label>
An ImmutableOutputInfo object for Labels.

Gives each unique label an id number. Also counts each label occurrence like MutableLabelInfo does, though the counts are frozen in this object.

See Also:

  • Method Details

    • deserializeFromProto

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

    • getDomain

      public Set<Label> getDomain()
      Returns the set of possible Labels that this LabelInfo has seen. Each label has the default score of Double.NaN.
      Specified by:
      getDomain in interface OutputInfo<Label>
      Overrides:
      getDomain in class LabelInfo
      Returns:
      The set of possible labels.

    • getID

      public int getID(Label output)
      Description copied from interface: ImmutableOutputInfo
      Return the id number associated with this output, or -1 if the output is unknown.
      Specified by:
      getID in interface ImmutableOutputInfo<Label>
      Parameters:
      output - An output
      Returns:
      A non-negative integer if the output is known, or -1 if the output is unknown.

    • getOutput

      public Label getOutput(int id)
      Description copied from interface: ImmutableOutputInfo
      Returns the output associated with this id, or null if the id is unknown.
      Specified by:
      getOutput in interface ImmutableOutputInfo<Label>
      Parameters:
      id - A non-negative integer.
      Returns:
      An output object or null if it's unknown.

    • getTotalObservations

      public long getTotalObservations()
      Description copied from interface: ImmutableOutputInfo
      Returns the total number of observed outputs seen by this ImmutableOutputInfo.
      Specified by:
      getTotalObservations in interface ImmutableOutputInfo<Label>
      Returns:
      The number of observed outputs.

    • getLabelCount

      public long getLabelCount(int id)
      Returns the number of times the supplied id was observed before this LabelInfo was frozen.
      Parameters:
      id - The id number.
      Returns:
      The count.

    • copy

      public ImmutableLabelInfo 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

    • iterator

      public Iterator<com.oracle.labs.mlrg.olcut.util.Pair<Integer,Label>> iterator()
      Specified by:
      iterator in interface Iterable<com.oracle.labs.mlrg.olcut.util.Pair<Integer,Label>>

    • domainAndIDEquals

      public boolean domainAndIDEquals(ImmutableOutputInfo<Label> other)
      Description copied from interface: ImmutableOutputInfo
      Checks if the domain is the same as the other output info's domain, and that each element is mapped to the same id number.

      Note the default behaviour will be removed in a future major release, and should be overridden for performance reasons in all implementing classes.

      Specified by:
      domainAndIDEquals in interface ImmutableOutputInfo<Label>
      Parameters:
      other - The output info to compare.
      Returns:
      True if the domains and ids are the same.