Skip to content

Results are limited to Qoolqit v1.0.0

Product news
You are reading Qoolqit v1.0.0, an older version of this documentation. Go to the latest version (v1.6.0)

Embedding

In this section, you will learn how to:

  • understand how problem graphs are mapped onto the analog Rydberg device through embedding,
  • use QoolQit embedders to transform graphs into physically realizable configurations,
  • test whether an embedding satisfies hardware constraints (e.g. unit-disk condition),
  • convert embedded graphs into qubit registers.

Embedding data and problems into the Rydberg analog model is a broad research topic. Typically, an embedding is a structure preserving map fembedding:X→Yf_\text{embedding}: X \rightarrow Y, such that an object XX is embedded into an object YY. Our goal is to define optimal embedding functions such that problem-specific data and definitions are embedded into model-compatible objects with the Rydberg analog model.

In QoolQit, all concrete embedders follow a basic interface set by the BaseEmbedder abstract base class:

from qoolqit import ConcreteEmbedder
# Initialize the embedder
embedder = ConcreteEmbedder()
# Access information about the embedding algorithm
embedder.info
# Access the configuration of the embedding algorithm
embedder.config
# Change some value of the embedding configuration
embedder.config.param = new_value
# Define some initial data object
data = some_data_generator()
# Embed the data with the embedder
embedded_data = embedder.embed(data)

In this case, ConcreteEmbedder exemplifies an embedder that already has a mapping function and the respective configuration dataclass for that mapping function. Below, we will exemplify how to use some of the pre-defined concrete embedders directly available in QoolQit, and then show some considerations when defining custom embedders.

All the available embedders are listed in the section Available embedders.

For more details on the definition of custom embedders the reader can refer to Custom embedders.

Interaction embedding means to encode a matrix in the interaction term of the Rydberg analog model. For a matrix UU, the goal is to find the set of coordinates that minimize

min⁡{(x, y)} ∑ij∥Uij−1rij6∥, \min_{\{(x,\, y)\}}~\sum_{ij}\left\|U_{ij}-\frac{1}{r^6_{ij}}\right\|,

where rij=(xi−xj)2+(yi−yj)2r_{ij} = \sqrt{(x_i-x_j)^2 + (y_i-y_j)^2} is the distance between qubits ii and jj. This requires the matrix UU to be positive and symmetric, and only the off-diagonal terms are embedded.

In QoolQit, the InteractionEmbedder performs this minimization using scipy.minimize, and it maps a np.ndarray to a DataGraph with coordinates.

from qoolqit.embedding import InteractionEmbedder
embedder = InteractionEmbedder()
<span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="err">I</span><span class="kc">ntera</span><span class="err">c</span><span class="kc">t</span><span class="err">io</span><span class="kc">n</span><span class="err">Embedder</span><span class="p">:</span>
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="err">|</span><span class="w"> </span><span class="err">Algori</span><span class="kc">t</span><span class="err">hm</span><span class="p">:</span><span class="w"> </span><span class="err">i</span><span class="kc">ntera</span><span class="err">c</span><span class="kc">t</span><span class="err">io</span><span class="kc">n</span><span class="err">_embeddi</span><span class="kc">n</span><span class="err">g</span>
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="err">|</span><span class="w"> </span><span class="err">Co</span><span class="kc">nf</span><span class="err">ig</span><span class="p">:</span><span class="w"> </span><span class="err">I</span><span class="kc">ntera</span><span class="err">c</span><span class="kc">t</span><span class="err">io</span><span class="kc">n</span><span class="err">EmbedderCo</span><span class="kc">nf</span><span class="err">ig(me</span><span class="kc">t</span><span class="err">hod='Nelder</span><span class="mi">-</span><span class="err">Mead'</span><span class="p">,</span><span class="w"> </span><span class="err">maxi</span><span class="kc">ter</span><span class="err">=</span><span class="mi">200000</span><span class="p">,</span><span class="w"> </span><span class="kc">t</span><span class="err">ol=</span><span class="mf">1e-08</span><span class="err">)</span>
</code>

Checking the info on the embedder, we see a few parameters are available for customization through the config. There are parameters that get passed to scipy.minimize, and their description can be found in the SciPy documentation (external).

