Add lattice-utils to dwave-experimental by SebastianGitt · Pull Request #44 · dwavesystems/dwave-experimental

SebastianGitt · 2026-03-13T20:49:49Z

Add a minimal version of LatQA to dwave-experimental as a submodule named lattice-utils. Currently supports examples of a 1D Ising Chain and a 2D dimerized triangular lattice. Tests still need to be added to the pull request.

-move initialization of num_spins to subclass

thisac

Thanks @SebastianGitt! First pass of the lattice submodule.

I'd recommend running a formatter (black) since all of these files are new and there are a few places with incorrect spacing, etc.
I think the saving/loading of embeddings can be refined a bit, but I'll have a closer look at it later.

-added more comprehensive docstrings -fixed formatting issues

…dwave-experimental into add-lattice-utils

…utils

-removed spin reversal transform functionality -uses automorphism module already in dwave-experimental -uses data classes for experiment configs

-removed spin reversal transform functionality -uses automorphism module already in dwave-experimental -uses data classes for experiment configs -formatted using black

andrew-d-king

Looks generally good; I am not able to pore over it in detail but it all seems sensible.

thisac

Still have experiment module to look at. Re. the tests, it probably makes sense splitting them up into several files collected in a test_lattice_utils folder.

-added progress bars using TQDM -added docstrings to the evaluation methods in observable.py -misc cleanup

…dwave-experimental into add-lattice-utils

jackraymond

Nice job, especially the integration of new automorphism functionality to make the shimming tutorial generalizable.

Some of this code is not lattice specific, I'd prefer it weren't bundled up in a lattice utility. Like embed_bqm (which mirrors a dwave.system) and unembed_bqm (which perhaps is, or should be dwave.system method), bootstrapping, bitstring compression. Ideally we could think how to extract it for more general use.

Examples don't run well, or at all for me. Adding an interface and some additional help messages on what is going on would be great. Perhaps cite papers etc where statistics are used.

There are a lot of magic numbers/methods floating around, if these could be promoted to function arguments and justified that would be great.

Some other naming conventions I found a bit confusing.

-fix failing tests due to updated method signatures with explicit arguments -rename energy_scale to signed_energy_scale

-remove existing examples and replaced with a new 1D chain shimming example -restructure tests into separate files in a new folder -update optimize function to accept custom dimod solvers -expand docstring for ``embed_bqm`` method to explain difference from existing methods in dwave-system -promote ``optimize`` and ``make_networkx_graph`` to public methods

thisac

Looking good so far! A couple of comments and improvements before ready to merge.

One thing that we discussed already: tqdm should be made into an optional dependency. Currently it's required to install.

thisac

A few more comments...

thisac · 2026-07-07T18:37:08Z

