sorbetto.flavor.entity_flavor module

class sorbetto.flavor.entity_flavor.EntityFlavor(rank: int, entity_list: list[Entity] | set[Entity], name: str = 'Unnamed Entity Flavor', colormap: Any = None)[source]

Bases: AbstractSymbolicFlavor[Entity]

For a given rank \(r\), the Entity Flavor is the mathematical function that gives, to any Importance \(I\) (that is, some application-specific preferences), the entity ranked \(r\)-th according to the ordering of performances induced by the Ranking Score \(R_I\) corresponding to the importance \(I\).

property entity_set: set[Entity]

getCodomain()[source]: Returns the co-domain of the flavor. In Entity flavor, the co-domain is the set of all possible ranks.

getDefaultColormap()[source]

property nb_entities: int

property performances: FiniteSetOfTwoClassClassificationPerformances

property rank: int