print(embedder.info)
<span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="mi">--</span><span class="w"> </span><span class="err">Embeddi</span><span class="kc">n</span><span class="err">g</span><span class="w"> </span><span class="err">algori</span><span class="kc">t</span><span class="err">hm</span><span class="w"> </span><span class="err">docs</span><span class="kc">tr</span><span class="err">i</span><span class="kc">n</span><span class="err">g</span><span class="p">:</span>
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="err">Ma</span><span class="kc">tr</span><span class="err">ix</span><span class="w"> </span><span class="err">embeddi</span><span class="kc">n</span><span class="err">g</span><span class="w"> </span><span class="err">i</span><span class="kc">nt</span><span class="err">o</span><span class="w"> </span><span class="kc">t</span><span class="err">he</span><span class="w"> </span><span class="err">i</span><span class="kc">ntera</span><span class="err">c</span><span class="kc">t</span><span class="err">io</span><span class="kc">n</span><span class="w"> </span><span class="kc">ter</span><span class="err">m</span><span class="w"> </span><span class="err">o</span><span class="kc">f</span><span class="w"> </span><span class="kc">t</span><span class="err">he</span><span class="w"> </span><span class="err">Rydberg</span><span class="w"> </span><span class="err">A</span><span class="kc">nal</span><span class="err">og</span><span class="w"> </span><span class="err">Model.</span>
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a>
<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a><span class="err">Uses</span><span class="w"> </span><span class="err">scipy.mi</span><span class="kc">n</span><span class="err">imize</span><span class="w"> </span><span class="kc">t</span><span class="err">o</span><span class="w"> </span><span class="kc">f</span><span class="err">i</span><span class="kc">n</span><span class="err">d</span><span class="w"> </span><span class="kc">t</span><span class="err">he</span><span class="w"> </span><span class="err">op</span><span class="kc">t</span><span class="err">imal</span><span class="w"> </span><span class="err">se</span><span class="kc">t</span><span class="w"> </span><span class="err">o</span><span class="kc">f</span><span class="w"> </span><span class="kc">n</span><span class="err">ode</span><span class="w"> </span><span class="err">coordi</span><span class="kc">nates</span><span class="w"> </span><span class="err">such</span><span class="w"> </span><span class="kc">t</span><span class="err">ha</span><span class="kc">t</span><span class="w"> </span><span class="kc">t</span><span class="err">he</span>
<a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a><span class="err">ma</span><span class="kc">tr</span><span class="err">ix</span><span class="w"> </span><span class="err">o</span><span class="kc">f</span><span class="w"> </span><span class="err">values</span><span class="w"> </span><span class="mi">1</span><span class="err">/(r_ij)^</span><span class="mi">6</span><span class="w"> </span><span class="err">approxima</span><span class="kc">te</span><span class="w"> </span><span class="kc">t</span><span class="err">he</span><span class="w"> </span><span class="err">o</span><span class="kc">ff</span><span class="mi">-</span><span class="err">diago</span><span class="kc">nal</span><span class="w"> </span><span class="kc">ter</span><span class="err">ms</span><span class="w"> </span><span class="err">o</span><span class="kc">f</span><span class="w"> </span><span class="kc">t</span><span class="err">he</span><span class="w"> </span><span class="err">i</span><span class="kc">n</span><span class="err">pu</span><span class="kc">t</span><span class="w"> </span><span class="err">ma</span><span class="kc">tr</span><span class="err">ix.</span>
<a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a>
<a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a><span class="err">Check</span><span class="w"> </span><span class="kc">t</span><span class="err">he</span><span class="w"> </span><span class="err">docume</span><span class="kc">ntat</span><span class="err">io</span><span class="kc">n</span><span class="w"> </span><span class="kc">f</span><span class="err">or</span><span class="w"> </span><span class="err">scipy.mi</span><span class="kc">n</span><span class="err">imize</span><span class="w"> </span><span class="kc">f</span><span class="err">or</span><span class="w"> </span><span class="err">more</span><span class="w"> </span><span class="err">i</span><span class="kc">nf</span><span class="err">orma</span><span class="kc">t</span><span class="err">io</span><span class="kc">n</span><span class="w"> </span><span class="err">abou</span><span class="kc">t</span><span class="w"> </span><span class="err">each</span><span class="w"> </span><span class="err">parame</span><span class="kc">ter</span><span class="p">:</span>
<a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a><span class="err">h</span><span class="kc">tt</span><span class="err">ps</span><span class="p">:</span><span class="c1">//docs.scipy.org/doc/scipy/reference/generated/scipy.optimize.minimize.html</span>
<a id="__codelineno-1-10" name="__codelineno-1-10" href="#__codelineno-1-10"></a>
<a id="__codelineno-1-11" name="__codelineno-1-11" href="#__codelineno-1-11"></a><span class="err">Argume</span><span class="kc">nts</span><span class="p">:</span>
<a id="__codelineno-1-12" name="__codelineno-1-12" href="#__codelineno-1-12"></a><span class="w"> </span><span class="err">ma</span><span class="kc">tr</span><span class="err">ix</span><span class="p">:</span><span class="w"> </span><span class="kc">t</span><span class="err">he</span><span class="w"> </span><span class="err">ma</span><span class="kc">tr</span><span class="err">ix</span><span class="w"> </span><span class="kc">t</span><span class="err">o</span><span class="w"> </span><span class="err">embed.</span>
<a id="__codelineno-1-13" name="__codelineno-1-13" href="#__codelineno-1-13"></a><span class="w"> </span><span class="err">me</span><span class="kc">t</span><span class="err">hod</span><span class="p">:</span><span class="w"> </span><span class="kc">t</span><span class="err">he</span><span class="w"> </span><span class="err">me</span><span class="kc">t</span><span class="err">hod</span><span class="w"> </span><span class="err">used</span><span class="w"> </span><span class="err">by</span><span class="w"> </span><span class="err">scipy.mi</span><span class="kc">n</span><span class="err">imize.</span>
<a id="__codelineno-1-14" name="__codelineno-1-14" href="#__codelineno-1-14"></a><span class="w"> </span><span class="err">maxi</span><span class="kc">ter</span><span class="p">:</span><span class="w"> </span><span class="err">maximum</span><span class="w"> </span><span class="kc">nu</span><span class="err">mber</span><span class="w"> </span><span class="err">o</span><span class="kc">f</span><span class="w"> </span><span class="err">i</span><span class="kc">terat</span><span class="err">io</span><span class="kc">ns</span><span class="err">.</span>
<a id="__codelineno-1-15" name="__codelineno-1-15" href="#__codelineno-1-15"></a><span class="w"> </span><span class="kc">t</span><span class="err">ol</span><span class="p">:</span><span class="w"> </span><span class="kc">t</span><span class="err">olera</span><span class="kc">n</span><span class="err">ce</span><span class="w"> </span><span class="kc">f</span><span class="err">or</span><span class="w"> </span><span class="kc">ter</span><span class="err">mi</span><span class="kc">nat</span><span class="err">io</span><span class="kc">n</span><span class="err">.</span>
</code>

