API Reference

Architecture Overview

kmeanssa-ng is organized around a three-layer abstraction pattern:

• kmeanssa_ng.core: Abstract base classes defining metric spaces, points, centers, and the simulated annealing algorithm
• kmeanssa_ng.quantum_graph: Concrete implementation for metric graphs (quantum graphs) built on NetworkX
• kmeanssa_ng.quantum_graph.generators: Utilities for creating test graphs (SBM, random graphs, etc.)
• kmeanssa_ng.riemannian_manifold: Clustering on Riemannian manifolds and approximating them by quantum graphs (epsilon-nets)

Quick Navigation

• Getting started? → QuantumGraph, QGSimulatedAnnealing
• Building custom spaces? → Space, Point, Center
• Understanding the algorithm? → SimulatedAnnealing
• Clustering on a sphere or manifold? → create_sphere, approximate_geodesic_space
• Generating test graphs? → Generators