pyagc.clusters.KMeansClusterHead

class KMeansClusterHead(n_clusters: int, backend: str = 'torch', n_init: int = 10, max_iter: int = 300, random_state: Optional[int] = None)

Bases: BaseClusterHead

The K-Means clustering head with fixed cluster centers.

This module performs clustering using the TorchKMeans or sklearn.cluster.KMeans algorithm, and stores the resulting cluster centers for inference. Once fitted, the cluster() method can be used to assign new points based on the stored centers.

Note

This class does not learn trainable parameters and does not define a clustering loss. It is typically used for post-hoc or plug-in clustering.

Parameters:

• n_clusters (int) – Number of clusters.

• backend (str, optional) – The backend to use for K-Means, either "torch" or "triton" or "sklearn". (default: "torch")

• n_init (int, optional) – Number of K-Means initializations to run. (default: 10)

• max_iter (int, optional) – Maximum number of iterations per K-Means run. (default: 300)

• random_state (int, optional) – Random seed. (default: None)

__init__(n_clusters: int, backend: str = 'torch', n_init: int = 10, max_iter: int = 300, random_state: Optional[int] = None)

Initialize internal Module state, shared by both nn.Module and ScriptModule.

Methods

__init__(n_clusters[, backend, n_init, ...])	Initialize internal Module state, shared by both nn.Module and ScriptModule.
add_module(name, module)	Add a child module to the current module.
apply(fn)	Apply fn recursively to every submodule (as returned by .children()) as well as self.
bfloat16()	Casts all floating point parameters and buffers to bfloat16 datatype.
buffers([recurse])	Return an iterator over module buffers.
children()	Return an iterator over immediate children modules.
cluster(z[, soft])	Assigns samples to clusters based on fixed cluster centers.
compile(*args, **kwargs)	Compile this Module's forward using torch.compile().
cpu()	Move all model parameters and buffers to the CPU.
cuda([device])	Move all model parameters and buffers to the GPU.
double()	Casts all floating point parameters and buffers to double datatype.
eval()	Set the module in evaluation mode.
extra_repr()	Return the extra representation of the module.
fit_predict(z)	Performs k-means clustering on the input data and returns cluster labels.
float()	Casts all floating point parameters and buffers to float datatype.
forward(*args, **kwargs)	Runs the forward pass of the module.
get_buffer(target)	Return the buffer given by target if it exists, otherwise throw an error.
get_extra_state()	Return any extra state to include in the module's state_dict.
get_parameter(target)	Return the parameter given by target if it exists, otherwise throw an error.
get_submodule(target)	Return the submodule given by target if it exists, otherwise throw an error.
half()	Casts all floating point parameters and buffers to half datatype.
ipu([device])	Move all model parameters and buffers to the IPU.
load_state_dict(state_dict[, strict, assign])	Copy parameters and buffers from state_dict into this module and its descendants.
modules()	Return an iterator over all modules in the network.
mtia([device])	Move all model parameters and buffers to the MTIA.
named_buffers([prefix, recurse, ...])	Return an iterator over module buffers, yielding both the name of the buffer as well as the buffer itself.
named_children()	Return an iterator over immediate children modules, yielding both the name of the module as well as the module itself.
named_modules([memo, prefix, remove_duplicate])	Return an iterator over all modules in the network, yielding both the name of the module as well as the module itself.
named_parameters([prefix, recurse, ...])	Return an iterator over module parameters, yielding both the name of the parameter as well as the parameter itself.
parameters([recurse])	Return an iterator over module parameters.
register_backward_hook(hook)	Register a backward hook on the module.
register_buffer(name, tensor[, persistent])	Add a buffer to the module.
register_forward_hook(hook, *[, prepend, ...])	Register a forward hook on the module.
register_forward_pre_hook(hook, *[, ...])	Register a forward pre-hook on the module.
register_full_backward_hook(hook[, prepend])	Register a backward hook on the module.
register_full_backward_pre_hook(hook[, prepend])	Register a backward pre-hook on the module.
register_load_state_dict_post_hook(hook)	Register a post-hook to be run after module's load_state_dict() is called.
register_load_state_dict_pre_hook(hook)	Register a pre-hook to be run before module's load_state_dict() is called.
register_module(name, module)	Alias for add_module().
register_parameter(name, param)	Add a parameter to the module.
register_state_dict_post_hook(hook)	Register a post-hook for the state_dict() method.
register_state_dict_pre_hook(hook)	Register a pre-hook for the state_dict() method.
requires_grad_([requires_grad])	Change if autograd should record operations on parameters in this module.
set_extra_state(state)	Set extra state contained in the loaded state_dict.
set_submodule(target, module[, strict])	Set the submodule given by target if it exists, otherwise throw an error.
share_memory()	See torch.Tensor.share_memory_().
state_dict(*args[, destination, prefix, ...])	Return a dictionary containing references to the whole state of the module.
to(*args, **kwargs)	Move and/or cast the parameters and buffers.
to_empty(*, device[, recurse])	Move the parameters and buffers to the specified device without copying storage.
train([mode])	Set the module in training mode.
type(dst_type)	Casts all parameters and buffers to dst_type.
xpu([device])	Move all model parameters and buffers to the XPU.
zero_grad([set_to_none])	Reset gradients of all model parameters.

Attributes

T_destination	alias of TypeVar('T_destination', bound=dict[str, Any])
call_super_init
dump_patches
predict	Alias for cluster().

forward(*args, **kwargs) → Tensor

Runs the forward pass of the module.

Return type:

Tensor

fit_predict(z: Tensor) → Tensor

Performs k-means clustering on the input data and returns cluster labels.

Parameters:

z (torch.Tensor) – The input data of shape (n_samples, n_features).

Returns:

Tensor – Cluster assignments of shape (n_samples,).

cluster(z: Tensor, soft: bool = False) → Tensor

Assigns samples to clusters based on fixed cluster centers.

This function computes the squared Euclidean distance to each center and returns either hard assignments or soft probabilities.

Parameters:

• z (torch.Tensor) – Input tensor of shape (n_samples, n_features).

• soft (bool, optional) – If True, returns the soft assignment matrix; if False, returns hard cluster assignments. (default: False)

Returns:

Tensor –:

• If soft is False, (n_samples,) tensor of cluster indices.

• If soft is True, (n_samples, n_clusters) tensor of probabilities.