We can try it out with the default configuration by generating a random symmetric positive matrix.

import numpy as np
matrix = np.random.rand(6, 6)
matrix = matrix + matrix.T
<span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="p">[[</span><span class="mf">0.11042058</span><span class="w"> </span><span class="mf">1.37787172</span><span class="w"> </span><span class="mf">0.52223948</span><span class="w"> </span><span class="mf">1.55573126</span><span class="w"> </span><span class="mf">1.25464786</span><span class="w"> </span><span class="mf">0.2243045</span><span class="w"> </span><span class="p">]</span>
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="w"> </span><span class="p">[</span><span class="mf">1.37787172</span><span class="w"> </span><span class="mf">1.14683062</span><span class="w"> </span><span class="mf">1.40535334</span><span class="w"> </span><span class="mf">1.0753044</span><span class="w"> </span><span class="mf">1.21195107</span><span class="w"> </span><span class="mf">1.46143112</span><span class="p">]</span>
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="w"> </span><span class="p">[</span><span class="mf">0.52223948</span><span class="w"> </span><span class="mf">1.40535334</span><span class="w"> </span><span class="mf">0.5516316</span><span class="w"> </span><span class="mf">1.77704975</span><span class="w"> </span><span class="mf">0.95381219</span><span class="w"> </span><span class="mf">1.06186701</span><span class="p">]</span>
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="w"> </span><span class="p">[</span><span class="mf">1.55573126</span><span class="w"> </span><span class="mf">1.0753044</span><span class="w"> </span><span class="mf">1.77704975</span><span class="w"> </span><span class="mf">1.35345901</span><span class="w"> </span><span class="mf">0.93727039</span><span class="w"> </span><span class="mf">0.95289755</span><span class="p">]</span>
<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a><span class="w"> </span><span class="p">[</span><span class="mf">1.25464786</span><span class="w"> </span><span class="mf">1.21195107</span><span class="w"> </span><span class="mf">0.95381219</span><span class="w"> </span><span class="mf">0.93727039</span><span class="w"> </span><span class="mf">1.01704484</span><span class="w"> </span><span class="mf">1.62739762</span><span class="p">]</span>
<a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a><span class="w"> </span><span class="p">[</span><span class="mf">0.2243045</span><span class="w"> </span><span class="mf">1.46143112</span><span class="w"> </span><span class="mf">1.06186701</span><span class="w"> </span><span class="mf">0.95289755</span><span class="w"> </span><span class="mf">1.62739762</span><span class="w"> </span><span class="mf">1.06176601</span><span class="p">]]</span>
</code>

Finally, running the embedding we obtain a DataGraph with coordinates that can be easily converted to a Register of qubits.

