localvectordb.visualization.types module

These types are re-exported by the package (from localvectordb.visualization import ClusterResult), so that path owns the cross-reference targets and this page carries :no-index: to avoid duplicating them. See localvectordb.visualization package.

Dataclasses for the visualization module.

class localvectordb.visualization.types.EmbeddingProjection(coordinates: ndarray, method: str, doc_ids: List[str], transformer: Any = None, n_components: int = 2, explained_variance: ndarray | None = None)

Bases: object

Result of dimensionality reduction.

Variables:

  • coordinates (np.ndarray) – (N, n_components) projected coordinates.

  • method (str) – Reduction method used ("pca" or "tsne").

  • doc_ids (list of str) – Document IDs corresponding to each row.

  • transformer (Any) – Fitted transformer object (PCA instance or dict with params). Used to project new points into the same space.

  • n_components (int) – Number of output dimensions.

  • explained_variance (Optional[np.ndarray]) – Explained variance ratio (PCA only).

coordinates: ndarray
method: str
doc_ids: List[str]
transformer: Any = None
n_components: int = 2
explained_variance: ndarray | None = None
__init__(coordinates: ndarray, method: str, doc_ids: List[str], transformer: Any = None, n_components: int = 2, explained_variance: ndarray | None = None) → None
class localvectordb.visualization.types.ClusterResult(labels: ndarray, n_clusters: int, centroids: ndarray | None = None, inertia: float | None = None)

Bases: object

Result of clustering.

Variables:

  • labels (np.ndarray) – (N,) cluster label for each point.

  • n_clusters (int) – Number of clusters.

  • centroids (Optional[np.ndarray]) – (K, D) cluster centroids, if available.

  • inertia (Optional[float]) – Sum of squared distances to nearest centroid.

labels: ndarray
n_clusters: int
centroids: ndarray | None = None
inertia: float | None = None
__init__(labels: ndarray, n_clusters: int, centroids: ndarray | None = None, inertia: float | None = None) → None
class localvectordb.visualization.types.QueryOverlay(query_text: str, query_embedding: ndarray, scores: ndarray)

Bases: object

Overlay for rendering query points on an embedding map.

Variables:

  • query_text (str) – The query string (used for legend/labels).

  • query_embedding (np.ndarray) – (D,) embedding vector of the query.

  • scores (np.ndarray) – (N,) similarity score per document; used for dot sizing.

query_text: str
query_embedding: ndarray
scores: ndarray
__init__(query_text: str, query_embedding: ndarray, scores: ndarray) → None