ommx-dwave-adapter 0.0.0__tar.gz

ommx_dwave_adapter-0.0.0/.github/workflows/docs.yml

@@ -0,0 +1,62 @@
+name: Documents
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.9"
+
+      - name: Install dependencies
+        run: pip install ".[dev]"
+
+      - name: Build documentation
+        run: sphinx-build -b html ./docs/source ./docs/build
+
+      - name: Upload HTML
+        uses: actions/upload-artifact@v4
+        with:
+          name: docs
+          path: ./docs/build
+          retention-days: 30
+
+  deploy:
+    needs: build
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download HTML
+        uses: actions/download-artifact@v4
+        with:
+          name: docs
+          path: .
+      
+      - name: Configure GitHub Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: "."
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

ommx_dwave_adapter-0.0.0/.github/workflows/release.yml

@@ -0,0 +1,47 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "*"
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.9"
+
+      - name: Build wheel
+        run: |
+          python -m pip install --upgrade pip build
+          python -m build --sdist --outdir ./dist .
+
+      - name: Upload
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheel
+          path: ./dist/
+          retention-days: 30
+
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    needs: [build]
+    steps:
+      - name: Download artifact
+        uses: actions/download-artifact@v4
+        with:
+          path: dist
+          pattern: "*"
+          merge-multiple: true
+
+      - name: Upload wheels to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

ommx_dwave_adapter-0.0.0/.github/workflows/test.yaml

@@ -0,0 +1,47 @@
+name: test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install Dependencies
+        run: |
+          pip install ".[dev]"
+          pip install pytest-github-actions-annotate-failures
+
+      - name: Type check
+        if: always()
+        run: |
+          pyright
+
+      - name: Lint
+        if: always()
+        run: |
+          ruff check
+
+      - name: Check format
+        if: always()
+        run: |
+          ruff format --check
+
+      - name: Run Tests
+        if: always()
+        run: |
+          pytest --doctest-modules -vv

ommx_dwave_adapter-0.0.0/.gitignore

@@ -0,0 +1,171 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# PyPI configuration file
+.pypirc

ommx_dwave_adapter-0.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

ommx_dwave_adapter-0.0.0/PKG-INFO