from qoolqit import Register
embedded_graph = embedder.embed(matrix)
register = Register.from_graph(embedded_graph)
fig1, ax1 = plt.subplots(figsize=(4,4), dpi=200)
embedded_graph.draw(ax=ax1)
register.draw()
2026-04-09T13:49:23.438048 image/svg+xml Matplotlib v3.10.8, https://matplotlib.org/ 2026-04-09T13:49:23.471451 image/svg+xml Matplotlib v3.10.8, https://matplotlib.org/

To check how the embedding performed, we can inspect the interaction values in the Register and compare them to the off-diagonal elements in the matrix.

interactions = list(register.interactions().values())
triang_upper = np.triu(matrix, k = 1)
off_diagonal = triang_upper[triang_upper != 0].tolist()
print([f"{f:.4f}" for f in sorted(interactions)])
print([f"{f:.4f}" for f in sorted(off_diagonal)])
<span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="p">[</span><span class="err">'</span><span class="mf">0.0233</span><span class="err">'</span><span class="p">,</span><span class="w"> </span><span class="err">'</span><span class="mf">0.0242</span><span class="err">'</span><span class="p">,</span><span class="w"> </span><span class="err">'</span><span class="mf">0.0251</span><span class="err">'</span><span class="p">,</span><span class="w"> </span><span class="err">'</span><span class="mf">0.0310</span><span class="err">'</span><span class="p">,</span><span class="w"> </span><span class="err">'</span><span class="mf">0.0650</span><span class="err">'</span><span class="p">,</span><span class="w"> </span><span class="err">'</span><span class="mf">0.1189</span><span class="err">'</span><span class="p">,</span><span class="w"> </span><span class="err">'</span><span class="mf">0.2051</span><span class="err">'</span><span class="p">,</span><span class="w"> </span><span class="err">'</span><span class="mf">1.1225</span><span class="err">'</span><span class="p">,</span><span class="w"> </span><span class="err">'</span><span class="mf">1.3019</span><span class="err">'</span><span class="p">,</span><span class="w"> </span><span class="err">'</span><span class="mf">1.4835</span><span class="err">'</span><span class="p">,</span><span class="w"> </span><span class="err">'</span><span class="mf">1.4874</span><span class="err">'</span><span class="p">,</span><span class="w"> </span><span class="err">'</span><span class="mf">1.5236</span><span class="err">'</span><span class="p">,</span><span class="w"> </span><span class="err">'</span><span class="mf">1.5354</span><span class="err">'</span><span class="p">,</span><span class="w"> </span><span class="err">'</span><span class="mf">1.5825</span><span class="err">'</span><span class="p">,</span><span class="w"> </span><span class="err">'</span><span class="mf">1.7621</span><span class="err">'</span><span class="p">]</span>
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="p">[</span><span class="err">'</span><span class="mf">0.2243</span><span class="err">'</span><span class="p">,</span><span class="w"> </span><span class="err">'</span><span class="mf">0.5222</span><span class="err">'</span><span class="p">,</span><span class="w"> </span><span class="err">'</span><span class="mf">0.9373</span><span class="err">'</span><span class="p">,</span><span class="w"> </span><span class="err">'</span><span class="mf">0.9529</span><span class="err">'</span><span class="p">,</span><span class="w"> </span><span class="err">'</span><span class="mf">0.9538</span><span class="err">'</span><span class="p">,</span><span class="w"> </span><span class="err">'</span><span class="mf">1.0619</span><span class="err">'</span><span class="p">,</span><span class="w"> </span><span class="err">'</span><span class="mf">1.0753</span><span class="err">'</span><span class="p">,</span><span class="w"> </span><span class="err">'</span><span class="mf">1.2120</span><span class="err">'</span><span class="p">,</span><span class="w"> </span><span class="err">'</span><span class="mf">1.2546</span><span class="err">'</span><span class="p">,</span><span class="w"> </span><span class="err">'</span><span class="mf">1.3779</span><span class="err">'</span><span class="p">,</span><span class="w"> </span><span class="err">'</span><span class="mf">1.4054</span><span class="err">'</span><span class="p">,</span><span class="w"> </span><span class="err">'</span><span class="mf">1.4614</span><span class="err">'</span><span class="p">,</span><span class="w"> </span><span class="err">'</span><span class="mf">1.5557</span><span class="err">'</span><span class="p">,</span><span class="w"> </span><span class="err">'</span><span class="mf">1.6274</span><span class="err">'</span><span class="p">,</span><span class="w"> </span><span class="err">'</span><span class="mf">1.7770</span><span class="err">'</span><span class="p">]</span>
</code>

The spring-layout embedding utilizes the Fruchterman-Reingold force-directed algorithm. It assigns spring-like forces to the edges that keep nodes closer, while treating nodes themselves as repelling objects. The system is then simulated until the nodes find an equilibrium position, which represent the final coordinates assigned to the nodes.

