qoolqit.embedding.algorithms.spring_layout_embedding

module

qoolqit.embedding.algorithms.spring_layout_embedding

Classes

• SpringLayoutConfig — Configuration parameters for the spring-layout embedding.

Functions

• spring_layout_embedding — Force-directed embedding, wrapping nx.spring_layout.

dataclass

SpringLayoutConfig (k: float | None = None, iterations: int = 50, threshold: float = 0.0001, seed: int | None = None)

Bases : EmbeddingConfig

Configuration parameters for the spring-layout embedding.

spring_layout_embedding (graph: DataGraph, k: float | None, iterations: int, threshold: float, seed: int | None) → DataGraph

Force-directed embedding, wrapping nx.spring_layout.

Generates a graph with the same nodes and edges as the original graph, but with node coordinates set to be the positions given by nx.spring_layout.

Check the documentation for nx.spring_layout for more information on each parameter.

Parameters

• graph : DataGraph — the graph to embed.

• k : float | None — optimal distance between nodes.

• iterations : int — maximum number of iterations to take.

• threshold : float — threshold value for relative error in node position changes.

• sed — random seed.