Package org.tribuo.classification
Class Label
java.lang.Object
org.tribuo.classification.Label
- All Implemented Interfaces:
Serializable
,Classifiable<Label>
,Output<Label>
An immutable multi-class classification label.
The labels themselves are Strings. A Label also contains an optional score which measures the confidence in that label, though it is not required to be a probability.
Label equality and hashCode is defined solely on the String label, it does not take into account the score.
- See Also:
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptioncopy()
Deep copy of the output up to it's immutable state.boolean
boolean
fullEquals
(Label o) Compares other to this output.getLabel()
Gets the name of this label.double
getScore()
Get a real valued score for this label.getSerializableForm
(boolean includeConfidence) Returns "labelName" or "labelName,score=labelScore".int
hashCode()
toString()
-
Field Details
-
UNKNOWN
The name of the unknown label (i.e., an unlabelled output).- See Also:
-
label
The name of the label. -
score
protected final double scoreThe score of the label.
-
-
Constructor Details
-
Label
Builds a label with the supplied string and score.- Parameters:
label
- The label name.score
- The label instance score.
-
Label
Builds a label with the sentinel score of Double.NaN.- Parameters:
label
- The name of this label.
-
-
Method Details
-
getScore
public double getScore()Get a real valued score for this label.If the score is not set then it returns Double.NaN.
- Returns:
- The predicted score for this label.
-
getLabel
Gets the name of this label.- Returns:
- A String.
-
equals
-
fullEquals
Description copied from interface:Output
Compares other to this output. Uses all score values and the strings.- Specified by:
fullEquals
in interfaceOutput<Label>
- Parameters:
o
- Another output instance.- Returns:
- True if the other instance has value equality to this instance. False otherwise.
-
hashCode
public int hashCode() -
toString
-
copy
Description copied from interface:Output
Deep copy of the output up to it's immutable state. -
getSerializableForm
Returns "labelName" or "labelName,score=labelScore".- Specified by:
getSerializableForm
in interfaceOutput<Label>
- Parameters:
includeConfidence
- Include whatever confidence score the label contains, if known.- Returns:
- A String form suitable for serialization.
-