In QoolQit, the SpringLayoutEmbedder directly wraps the nx.spring_layout function, and it maps a DataGraph without coordinates to another DataGraph with coordinates.

from qoolqit.embedding import SpringLayoutEmbedder
embedder = SpringLayoutEmbedder()
<span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="err">Spri</span><span class="kc">n</span><span class="err">gLayou</span><span class="kc">t</span><span class="err">Embedder</span><span class="p">:</span>
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="err">|</span><span class="w"> </span><span class="err">Algori</span><span class="kc">t</span><span class="err">hm</span><span class="p">:</span><span class="w"> </span><span class="err">spri</span><span class="kc">n</span><span class="err">g_layou</span><span class="kc">t</span><span class="err">_embeddi</span><span class="kc">n</span><span class="err">g</span>
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="err">|</span><span class="w"> </span><span class="err">Co</span><span class="kc">nf</span><span class="err">ig</span><span class="p">:</span><span class="w"> </span><span class="err">Spri</span><span class="kc">n</span><span class="err">gLayou</span><span class="kc">t</span><span class="err">Co</span><span class="kc">nf</span><span class="err">ig(i</span><span class="kc">terat</span><span class="err">io</span><span class="kc">ns</span><span class="err">=</span><span class="mi">100</span><span class="p">,</span><span class="w"> </span><span class="kc">t</span><span class="err">hreshold=</span><span class="mf">0.0001</span><span class="p">,</span><span class="w"> </span><span class="err">seed=No</span><span class="kc">ne</span><span class="err">)</span>
</code>

As you can see above it holds an algorithm and a config with a set of default parameters. For information on the algorithm and parameters, you can use the embedder.info property.

