cratepy.clustering.adaptivity.adaptivity_criterion.AdaptivityCriterion

class AdaptivityCriterion[source]

Bases: ABC

Clustering adaptivity criterion interface.

get_parameters()[source]

abstract: Get clustering adaptivity criterion parameters.

get_target_clusters(self)[source]

abstract: Get clustering adaptivity target clusters ans associated data.

Constructor.

List of Public Methods

get_parameters

Get clustering adaptivity criterion parameters.

get_target_clusters

Get clustering adaptivity target clusters ans associated data.

Methods

abstract __init__()[source]

Constructor.

abstract static get_parameters()[source]

Get clustering adaptivity criterion parameters.

Besides returning the mandatory and optional adaptivity criterion parameters, this method establishes the default values for the optional parameters.

Returns:

  • mandatory_parameters (dict) – Mandatory adaptivity type parameters (str) and associated type (item, type).

  • optional_parameters (dict) – Optional adaptivity type parameters (key, str) and associated default value (item).

abstract get_target_clusters()[source]

Get clustering adaptivity target clusters ans associated data.

Returns:

  • target_clusters (list[int]) – List containing the labels (int) of clusters to be adapted.

  • target_clusters_data (dict) – For each target cluster (key, str), store dictionary (item, dict) containing cluster associated parameters required for the adaptive procedures.