ClusteringProfileExplorer
Structured summary of the last clustering run.
Shows cluster sizes, internal evaluation metrics (Silhouette, Davies-Bouldin, Calinski-Harabasz), and the distinctive feature profile of each cluster. All data comes from the converter report — no column selection required.
Methods
get_results(self, exploration_path: str, options: Dict[str, Any]) -> Dict[str, Any]
ClusteringProfileExplorerLoad the saved profile and return it to the frontend.
Parameters
- exploration_path : str
- Path to the JSON file saved by
save_notebook. - options : Dict[str, Any]
- Rendering options from the frontend (unused).
Returns
- Dict[str, Any]
- Dictionary with keys
"data"(the profile dict),"type"("clustering_profile"), and"config"(empty dict).
launch_exploration(self, _dataset: 'DashAIDataset', _explorer_info: DashAI.back.dependencies.database.models.Explorer) -> Dict[str, Any]
ClusteringProfileExplorerBuild a structured profile from the clustering converter report.
Parameters
- _dataset : DashAIDataset
- Ignored — all data comes from the converter report.
- _explorer_info : Explorer
- Ignored — no per-instance configuration is needed.
Returns
- Dict[str, Any]
- Dictionary with keys:
algorithm,cluster_column,n_clusters,metrics,algorithm_extras,noise_info,cluster_sizes,cluster_profiles.
prepare_dataset(self, loaded_dataset: 'DashAIDataset', _columns: List[Dict[str, Any]]) -> 'DashAIDataset'
ClusteringProfileExplorerReturn the dataset unchanged.
Parameters
- loaded_dataset : DashAIDataset
- The full dataset loaded from storage.
- _columns : List[Dict[str, Any]]
- Ignored — no columns are selected for this explorer.
Returns
- DashAIDataset
- The dataset as received, unmodified.
save_notebook(self, notebook_info: DashAI.back.dependencies.database.models.Notebook, explorer_info: DashAI.back.dependencies.database.models.Explorer, save_path: 'Path', result: Any) -> str
ClusteringProfileExplorerSave the profile result to a JSON file on disk.
Parameters
- notebook_info : Notebook
- The notebook database record (unused).
- explorer_info : Explorer
- The explorer record used for filename generation.
- save_path : Path
- Directory where the file will be saved.
- result : Any
- The dict returned by
launch_exploration.
Returns
- str
- The path of the saved JSON file as a POSIX string.
get_credential(self, name: str)
ConfigObjectResolve 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]
BaseExplorerGet metadata for the explorer, used by the DashAI frontend.
Returns
- Dict[str, Any]
- Dictionary containing display name, description, image preview path, category, icon, color, allowed semantic types, allowed dtypes, input cardinality constraints, and any optional capability flags declared by the explorer.
get_schema(cls) -> dict
ConfigObjectGenerates the component related Json Schema.
Returns
- dict
- Dictionary representing the Json Schema of the component.
set_context(self, context: Dict[str, Any]) -> None
BaseExplorerSet optional runtime context for explorers that need extra inputs.
validate_and_transform(self, raw_data: dict) -> dict
ConfigObjectIt 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.
validate_columns(cls, explorer_info: DashAI.back.dependencies.database.models.Explorer, column_spec: Dict[str, Dict[str, str]]) -> bool
BaseExplorerValidate that the selected columns satisfy the explorer's constraints.
Parameters
- explorer_info : Explorer
- The database record for the explorer instance, including the selected columns.
- column_spec : Dict[str, Dict[str, str]]
- A mapping from column name to a dict with at least
"type"(semantic type name) and"dtype"(dtype string).
Returns
- bool
- True if all column constraints are satisfied, False otherwise.
validate_parameters(cls, params: Dict[str, Any]) -> bool
BaseExplorerValidate explorer parameters against the explorer's schema.
Parameters
- params : Dict[str, Any]
- The configuration parameters to validate.
Returns
- BaseExplorerSchema
- The validated and parsed schema instance. Subclasses that override this method may return a bool to indicate pass/fail without returning the model instance.