print(embedder.info)
<span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="mi">--</span><span class="w"> </span><span class="err">Embeddi</span><span class="kc">n</span><span class="err">g</span><span class="w"> </span><span class="err">algori</span><span class="kc">t</span><span class="err">hm</span><span class="w"> </span><span class="err">docs</span><span class="kc">tr</span><span class="err">i</span><span class="kc">n</span><span class="err">g</span><span class="p">:</span>
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="err">Force</span><span class="mi">-</span><span class="err">direc</span><span class="kc">te</span><span class="err">d</span><span class="w"> </span><span class="err">embeddi</span><span class="kc">n</span><span class="err">g</span><span class="p">,</span><span class="w"> </span><span class="err">wrappi</span><span class="kc">n</span><span class="err">g</span><span class="w"> </span><span class="err">`</span><span class="kc">n</span><span class="err">x.spri</span><span class="kc">n</span><span class="err">g_layou</span><span class="kc">t</span><span class="err">`.</span>
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a>
<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a><span class="err">Ge</span><span class="kc">nerates</span><span class="w"> </span><span class="err">a</span><span class="w"> </span><span class="kc">ne</span><span class="err">w</span><span class="w"> </span><span class="err">graph</span><span class="w"> </span><span class="err">wi</span><span class="kc">t</span><span class="err">h</span><span class="w"> </span><span class="kc">t</span><span class="err">he</span><span class="w"> </span><span class="err">same</span><span class="w"> </span><span class="kc">n</span><span class="err">odes</span><span class="w"> </span><span class="err">a</span><span class="kc">n</span><span class="err">d</span><span class="w"> </span><span class="err">edges</span><span class="w"> </span><span class="err">as</span><span class="w"> </span><span class="kc">t</span><span class="err">he</span><span class="w"> </span><span class="err">origi</span><span class="kc">nal</span><span class="w"> </span><span class="err">graph</span><span class="p">,</span><span class="w"> </span><span class="err">bu</span><span class="kc">t</span><span class="w"> </span><span class="err">wi</span><span class="kc">t</span><span class="err">h</span>
<a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a><span class="kc">n</span><span class="err">ode</span><span class="w"> </span><span class="err">coordi</span><span class="kc">nates</span><span class="w"> </span><span class="err">se</span><span class="kc">t</span><span class="w"> </span><span class="kc">t</span><span class="err">o</span><span class="w"> </span><span class="err">embed</span><span class="w"> </span><span class="err">edge</span><span class="w"> </span><span class="err">weigh</span><span class="kc">ts</span><span class="w"> </span><span class="err">i</span><span class="kc">nt</span><span class="err">o</span><span class="w"> </span><span class="err">pairwise</span><span class="w"> </span><span class="err">dis</span><span class="kc">tan</span><span class="err">ces</span><span class="w"> </span><span class="err">as</span><span class="w"> </span><span class="err">wᵢⱼ=</span><span class="mi">1</span><span class="err">/rᵢⱼ^</span><span class="mf">6.</span>
<a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a>
<a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a><span class="err">The</span><span class="w"> </span><span class="err">posi</span><span class="kc">t</span><span class="err">io</span><span class="kc">ns</span><span class="w"> </span><span class="err">are</span><span class="w"> </span><span class="err">ge</span><span class="kc">nerate</span><span class="err">d</span><span class="w"> </span><span class="err">by</span><span class="w"> </span><span class="err">`</span><span class="kc">n</span><span class="err">x.spri</span><span class="kc">n</span><span class="err">g_layou</span><span class="kc">t</span><span class="err">`.</span>
<a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a><span class="err">Si</span><span class="kc">n</span><span class="err">ce</span><span class="w"> </span><span class="err">`</span><span class="kc">n</span><span class="err">x.spri</span><span class="kc">n</span><span class="err">g_layou</span><span class="kc">t</span><span class="err">`</span><span class="w"> </span><span class="err">embeds</span><span class="w"> </span><span class="err">edge</span><span class="w"> </span><span class="err">weigh</span><span class="kc">ts</span><span class="w"> </span><span class="err">as</span><span class="w"> </span><span class="err">wᵢⱼ</span><span class="w"> </span><span class="err">=</span><span class="w"> </span><span class="err">(k/rᵢⱼ)^</span><span class="mi">3</span><span class="p">,</span><span class="w"> </span><span class="err">we</span><span class="w"> </span><span class="err">se</span><span class="kc">t</span><span class="p">:</span>
<a id="__codelineno-1-10" name="__codelineno-1-10" href="#__codelineno-1-10"></a><span class="w"> </span><span class="mi">-</span><span class="w"> </span><span class="err">`k=</span><span class="mi">1</span><span class="err">`</span><span class="w"> </span><span class="err">a</span><span class="kc">n</span><span class="err">d</span><span class="w"> </span><span class="err">`scale=No</span><span class="kc">ne</span><span class="err">`</span><span class="w"> </span><span class="kc">t</span><span class="err">o</span><span class="w"> </span><span class="err">disable</span><span class="w"> </span><span class="err">global</span><span class="w"> </span><span class="err">rescali</span><span class="kc">n</span><span class="err">g</span><span class="w"> </span><span class="err">o</span><span class="kc">f</span><span class="w"> </span><span class="err">posi</span><span class="kc">t</span><span class="err">io</span><span class="kc">ns</span><span class="err">.</span>
<a id="__codelineno-1-11" name="__codelineno-1-11" href="#__codelineno-1-11"></a><span class="w"> </span><span class="mi">-</span><span class="w"> </span><span class="err">rescale</span><span class="w"> </span><span class="err">weigh</span><span class="kc">ts</span><span class="w"> </span><span class="err">wᵢⱼ</span><span class="w"> </span><span class="mi">-</span><span class="err">></span><span class="w"> </span><span class="err">wᵢⱼ^</span><span class="mi">1</span><span class="err">/</span><span class="mi">2</span>
<a id="__codelineno-1-12" name="__codelineno-1-12" href="#__codelineno-1-12"></a><span class="kc">t</span><span class="err">o</span><span class="w"> </span><span class="err">achieve</span><span class="w"> </span><span class="err">our</span><span class="w"> </span><span class="kc">tar</span><span class="err">ge</span><span class="kc">t</span><span class="w"> </span><span class="err">embeddi</span><span class="kc">n</span><span class="err">g</span><span class="w"> </span><span class="err">wᵢⱼ=</span><span class="mi">1</span><span class="err">/rᵢⱼ^</span><span class="mf">6.</span>
<a id="__codelineno-1-13" name="__codelineno-1-13" href="#__codelineno-1-13"></a>
<a id="__codelineno-1-14" name="__codelineno-1-14" href="#__codelineno-1-14"></a><span class="err">Check</span><span class="w"> </span><span class="kc">t</span><span class="err">he</span><span class="w"> </span><span class="err">docume</span><span class="kc">ntat</span><span class="err">io</span><span class="kc">n</span><span class="w"> </span><span class="kc">f</span><span class="err">or</span><span class="w"> </span><span class="err">`</span><span class="kc">n</span><span class="err">x.spri</span><span class="kc">n</span><span class="err">g_layou</span><span class="kc">t</span><span class="err">`</span><span class="w"> </span><span class="kc">f</span><span class="err">or</span><span class="w"> </span><span class="err">more</span><span class="w"> </span><span class="err">i</span><span class="kc">nf</span><span class="err">orma</span><span class="kc">t</span><span class="err">io</span><span class="kc">n</span><span class="w"> </span><span class="err">abou</span><span class="kc">t</span><span class="w"> </span><span class="err">each</span><span class="w"> </span><span class="err">parame</span><span class="kc">ter</span><span class="p">:</span>
<a id="__codelineno-1-15" name="__codelineno-1-15" href="#__codelineno-1-15"></a><span class="err">h</span><span class="kc">tt</span><span class="err">ps</span><span class="p">:</span><span class="c1">//networkx.org/documentation/stable/reference/generated/networkx.drawing.layout.spring_layout.html</span>
<a id="__codelineno-1-16" name="__codelineno-1-16" href="#__codelineno-1-16"></a>
<a id="__codelineno-1-17" name="__codelineno-1-17" href="#__codelineno-1-17"></a><span class="err">Args</span><span class="p">:</span>
<a id="__codelineno-1-18" name="__codelineno-1-18" href="#__codelineno-1-18"></a><span class="w"> </span><span class="err">graph</span><span class="p">:</span><span class="w"> </span><span class="kc">t</span><span class="err">he</span><span class="w"> </span><span class="err">graph</span><span class="w"> </span><span class="kc">t</span><span class="err">o</span><span class="w"> </span><span class="err">embed</span><span class="w"> </span><span class="err">accordi</span><span class="kc">n</span><span class="err">g</span><span class="w"> </span><span class="kc">t</span><span class="err">o</span><span class="w"> </span><span class="err">i</span><span class="kc">ts</span><span class="w"> </span><span class="err">edge</span><span class="w"> </span><span class="err">weigh</span><span class="kc">ts</span><span class="err">.</span>
<a id="__codelineno-1-19" name="__codelineno-1-19" href="#__codelineno-1-19"></a><span class="w"> </span><span class="err">i</span><span class="kc">terat</span><span class="err">io</span><span class="kc">ns</span><span class="p">:</span><span class="w"> </span><span class="err">maximum</span><span class="w"> </span><span class="kc">nu</span><span class="err">mber</span><span class="w"> </span><span class="err">o</span><span class="kc">f</span><span class="w"> </span><span class="err">i</span><span class="kc">terat</span><span class="err">io</span><span class="kc">ns</span><span class="w"> </span><span class="kc">t</span><span class="err">o</span><span class="w"> </span><span class="kc">ta</span><span class="err">ke.</span>
<a id="__codelineno-1-20" name="__codelineno-1-20" href="#__codelineno-1-20"></a><span class="w"> </span><span class="kc">t</span><span class="err">hreshold</span><span class="p">:</span><span class="w"> </span><span class="err">Threshold</span><span class="w"> </span><span class="kc">f</span><span class="err">or</span><span class="w"> </span><span class="err">rela</span><span class="kc">t</span><span class="err">ive</span><span class="w"> </span><span class="err">error</span><span class="w"> </span><span class="err">i</span><span class="kc">n</span><span class="w"> </span><span class="kc">n</span><span class="err">ode</span><span class="w"> </span><span class="err">posi</span><span class="kc">t</span><span class="err">io</span><span class="kc">n</span><span class="w"> </span><span class="err">cha</span><span class="kc">n</span><span class="err">ges.</span>
<a id="__codelineno-1-21" name="__codelineno-1-21" href="#__codelineno-1-21"></a><span class="w"> </span><span class="err">The</span><span class="w"> </span><span class="err">i</span><span class="kc">terat</span><span class="err">io</span><span class="kc">n</span><span class="w"> </span><span class="err">s</span><span class="kc">t</span><span class="err">ops</span><span class="w"> </span><span class="err">i</span><span class="kc">f</span><span class="w"> </span><span class="kc">f</span><span class="err">orce</span><span class="mi">-</span><span class="err">displaceme</span><span class="kc">nt</span><span class="w"> </span><span class="err">is</span><span class="w"> </span><span class="err">below</span><span class="w"> </span><span class="kc">t</span><span class="err">his</span><span class="w"> </span><span class="kc">t</span><span class="err">hreshold.</span>
<a id="__codelineno-1-22" name="__codelineno-1-22" href="#__codelineno-1-22"></a><span class="w"> </span><span class="err">seed</span><span class="p">:</span><span class="w"> </span><span class="err">ra</span><span class="kc">n</span><span class="err">dom</span><span class="w"> </span><span class="err">seed</span><span class="w"> </span><span class="kc">f</span><span class="err">or</span><span class="w"> </span><span class="err">reproducibili</span><span class="kc">t</span><span class="err">y.</span>
<a id="__codelineno-1-23" name="__codelineno-1-23" href="#__codelineno-1-23"></a>
<a id="__codelineno-1-24" name="__codelineno-1-24" href="#__codelineno-1-24"></a><span class="err">Re</span><span class="kc">turns</span><span class="p">:</span>
<a id="__codelineno-1-25" name="__codelineno-1-25" href="#__codelineno-1-25"></a><span class="w"> </span><span class="err">Da</span><span class="kc">ta</span><span class="err">Graph</span><span class="p">:</span><span class="w"> </span><span class="err">graph</span><span class="w"> </span><span class="err">wi</span><span class="kc">t</span><span class="err">h</span><span class="w"> </span><span class="kc">t</span><span class="err">he</span><span class="w"> </span><span class="kc">n</span><span class="err">ode</span><span class="w"> </span><span class="err">coordi</span><span class="kc">nates</span><span class="w"> </span><span class="err">se</span><span class="kc">t</span><span class="w"> </span><span class="err">accordi</span><span class="kc">n</span><span class="err">g</span><span class="w"> </span><span class="kc">t</span><span class="err">o</span><span class="w"> </span><span class="kc">t</span><span class="err">he</span><span class="w"> </span><span class="err">spri</span><span class="kc">n</span><span class="err">g</span><span class="mi">-</span><span class="err">layou</span><span class="kc">t</span><span class="w"> </span><span class="err">embeddi</span><span class="kc">n</span><span class="err">g.</span>
</code>

