get_cluster_birth_cycle

environment_lib_class.get_cluster_birth_cycle(cluster_id, temporary=False, model_members_only=True)

Read the earliest known descriptor update cycle for a cluster.

Parameters:

• cluster_id (int) – Cluster identifier to select.

• temporary (bool, optional) – Use temporary cluster assignments instead of final cluster assignments. Default: False.

• model_members_only (bool, optional) – Restrict birth-cycle evidence to descriptor rows used by the clustering model. Default: True.

Returns:

int – First nonnegative cycle, or -1 when no cycle evidence is available.

Notes

By default only rows listed in descriptor_clustering_members are used, matching the rows that actually participate in the runtime clustering model.