Saltar al contenido principal

FaissKMeansClustering

Model
DashAI.back.models.faiss.FaissKMeansClustering

FAISS K-Means clustering model for the Models module.

FAISS K-Means applies Lloyd's algorithm in C++ with BLAS vectorisation and optional GPU acceleration. It converges substantially faster than sklearn's K-Means on large datasets (tens of thousands of samples or more) while producing equivalent cluster quality.

Key hyperparameters: n_clusters (groups), max_iter (convergence budget), random_state (seed). Requires faiss-cpu or faiss-gpu.

References​

Parameters​

n_clusters : integer, default=8
Number of clusters to form.
max_iter : integer, default=300
Maximum number of Lloyd's algorithm iterations.
random_state : integer, default=0
Random seed for centroid initialisation.

Methods​

get_cluster_labels(self, x: 'DashAIDataset | None' = None) -> numpy.ndarray

Defined on FaissKMeansClustering

Return fitted labels or assign new samples to nearest centroid.

Parameters

x : DashAIDataset, optional
New samples to assign. If omitted, returns labels from training.

Returns

numpy.ndarray
Cluster label per sample.

get_fit_attributes(self) -> dict

Defined on FaissKMeansClustering

Return FAISS K-Means post-fit attributes for the converter report.

train(self, x_train: 'DashAIDataset') -> 'FaissKMeansClustering'

Defined on FaissKMeansClustering

Fit FAISS K-Means and store cluster assignments.

Parameters

x_train : DashAIDataset
Input feature matrix.

Returns

FaissKMeansClustering
The fitted model instance.

calculate_metrics(self, split: DashAI.back.core.enums.metrics.SplitEnum = <SplitEnum.VALIDATION: 'validation'>, level: DashAI.back.core.enums.metrics.LevelEnum = <LevelEnum.LAST: 'last'>, log_index: int = None, x_data: 'DashAIDataset' = None, y_data: 'DashAIDataset' = None, fold_index: int = None, inner_fold_index: int = None)

Defined on BaseModel

Calculate metrics for a data split and save them to the database.

Parameters

split : SplitEnum
The data split to evaluate (TRAIN, VALIDATION, or TEST). Defaults to SplitEnum.VALIDATION.
level : LevelEnum
The metric granularity level (LAST, TRIAL, STEP, or BATCH). Defaults to LevelEnum.LAST.
log_index : int, optional
Explicit step index for the metric entry. If None, the next step index is computed automatically. Defaults to None.
x_data : DashAIDataset, optional
Input features. If None, the dataset stored in the model for the given split is used. Defaults to None.
y_data : DashAIDataset, optional
Target labels. If None, the labels stored in the model for the given split are used. Defaults to None.

Returns

Dict[str, float] or None
What was written, so a caller that also wants the numbers does not have to score the same split twice. None when nothing was written: no run to write against, or nothing to score.

compute_metrics(self, split: DashAI.back.core.enums.metrics.SplitEnum = <SplitEnum.VALIDATION: 'validation'>, x_data: 'DashAIDataset' = None, y_data: 'DashAIDataset' = None) -> Optional[Dict[str, float]]

Defined on BaseModel

Score a data split with this model's metrics, without persisting.

Parameters

split : SplitEnum
The data split to evaluate. Defaults to SplitEnum.VALIDATION.
x_data : DashAIDataset, optional
Input features. Defaults to the split stored on the model.
y_data : DashAIDataset, optional
Target labels. Defaults to the split stored on the model.

Returns

Dict[str, float] or None
Metric name to score. A metric that scored a non-finite value is absent from the mapping rather than present with a NaN, so the mapping is empty when every metric returned one. None when there is nothing to score at all: no metrics configured, or no data for this split. Callers that need a particular metric must therefore check that it is there.

get_credential(self, name: str)

Defined on ConfigObject

Resolve a registered credential component by name.

Parameters

name : str
Credential component class name (e.g. "HuggingFaceCredential").

Returns

BaseCredential
An instance of the requested credential component.

get_metadata(cls) -> Dict[str, Any]

Defined on BaseModel

Get metadata values for the current model.

Returns

Dict[str, Any]
Dictionary containing UI metadata such as the model icon used in the DashAI frontend.

get_registry(cls) -> Dict[str, Type[ForwardRef('ClusteringModel')]]

Defined on ClusteringModel

Return concrete clustering algorithm classes keyed by class name.

get_schema(cls) -> dict

Defined on ConfigObject

Generates the component related Json Schema.

Returns

dict
Dictionary representing the Json Schema of the component.

load(filename: str) -> Any

Defined on FaissBaseModel

Restore a fitted model from disk.

Parameters

filename : str
Path to a previously saved model file.

Returns

Any
The deserialised model instance.

predict_prepared(self, features: Any) -> Any

Defined on BaseModel

Predict from data that is already in this model's feature space.

Parameters

features : pandas.DataFrame or numpy.ndarray
Feature matrix as returned by prepare_dataset(..., is_fit=False). No further preparation is applied to it.

Returns

Any
The same kind of output as predict: predicted values for regressors, class probabilities for DashAI classifiers.

predict_proba_prepared(self, features: Any) -> Any

Defined on BaseModel

Return class probabilities for data already in the feature space.

Parameters

features : pandas.DataFrame or numpy.ndarray
Feature matrix as returned by prepare_dataset(..., is_fit=False).

Returns

numpy.ndarray
Array of shape (n_samples, n_classes) with class probabilities.

prepare_dataset(self, dataset: 'DashAIDataset', is_fit: bool = False) -> 'DashAIDataset'

Defined on BaseModel

Hook for model specific preprocessing of input features.

Parameters

dataset : DashAIDataset
The input dataset to preprocess.
is_fit : bool
Whether the call is part of a fitting phase. Defaults to False.

Returns

DashAIDataset
The preprocessed dataset ready to be fed into the model.

prepare_output(self, dataset: 'DashAIDataset', is_fit: bool = False) -> 'DashAIDataset'

Defined on BaseModel

Hook for model-specific preprocessing of output targets.

Parameters

dataset : DashAIDataset
The output dataset (target labels) to preprocess.
is_fit : bool
Whether the call is part of a fitting phase. Defaults to False.

Returns

DashAIDataset
The preprocessed output dataset.

save(self, filename: str) -> None

Defined on FaissBaseModel

Save the fitted model to disk using joblib.

Parameters

filename : str
Destination path for the serialised model.

validate_and_transform(self, raw_data: dict) -> dict

Defined on ConfigObject

It takes the data given by the user to initialize the model and returns it with all the objects that the model needs to work.

Parameters

raw_data : dict
A dictionary with the data provided by the user to initialize the model.

Returns

dict
A validated dictionary with the necessary objects.

Compatible with​