+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""Shimming example for 1D Ising chain."""


Let's also rename this file to just 1D_Ising_chain_shim.py or maybe prefix it with lattice_utils or even put it in a lattice_utils subfolder since there are quite a few more lattice-utils examples incoming, no?

-make TQDM an optional import -order imports -add some missing docstrings -removed subscript unpacking for Python 3.10 compatibility -updated licenses to 2026

codecov-commenter · 2026-07-21T17:30:09Z

Codecov Report

❌ Patch coverage is 89.96317% with 109 lines in your changes missing coverage. Please review.
✅ Project coverage is 92.46%. Comparing base (703b3cd) to head (3f092e2).
⚠️ Report is 28 commits behind head on main.

Files with missing lines	Patch %	Lines
...xperimental/lattice_utils/experiment/experiment.py	83.58%	65 Missing ⚠️
...wave/experimental/lattice_utils/lattice/lattice.py	89.62%	14 Missing ⚠️
...xperimental/lattice_utils/observable/observable.py	90.00%	10 Missing ⚠️
...e/experimental/lattice_utils/lattice/triangular.py	91.95%	7 Missing ⚠️
...xperimental/lattice_utils/observable/triangular.py	82.75%	5 Missing ⚠️
...ave/experimental/lattice_utils/lattice/optimize.py	94.44%	3 Missing ⚠️
...rimental/lattice_utils/lattice/embedded_lattice.py	97.75%	2 Missing ⚠️
dwave/experimental/lattice_utils/lattice/chain.py	95.00%	1 Missing ⚠️
...ave/experimental/lattice_utils/observable/kinks.py	96.00%	1 Missing ⚠️
dwave/experimental/lattice_utils/utils.py	96.29%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #44      +/-   ##
==========================================
- Coverage   95.38%   92.46%   -2.92%     
==========================================
  Files          13       30      +17     
  Lines         931     2017    +1086     
==========================================
+ Hits          888     1865     +977     
- Misses         43      152     +109

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

thisac

A couple of things noticed, but otherwise happy to merge when approved by @andrew-d-king.

-import Experiment and Lattice types for proper type hints -fix typos -SamplerCall is now a proper data class

randomir

A few comments, after a first pass over the experiment and lattice modules.

randomir · 2026-08-19T12:31:45Z

+from pathlib import Path
+import sys
+REPO_ROOT = Path(__file__).resolve().parents[1]
+if str(REPO_ROOT) not in sys.path:
+    sys.path.insert(0, str(REPO_ROOT))
+


This is not needed when example requirements are installed. Note that those requirements include the dwave-experimental package in the parent repo (-e .. line).

Suggested change

from pathlib import Path

import sys

REPO_ROOT = Path(__file__).resolve().parents[1]

if str(REPO_ROOT) not in sys.path:

sys.path.insert(0, str(REPO_ROOT))

randomir · 2026-08-19T12:39:12Z

+    )
+
+
+def _make_mock_sampler(


Why is dwave.system.testing.MockDWaveSampler not sufficient here? Could we rather extend the existing mock sampler if some functionality is needed here?

randomir · 2026-08-19T13:39:30Z

+        if sampler is None:
+            return self._get_path(kind)
+
+        if type(sampler).__name__ == "MockDWaveSampler":


why not isinstance test here?

randomir · 2026-08-19T13:48:38Z

+__all__ = ['optimize', 'ExponentialBackoffSimulatedAnnealingSampler']
+
+
+class ExponentialBackoffSimulatedAnnealingSampler(dimod.Sampler):


It's not backoff (timeout) that's exponential, but number of sweeps.

Suggested change

class ExponentialBackoffSimulatedAnnealingSampler(dimod.Sampler):

class ExponentialSweepsSimulatedAnnealingSampler(dimod.Sampler):

randomir · 2026-08-19T13:54:59Z

+    reference_sample = None
+
+    # If the lattice is embedded, we should optimize the logical lattice
+    if hasattr(lattice, "logical_lattice"):


Why do you prefer duck typing over explicit type check?

Suggested change

if hasattr(lattice, "logical_lattice"):

if isinstance(lattice, EmbeddedLattice):

Here, and elsewhere.

In this case it was to avoid circular imports

randomir · 2026-08-19T14:22:15Z

+    def __init__(
+        self,
+        *,
+        inst: Lattice,


Better name:

Suggested change

inst: Lattice,

lattice: Lattice,

randomir · 2026-08-19T14:31:59Z

+            if result_fields is None:
+                result_fields = list(data.keys())
+            if ignore_shim:
+                result_fields.remove("shim_data")


This fails with ValueError when "shim_data" is not in the list -- e.g. on second file (!), or when passed-in arg is not None, but omits the shim data value.

randomir · 2026-08-19T14:49:53Z

+
+        # Strip spaces and replace other unswanted symbols with underscores.
+        pathstring = pathstring.replace(" ", "_")
+        for bad_symbol in ":;,":


Here, and elsewhere (security): use an allowlist for pathname construction, not a short denylist.

E.g. allow only [A-Za-z0-9._-], replace the rest with _.

Consider anneal_schedule or solver name containing /../../.

randomir · 2026-08-19T14:56:00Z

+
+        try:
+            with lzma.open(filename, "rb") as f:
+                data = pickle.load(f)


The use of pickle (in a loop) is the biggest security/safety issue I see in this PR.

We can allow it for now in the experimental package, but we will have to replace it with np.savez/np.savez_compressed/orjson/JSON/similar serialization before moving this code to Ocean.

Unless you feel keen on rewriting the serialization in this PR, please add a warning to the experiment/lattice module docs.

Thanks, I'll add the warning. It will be deprecated in favour of using databases before its merged to Ocean.

randomir · 2026-08-19T15:03:29Z

+            else:
+                break
+
+        best_sampleset.info["num_sweeps_exit"] = num_sweeps


This fails if the while loop doesn't run!

-use an allowlist for pathname construction -add warning about the security risk of using pickled data

SebastianGitt added 2 commits March 13, 2026 13:42

Add lattice-utils to dwave-experimental

7dac34b

Add unit tests

23938bf

-move initialization of num_spins to subclass

thisac reviewed Apr 24, 2026

View reviewed changes

SebastianGitt added 7 commits May 7, 2026 11:08

Improve docstrings and formatting

759eca5

-added more comprehensive docstrings -fixed formatting issues

Improve docstrings and formatting

b6bf8f6

-added more comprehensive docstrings -fixed formatting issues

Merge branch 'add-lattice-utils' of https://github.com/SebastianGitt/…

a5ae37d

…dwave-experimental into add-lattice-utils

Merge remote-tracking branch 'sebastians-fork/main' into add-lattice-…

0aa1bff

…utils

Remove temporary automorphism file and additional cleanup

8122131

-removed spin reversal transform functionality -uses automorphism module already in dwave-experimental -uses data classes for experiment configs

Remove temporary automorphism file and additional cleanup

0ef6a52

-removed spin reversal transform functionality -uses automorphism module already in dwave-experimental -uses data classes for experiment configs -formatted using black

Format using black

ab9348a

SebastianGitt marked this pull request as ready for review May 14, 2026 17:50

andrew-d-king suggested changes May 15, 2026

View reviewed changes

thisac reviewed Jun 3, 2026

View reviewed changes

SebastianGitt added 4 commits June 8, 2026 11:45

Add progress bars and missing docstrings

f364d2d

-added progress bars using TQDM -added docstrings to the evaluation methods in observable.py -misc cleanup

Add progress bars and missing docstrings

06d43bf

-added progress bars using TQDM -added docstrings to the evaluation methods in observable.py -misc cleanup

Merge branch 'add-lattice-utils' of https://github.com/SebastianGitt/…

26381f8

…dwave-experimental into add-lattice-utils

Update default parameters of 1D example

dab4d6d

jackraymond reviewed Jun 9, 2026

View reviewed changes

SebastianGitt added 2 commits June 11, 2026 11:56

Update tests and examples

80c3929

-fix failing tests due to updated method signatures with explicit arguments -rename energy_scale to signed_energy_scale

thisac reviewed Jul 7, 2026

View reviewed changes

Make TQDM optional

2b02cee

-make TQDM an optional import -order imports -add some missing docstrings -removed subscript unpacking for Python 3.10 compatibility -updated licenses to 2026

SebastianGitt force-pushed the add-lattice-utils branch from fd48b6e to 2b02cee Compare July 21, 2026 17:27

thisac approved these changes Aug 12, 2026

View reviewed changes

Fix type hints

b34c984

-import Experiment and Lattice types for proper type hints -fix typos -SamplerCall is now a proper data class

SebastianGitt requested a review from andrew-d-king August 13, 2026 17:27

andrew-d-king approved these changes Aug 13, 2026

View reviewed changes

randomir reviewed Aug 19, 2026

View reviewed changes

Use DWaveMockSampler for tests and miscellaneous cleanup

3f092e2

-use an allowlist for pathname construction -add warning about the security risk of using pickled data

		__all__ = ['optimize', 'ExponentialBackoffSimulatedAnnealingSampler']


		class ExponentialBackoffSimulatedAnnealingSampler(dimod.Sampler):

	class ExponentialBackoffSimulatedAnnealingSampler(dimod.Sampler):
	class ExponentialSweepsSimulatedAnnealingSampler(dimod.Sampler):

	if hasattr(lattice, "logical_lattice"):
	if isinstance(lattice, EmbeddedLattice):

Uh oh!

Conversation

SebastianGitt commented Mar 13, 2026

Uh oh!

thisac left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

andrew-d-king left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

thisac left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jackraymond left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

thisac left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

thisac left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov-commenter commented Jul 21, 2026 •

edited

Loading