In this case, the embedder is a direct wrapper on top of nx.spring_layout, and any parameters are the ones directly used by that function. For more information, you can check the documentation for NetworkX (external). The parameters can be directly changed in the config.

embedder.config.iterations = 100
embedder.config.seed = 1
print(embedder)
<span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="err">Spri</span><span class="kc">n</span><span class="err">gLayou</span><span class="kc">t</span><span class="err">Embedder</span><span class="p">:</span>
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="err">|</span><span class="w"> </span><span class="err">Algori</span><span class="kc">t</span><span class="err">hm</span><span class="p">:</span><span class="w"> </span><span class="err">spri</span><span class="kc">n</span><span class="err">g_layou</span><span class="kc">t</span><span class="err">_embeddi</span><span class="kc">n</span><span class="err">g</span>
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="err">|</span><span class="w"> </span><span class="err">Co</span><span class="kc">nf</span><span class="err">ig</span><span class="p">:</span><span class="w"> </span><span class="err">Spri</span><span class="kc">n</span><span class="err">gLayou</span><span class="kc">t</span><span class="err">Co</span><span class="kc">nf</span><span class="err">ig(i</span><span class="kc">terat</span><span class="err">io</span><span class="kc">ns</span><span class="err">=</span><span class="mi">100</span><span class="p">,</span><span class="w"> </span><span class="kc">t</span><span class="err">hreshold=</span><span class="mf">0.0001</span><span class="p">,</span><span class="w"> </span><span class="err">seed=</span><span class="mi">1</span><span class="err">)</span>
</code>

