pycognaize.common.confidence.Confidence

class Confidence(confidences=None)

Bases: object

This class is used by tag object to store confidence values of possible classes.

Methods

add_class	Add new class for confidence scores :type class_name: str :param class_name: name of the class :type confidence: Union[float, int] :param confidence: confidence score for the class
class_names	Returns class names
finalize	Finalize confidence scores by checking if all scores sum to 1 :type tolerance: :param tolerance: tolerance for comparing sum of confidences (float) with 1
get_confidence	Returns confidence scores if finalized
number_of_classes	Returns number of classes

Attributes

is_finalized

add_class(class_name, confidence)

Add new class for confidence scores :type class_name: str :param class_name: name of the class :type confidence: Union[float, int] :param confidence: confidence score for the class

Return type:

None

Parameters:

• class_name (str)

• confidence (float | int)

class_names()

Returns class names

Return type:

list

finalize(tolerance=0.0001)

Finalize confidence scores by checking if all scores sum to 1 :type tolerance: :param tolerance: tolerance for comparing sum of confidences (float) with 1

Return type:

None

get_confidence()

Returns confidence scores if finalized

Return type:

dict

number_of_classes()

Returns number of classes

Return type:

int