@@ -0,0 +1,61 @@
+Metadata-Version: 2.4
+Name: ommx_dwave_adapter
+Version: 0.0.0
+Summary: An adapter between OMMX and DWave
+Author-email: "Jij Inc." <info@j-ij.com>
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: Apache Software License
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ommx<2.0.0,>=1.8.5
+Requires-Dist: dwave-system>=1.29.1
+Provides-Extra: dev
+Requires-Dist: pyright; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: sphinx; extra == "dev"
+Requires-Dist: sphinx-autoapi; extra == "dev"
+Requires-Dist: sphinx_fontawesome; extra == "dev"
+Requires-Dist: sphinx_rtd_theme; extra == "dev"
+Dynamic: license-file
+
+# ommx-dwave-adapter
+
+Provides an adapter to translate between [OMMX](https://github.com/Jij-Inc/ommx) and [D-Wave](https://docs.ocean.dwavesys.com/en/stable/index.html) samplers.
+
+Currently only implements an adapter to LeapHybridCQMSampler.
+
+# Usage
+
+`ommx-dwave-adapter` can be installed from PyPI as follows:
+
+```bash
+pip install ommx-dwave-adapter
+```
+
+An example usage of the LeapHybridCQMSampler through this adapter:
+
+```python 
+from ommx_dwave_adapter import OMMXLeapHybridCQMAdapter
+from ommx.v1 import Instance, DecisionVariable
+
+x1 = DecisionVariable.integer(1, lower=0, upper=5)
+ommx_instance = Instance.from_components(
+    decision_variables=[x1],
+    objective=x1,
+    constraints=[],
+    sense=Instance.MINIMIZE,
+)
+
+# Create `ommx.v1.SampleSet` through `diwave.system.LeapHybridCQMSampler`
+# Your Leap token can be set through configuration file, environment variable,
+# or passed with a `token` parameter.
+ommx_sampleset = OMMLeapHybridCQMAdapter.sample(ommx_instance)
+
+print(ommx_sampleset)
+```

ommx_dwave_adapter-0.0.0/README.md

@@ -0,0 +1,35 @@
+# ommx-dwave-adapter
+
+Provides an adapter to translate between [OMMX](https://github.com/Jij-Inc/ommx) and [D-Wave](https://docs.ocean.dwavesys.com/en/stable/index.html) samplers.
+
+Currently only implements an adapter to LeapHybridCQMSampler.
+
+# Usage
+
+`ommx-dwave-adapter` can be installed from PyPI as follows:
+
+```bash
+pip install ommx-dwave-adapter
+```
+
+An example usage of the LeapHybridCQMSampler through this adapter:
+
+```python 
+from ommx_dwave_adapter import OMMXLeapHybridCQMAdapter
+from ommx.v1 import Instance, DecisionVariable
+
+x1 = DecisionVariable.integer(1, lower=0, upper=5)
+ommx_instance = Instance.from_components(
+    decision_variables=[x1],
+    objective=x1,
+    constraints=[],
+    sense=Instance.MINIMIZE,
+)
+
+# Create `ommx.v1.SampleSet` through `diwave.system.LeapHybridCQMSampler`
+# Your Leap token can be set through configuration file, environment variable,
+# or passed with a `token` parameter.
+ommx_sampleset = OMMLeapHybridCQMAdapter.sample(ommx_instance)
+
+print(ommx_sampleset)
+```

ommx_dwave_adapter-0.0.0/ommx_dwave_adapter/__init__.py

@@ -0,0 +1,4 @@
+from .adapter import OMMXLeapHybridCQMAdapter
+from .exception import OMMXDWaveAdapterError
+
+__all__ = ["OMMXLeapHybridCQMAdapter", "OMMXDWaveAdapterError"]

ommx_dwave_adapter-0.0.0/ommx_dwave_adapter/adapter.py

@@ -0,0 +1,289 @@
+from ommx.adapter import SamplerAdapter
+from ommx.v1 import Instance, SampleSet, Solution, DecisionVariable, Constraint
+from ommx.v1.linear_pb2 import Linear
+from ommx.v1.quadratic_pb2 import Quadratic
+
+import math
+import dimod
+from dimod import ConstrainedQuadraticModel
+from dwave.system import LeapHybridCQMSampler
+from typing import Optional
+
+from .exception import OMMXDWaveAdapterError
+
+
+class OMMXLeapHybridCQMAdapter(SamplerAdapter):
+    def __init__(self, ommx_instance: Instance):
+        """
+        :param ommx_instance: The ommx.v1.Instance to sample.
+        """
+        self.instance = ommx_instance
+        self.model = ConstrainedQuadraticModel()
+
+        self._set_decision_variables()
+        self._set_objective()
+        self._set_constraints()
+
+    @classmethod
+    def sample(
+        cls,
+        ommx_instance: Instance,
+        *,
+        token: Optional[str] = None,
+        time_limit: Optional[int] = None,
+        label: Optional[str] = None,
+    ) -> SampleSet:
+        """Solve the given ommx.v1.Instance using dwave's LeapHybridCQMSampler,
+        returning the samples as an ommx.v1.SampleSet.
+
+        **NOTE** The `token` must be specified either through the optional
+          parameter or the DWave config file. Refer to DWave documentation for
+          more info.
+
+        :param ommx_instance: The ommx.v1.Instance to solve.
+        :param token: Token for instantiating the DWave sampler, obtained from your Leap account.
+        :param time_limit: Maximum time the solver will use, in seconds. Must be greater than the minimum time limit specified by DWave (currently 5)
+        :param label: Optional label to tag the problem with.
+
+        Example:
+        =========
+        The following example shows how to solve an unconstrained linear optimization problem with `x` as the objective function.
+
+        .. doctest::
+
+            >>> from ommx_dwave_adapter import OMMXLeapHybridCQMAdapter
+            >>> from ommx.v1 import Instance, DecisionVariable, Linear
+            >>>
+            >>> x1 = DecisionVariable.integer(1, lower=0, upper=5)
+            >>> ommx_instance = Instance.from_components(
+            ...     decision_variables=[x1],
+            ...     objective=x1,
+            ...     constraints=[],
+            ...     sense=Instance.MINIMIZE,
+            ... )
+            >>> token = "YOUR API TOKEN" # Set your API token
+            >>> solution = OMMXFixstarsAmplifyAdapter.sample(ommx_instance, token=token) # doctest: +SKIP
+        """
+        # Dwave appears to be able to read configuration from a config file
+        # automatically, and this apparently includes the token. Users may want
+        # to use the file as a way to pass the token, so we can't necessarily
+        # give an error on an empty token
+
+        adapter = cls(ommx_instance)
+        model = adapter.sampler_input
+        sampler = LeapHybridCQMSampler(token=token)
+
+        # TODO is this necessary or will it always just go for the minimum if no time limit is set?
+        if (
+            time_limit is None
+            or time_limit < sampler.properties["minimum_time_limit_s"]
+        ):
+            time_limit = sampler.properties["minimum_time_limit_s"]
+
+        dimod_sampleset = sampler.sample_cqm(model, time_limit=time_limit, label=label)
+        dimod_sampleset.resolve()
+
+        return adapter.decode_to_sampleset(dimod_sampleset)
+
+    @classmethod
+    def solve(
+        cls,
+        ommx_instance: Instance,
+        *,
+        token: Optional[str] = None,
+        time_limit: Optional[int] = None,
+        label: Optional[str] = None,
+    ) -> Solution:
+        """Solve the given ommx.v1.Instance using dwave's LeapHybridCQMSampler,
+        returning the best feasible solution as an ommx.v1.Solution.
+
+        **NOTE** The `token` must be specified either through the optional
+          parameter or the DWave config file. Refer to DWave documentation for
+          more info.
+
+        :param ommx_instance: The ommx.v1.Instance to solve.
+        :param token: Token for instantiating the DWave sampler, obtained from your Leap account.
+        :param time_limit: Maximum time the solver will use, in seconds. Must be greater than the minimum time limit specified by DWave (currently 5)
+        :param label: Optional label to tag the problem with.
+
+        Example:
+        =========
+        The following example shows how to solve an unconstrained linear optimization problem with `x` as the objective function.
+
+        .. doctest::
+
+            >>> from ommx_dwave_adapter import OMMXLeapHybridCQMAdapter
+            >>> from ommx.v1 import Instance, DecisionVariable, Linear
+            >>>
+            >>> x1 = DecisionVariable.integer(1, lower=0, upper=5)
+            >>> ommx_instance = Instance.from_components(
+            ...     decision_variables=[x1],
+            ...     objective=x1,
+            ...     constraints=[],
+            ...     sense=Instance.MINIMIZE,
+            ... )
+            >>> token = "YOUR API TOKEN" # Set your API token
+            >>> solution = OMMXFixstarsAmplifyAdapter.solve(ommx_instance, token=token) # doctest: +SKIP
+        """
+        return cls.sample(
+            ommx_instance, token=token, time_limit=time_limit, label=label
+        ).best_feasible()
+
+    @property
+    def sampler_input(self) -> ConstrainedQuadraticModel:
+        """The dimod.ConstrainedQuadraticModel representing this OMMX instance"""
+        return self.model
+
+    def decode_to_sampleset(self, data: dimod.SampleSet) -> SampleSet:
+        """Convert a dimod.SampleSet model matching this instance to an ommx.v1.SampleSet.
+
+        This method is intended to be used if the model has been acquired with
+        `sampler_input` for futher adjustment of the sampler parameters, and
+        separately optimizing the model.
+
+        Note that alterations to the model may make the decoding process
+        incompatible -- decoding will only work if the model still describes
+        effectively the same problem as the OMMX instance used to create the
+        adapter.
+
+        Example:
+        =========
+        The following example shows how to solve an unconstrained linear optimization problem with `x` as the objective function.
+
+        .. doctest::
+
+            >>> from ommx_dwave_adapter import OMMXLeapHybridCQMAdapter
+            >>> from ommx.v1 import Instance, DecisionVariable, Linear
+            >>> from dwave.system import LeapHybridCQMSampler
+            >>> x1 = DecisionVariable.integer(1, lower=0, upper=5)
+            >>> ommx_instance = Instance.from_components(
+            ...     decision_variables=[x1],
+            ...     objective=x1,
+            ...     constraints=[],
+            ...     sense=Instance.MINIMIZE,
+            ... )
+            >>>
+            >>> adapter = OMMXLeapHybridCQMAdapter(ommx_instance)
+            >>> model = adapter.sampler_input # obtain dimod.ConstrainedQuadraticModel
+            >>> sampler = LeapHybridCQMSampler() # doctest: +SKIP
+            >>> # ... some modification of the sampler parameters
+            >>> dimod_sampleset = sampler.sample_cqm(model) # doctest: +SKIP
+            >>> sample = adapter.decode_to_sampleset(dimod_sampleset)  # doctest: +SKIP
+        """
+        # the only type info we have with vars in data.variables is that they're
+        # Hashable. We know they are integers but we hash them anyway for type
+        # safety. As we stored our variables as integer the hash should still be
+        # our IDs
+        samples = {
+            i: {
+                var.__hash__(): float(coeff)
+                for var, coeff in zip(data.variables, sample)
+            }
+            for i, sample in enumerate(data.record.sample)
+        }
+        return self.instance.evaluate_samples(samples)
+
+    def _set_decision_variables(self):
+        for var in self.instance.raw.decision_variables:
+            if var.kind == DecisionVariable.BINARY:
+                self.model.add_variable("BINARY", var.id)
+            elif var.kind == DecisionVariable.INTEGER:
+                self.model.add_variable(
+                    "INTEGER",
+                    var.id,
+                    lower_bound=var.bound.lower,
+                    upper_bound=var.bound.upper,
+                )
+            elif var.kind == DecisionVariable.CONTINUOUS:
+                self.model.add_variable(
+                    "REAL",
+                    var.id,
+                    lower_bound=var.bound.lower,
+                    upper_bound=var.bound.upper,
+                )
+            else:
+                raise OMMXDWaveAdapterError(
+                    f"Unsupported decision variable kind: "
+                    f"id: {var.id}, kind: {var.kind}"
+                )
+
+    def _set_objective(self):
+        objective = self.instance.raw.objective
+
+        if objective.HasField("constant"):
+            self.model.set_objective([(objective.constant,)])
+            return
+        elif objective.HasField("linear"):
+            expr = self._make_linear_expr(objective.linear)
+            self.model.set_objective(expr)
+        elif objective.HasField("quadratic"):
+            expr = self._make_quadratic_expr(objective.quadratic)
+            self.model.set_objective(expr)
+        else:
+            raise OMMXDWaveAdapterError(
+                f"Unsupport objective function type: must be either `constant`, `linear` or `quadratic`."
+                f"type: {objective.WhichOneof('function')}"
+            )
+
+        if self.instance.raw.sense == Instance.MAXIMIZE:
+            # multiply all coefficients by -1:
+            # this takes all except the last element from the tuple and concatenates it
+            # with the last element multiplied with -1 to get a new tuple
+            expr = [tuple[:-1] + (-1 * tuple[-1],) for tuple in expr]
+        self.model.set_objective(expr)
+
+    def _set_constraints(self):
+        for constraint in self.instance.raw.constraints:
+            if constraint.function.HasField("linear"):
+                expr = self._make_linear_expr(constraint.function.linear)
+            elif constraint.function.HasField("quadratic"):
+                expr = self._make_quadratic_expr(constraint.function.quadratic)
+            elif constraint.function.HasField("constant"):
+                if constraint.equality == Constraint.EQUAL_TO_ZERO and math.isclose(
+                    constraint.function.constant, 0, abs_tol=1e-6
+                ):
+                    continue
+                elif (
+                    constraint.equality == Constraint.LESS_THAN_OR_EQUAL_TO_ZERO
+                    and constraint.function.constant <= 1e-6
+                ):
+                    continue
+                else:
+                    raise OMMXDWaveAdapterError(
+                        f"Infeasible constant constraint was found: id {constraint.id}"
+                    )
+            else:
+                raise OMMXDWaveAdapterError(
+                    f"Constraints must be either `constant`, `linear` or `quadratic`."
+                    f"id: {constraint.id}, "
+                    f"type: {constraint.function.WhichOneof('function')}"
+                )
+
+            if constraint.equality == Constraint.EQUAL_TO_ZERO:
+                constr_sense = "=="
+            elif constraint.equality == Constraint.LESS_THAN_OR_EQUAL_TO_ZERO:
+                constr_sense = "<="
+            else:
+                raise OMMXDWaveAdapterError(
+                    f"Unsupported constraint equality: "
+                    f"id: {constraint.id}, equality: {constraint.equality}"
+                )
+
+            # rhs is assumed 0 by dwave
+            self.model.add_constraint_from_iterable(
+                expr, constr_sense, label=constraint.id
+            )
+
+    def _make_linear_expr(self, linear: Linear):
+        # we transform our expression into a list of tuples.
+        # Each tuple is all the variable IDs used in a term, followed by the coefficient of that term.
+        tuples = [(term.id, term.coefficient) for term in linear.terms]
+        return tuples + [(linear.constant,)]
+
+    def _make_quadratic_expr(self, quad: Quadratic):
+        quad_tuples = [
+            (row, column, value)
+            for row, column, value in zip(quad.rows, quad.columns, quad.values)
+        ]
+        linear_tuples = [(term.id, term.coefficient) for term in quad.linear.terms]
+        return quad_tuples + linear_tuples + [(quad.linear.constant,)]

ommx_dwave_adapter-0.0.0/ommx_dwave_adapter/exception.py

@@ -0,0 +1,2 @@
+class OMMXDWaveAdapterError(Exception):
+    pass

ommx_dwave_adapter-0.0.0/ommx_dwave_adapter.egg-info/PKG-INFO

@@ -0,0 +1,61 @@
+Metadata-Version: 2.4
+Name: ommx_dwave_adapter
+Version: 0.0.0
+Summary: An adapter between OMMX and DWave
+Author-email: "Jij Inc." <info@j-ij.com>
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: Apache Software License
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ommx<2.0.0,>=1.8.5
+Requires-Dist: dwave-system>=1.29.1
+Provides-Extra: dev
+Requires-Dist: pyright; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: sphinx; extra == "dev"
+Requires-Dist: sphinx-autoapi; extra == "dev"
+Requires-Dist: sphinx_fontawesome; extra == "dev"
+Requires-Dist: sphinx_rtd_theme; extra == "dev"
+Dynamic: license-file
+
+# ommx-dwave-adapter
+
+Provides an adapter to translate between [OMMX](https://github.com/Jij-Inc/ommx) and [D-Wave](https://docs.ocean.dwavesys.com/en/stable/index.html) samplers.
+
+Currently only implements an adapter to LeapHybridCQMSampler.
+
+# Usage
+
+`ommx-dwave-adapter` can be installed from PyPI as follows:
+
+```bash
+pip install ommx-dwave-adapter
+```
+
+An example usage of the LeapHybridCQMSampler through this adapter:
+
+```python 
+from ommx_dwave_adapter import OMMXLeapHybridCQMAdapter
+from ommx.v1 import Instance, DecisionVariable
+
+x1 = DecisionVariable.integer(1, lower=0, upper=5)
+ommx_instance = Instance.from_components(
+    decision_variables=[x1],
+    objective=x1,
+    constraints=[],
+    sense=Instance.MINIMIZE,
+)
+
+# Create `ommx.v1.SampleSet` through `diwave.system.LeapHybridCQMSampler`
+# Your Leap token can be set through configuration file, environment variable,
+# or passed with a `token` parameter.
+ommx_sampleset = OMMLeapHybridCQMAdapter.sample(ommx_instance)
+
+print(ommx_sampleset)
+```

ommx_dwave_adapter-0.0.0/ommx_dwave_adapter.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+.gitignore
+LICENSE
+README.md
+pyproject.toml
+.github/workflows/docs.yml
+.github/workflows/release.yml
+.github/workflows/test.yaml
+ommx_dwave_adapter/__init__.py
+ommx_dwave_adapter/adapter.py
+ommx_dwave_adapter/exception.py
+ommx_dwave_adapter.egg-info/PKG-INFO
+ommx_dwave_adapter.egg-info/SOURCES.txt
+ommx_dwave_adapter.egg-info/dependency_links.txt
+ommx_dwave_adapter.egg-info/requires.txt
+ommx_dwave_adapter.egg-info/top_level.txt
+tests/test_cqm_adapter.py

ommx_dwave_adapter-0.0.0/ommx_dwave_adapter.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ommx_dwave_adapter-0.0.0/ommx_dwave_adapter.egg-info/requires.txt

@@ -0,0 +1,11 @@
+ommx<2.0.0,>=1.8.5
+dwave-system>=1.29.1
+
+[dev]
+pyright
+pytest
+ruff
+sphinx
+sphinx-autoapi
+sphinx_fontawesome
+sphinx_rtd_theme

ommx_dwave_adapter-0.0.0/ommx_dwave_adapter.egg-info/top_level.txt

@@ -0,0 +1 @@
+ommx_dwave_adapter

ommx_dwave_adapter-0.0.0/pyproject.toml

@@ -0,0 +1,37 @@
+[build-system]
+requires = ["setuptools>=64", "setuptools_scm>=8", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ommx_dwave_adapter"
+dynamic = ["version"]
+description = "An adapter between OMMX and DWave"
+authors = [
+    { name = "Jij Inc.", email = "info@j-ij.com" }
+]
+readme = "README.md"
+requires-python = ">= 3.9"
+classifiers = [
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "License :: OSI Approved :: Apache Software License",
+]
+
+dependencies = [
+    "ommx >= 1.8.5, < 2.0.0",
+    "dwave-system>=1.29.1",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pyright",
+    "pytest",
+    "ruff",
+    "sphinx",
+    "sphinx-autoapi",
+    "sphinx_fontawesome",
+    "sphinx_rtd_theme",
+]

ommx_dwave_adapter-0.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

ommx_dwave_adapter-0.0.0/tests/test_cqm_adapter.py

@@ -0,0 +1,127 @@
+from ommx.v1 import Instance, DecisionVariable, Polynomial, Function
+from dimod.sym import Sense
+import dimod
+import pytest
+
+from ommx_dwave_adapter import OMMXLeapHybridCQMAdapter, OMMXDWaveAdapterError
+
+
+def test_instance_to_cqm_model():
+    # simple knapsack problem
+    p = [10, 13, 18, 31, 7, 15]
+    w = [11, 25, 20, 35, 10, 33]
+    W = 47
+    N = len(p)
+
+    x = [
+        DecisionVariable.binary(
+            id=i,
+            name="x",
+            subscripts=[i],
+        )
+        for i in range(N)
+    ]
+    constraints = [Function(sum(w[i] * x[i] for i in range(N))) <= W]
+    instance = Instance.from_components(
+        decision_variables=x,
+        objective=sum(p[i] * x[i] for i in range(N)),
+        constraints=constraints,
+        sense=Instance.MAXIMIZE,
+    )
+    adapter = OMMXLeapHybridCQMAdapter(instance)
+    model = adapter.solver_input
+    assert model.vartype(x[0].id) == dimod.BINARY
+    assert list(model.variables) == [var.id for var in x]
+
+    assert model.objective.quadratic == {}
+    # MAXIMIZE check: dwave only minimizes, so all coefficients must have had their sign changed
+    assert model.objective.linear == {x[i].id: -p[i] for i in range(N)}
+    assert model.objective.offset == 0.0
+
+    assert model.constraints[0].sense == Sense.Le
+    assert model.constraints[0].lhs.offset == -W
+    assert model.constraints[0].lhs.linear == {x[i].id: w[i] for i in range(N)}
+    assert model.constraints[0].rhs == 0
+
+
+def test_error_on_unsupported_function():
+    decision_variables = [
+        DecisionVariable.of_type(
+            kind=DecisionVariable.BINARY, id=0, lower=0, upper=1, name="x"
+        ),
+        DecisionVariable.of_type(
+            kind=DecisionVariable.INTEGER,
+            id=1,
+            lower=-20.0,
+            upper=20.0,
+            name="y",
+            subscripts=[],
+        ),
+        DecisionVariable.of_type(
+            kind=DecisionVariable.CONTINUOUS,
+            id=2,
+            lower=-30,
+            upper=30,
+            name="z",
+            subscripts=[0],
+        ),
+        DecisionVariable.of_type(
+            kind=DecisionVariable.CONTINUOUS,
+            id=3,
+            # TODO dwave doesn't accept -inf, +inf. how to handle this? should the adapter convert?
+            lower=float("-1e30"),
+            upper=float("1e30"),
+            name="w",
+            subscripts=[1, 2],
+        ),
+    ]
+    objective = Polynomial(terms={(0, 1, 2): 2.0, (1, 2): 3.0, (2,): 4.0, (): 5.0})
+
+    instance = Instance.from_components(
+        decision_variables=decision_variables,
+        objective=objective,
+        constraints=[],
+        sense=Instance.MINIMIZE,
+    )
+    with pytest.raises(OMMXDWaveAdapterError):
+        OMMXLeapHybridCQMAdapter(instance)
+
+
+def test_decode():
+    p = [10, 13, 18, 31, 7, 15]
+    w = [11, 25, 20, 35, 10, 33]
+    W = 47
+    N = len(p)
+
+    x = [
+        DecisionVariable.binary(
+            id=i,
+            name="x",
+            subscripts=[i],
+        )
+        for i in range(N)
+    ]
+    constraints = [Function(sum(w[i] * x[i] for i in range(N))) <= W]
+    instance = Instance.from_components(
+        decision_variables=x,
+        objective=sum(p[i] * x[i] for i in range(N)),
+        constraints=constraints,
+        sense=Instance.MAXIMIZE,
+    )
+    adapter = OMMXLeapHybridCQMAdapter(instance)
+    cqm = adapter.sampler_input
+
+    # using ExactCQM solver as a testable stand-in
+    dimod_sampleset = dimod.ExactCQMSolver().sample_cqm(cqm)
+    dimod_sampleset.resolve()
+
+    sampleset = adapter.decode_to_sampleset(dimod_sampleset)
+    assert sampleset.raw.sense == Instance.MAXIMIZE
+    best = sampleset.best_feasible()
+    assert best.objective == 41
+    assert best.raw.state.entries[0] == pytest.approx(1)
+    assert best.raw.state.entries[1] == pytest.approx(0)
+    assert best.raw.state.entries[2] == pytest.approx(0)
+    assert best.raw.state.entries[3] == pytest.approx(1)
+    assert best.raw.state.entries[4] == pytest.approx(0)
+    assert best.raw.state.entries[5] == pytest.approx(0)