Finally, we can run the embedder with the embed method.

import matplotlib.pyplot as plt
from qoolqit import DataGraph
graph_1 = DataGraph.random_er(n = 7, p = 0.3, seed = 3)
embedded_graph_1 = embedder.embed(graph_1)
fig, axs = plt.subplots(1, 2, figsize=(8,4), dpi=200)
graph_1.draw(ax=axs[0])
embedded_graph_1.draw(ax=axs[1])
2026-04-09T13:49:23.635500 image/svg+xml Matplotlib v3.10.8, https://matplotlib.org/

Now, we can check if the resulting graph is a unit-disk graph

embedded_graph_1.is_ud_graph()
<span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="err">True</span>
</code>

In this case, the embedding was successful and we obtained a unit-disk graph. For more densely connected graphs, the spring layout algorithm tends to struggle with finding a unit-disk graph embedding, if it even exists.

graph_2 = DataGraph.random_er(n = 7, p = 0.8, seed = 3)
embedded_graph_2 = embedder.embed(graph_2)
fig, axs = plt.subplots(1, 2, figsize=(8,4), dpi=200)
graph_2.draw(ax=axs[0])
embedded_graph_2.draw(ax=axs[1])
2026-04-09T13:49:23.789181 image/svg+xml Matplotlib v3.10.8, https://matplotlib.org/

embedded_graph_2.is_ud_graph()
<span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="err">False</span>
</code>

However, in both cases, we have embedded the original data into a graph with coordinates, which is an object that is compatible with the Rydberg analog model. As such, we can directly instantiate a register of qubits from these graphs.

from qoolqit import Register
register_1 = Register.from_graph(embedded_graph_1)
register_2 = Register.from_graph(embedded_graph_2)
register_1.draw()
register_2.draw()
2026-04-09T13:49:23.872466 image/svg+xml Matplotlib v3.10.8, https://matplotlib.org/ 2026-04-09T13:49:23.918889 image/svg+xml Matplotlib v3.10.8, https://matplotlib.org/

Coming soon...