ommx-openjij-adapter 1.6.0__tar.gz

ommx_openjij_adapter-1.6.0/PKG-INFO

@@ -0,0 +1,23 @@
+Metadata-Version: 2.1
+Name: ommx_openjij_adapter
+Version: 1.6.0
+Summary: OMMX Adapter for OpenJij.
+Author-email: "Jij Inc." <info@j-ij.com>
+Project-URL: Repository, https://github.com/Jij-Inc/ommx
+Project-URL: Issues, https://github.com/Jij-Inc/ommx/issues
+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
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: <3.13,>=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: ommx<2.0.0,>=1.4.0
+Requires-Dist: openjij>=0.9.2
+Provides-Extra: dev
+
+OMMX Adapter for OpenJij
+=========================
+

ommx_openjij_adapter-1.6.0/README.md

@@ -0,0 +1,3 @@
+OMMX Adapter for OpenJij
+=========================
+

ommx_openjij_adapter-1.6.0/ommx_openjij_adapter/__init__.py

@@ -0,0 +1,87 @@
+from __future__ import annotations
+
+from ommx.v1 import Instance, State, Samples
+import openjij as oj
+
+
+def response_to_samples(response: oj.Response) -> Samples:
+    """
+    Convert OpenJij's `Response` to `ommx.v1.Samples`
+    """
+    # Filling into ommx.v1.Samples
+    # Since OpenJij does not issue the sample ID, we need to generate it in the responsibility of this OMMX Adapter
+    sample_id = 0
+    entries = []
+
+    num_reads = len(response.record.num_occurrences)
+    for i in range(num_reads):
+        sample = response.record.sample[i]
+        state = State(entries=zip(response.variables, sample))  # type: ignore
+        # `num_occurrences` is encoded into sample ID list.
+        # For example, if `num_occurrences` is 2, there are two samples with the same state, thus two sample IDs are generated.
+        ids = []
+        for _ in range(response.record.num_occurrences[i]):
+            ids.append(sample_id)
+            sample_id += 1
+        entries.append(Samples.SamplesEntry(state=state, ids=ids))
+    return Samples(entries=entries)
+
+
+def sample_qubo_sa(
+    instance: Instance,
+    *,
+    beta_min: float | None = None,
+    beta_max: float | None = None,
+    num_sweeps: int | None = None,
+    num_reads: int | None = None,
+    schedule: list | None = None,
+    initial_state: list | dict | None = None,
+    updater: str | None = None,
+    sparse: bool | None = None,
+    reinitialize_state: bool | None = None,
+    seed: int | None = None,
+) -> Samples:
+    """
+    Sampling QUBO with Simulated Annealing (SA) by [`openjij.SASampler`](https://openjij.github.io/OpenJij/reference/openjij/index.html#openjij.SASampler)
+
+    The input `instance` must be a QUBO (Quadratic Unconstrained Binary Optimization) problem, i.e.
+
+    - Every decision variables are binary
+    - No constraint
+    - Objective function is quadratic
+    - Minimization problem
+
+    You can convert a problem to QUBO via [`ommx.v1.Instance.penalty_method`](https://jij-inc.github.io/ommx/python/ommx/autoapi/ommx/v1/index.html#ommx.v1.Instance.penalty_method) or other corresponding method.
+
+    :param instance: ommx.v1.Instance representing a QUBO problem
+    :param beta_min: minimal value of inverse temperature
+    :param beta_max: maximum value of inverse temperature
+    :param num_sweeps: number of sweeps
+    :param num_reads: number of reads
+    :param schedule: list of inverse temperature
+    :param initial_state: initial state
+    :param updater: updater algorithm
+    :param sparse: use sparse matrix or not.
+    :param reinitialize_state: if true reinitialize state for each run
+    :param seed: seed for Monte Carlo algorithm
+
+    Note that this is a simple wrapper function for `openjij.SASampler.sample_qubo` method.
+    For more advanced usage, you can use `ommx.v1.Instance.as_qubo_format` to get QUBO matrix,
+    and use OpenJij manually, and convert the `openjij.Response` via `response_to_samples` function.
+    """
+    q, _offset = instance.as_qubo_format()
+    sampler = oj.SASampler()
+    response = sampler.sample_qubo(
+        q,  # type: ignore
+        beta_min=beta_min,
+        beta_max=beta_max,
+        num_sweeps=num_sweeps,
+        num_reads=num_reads,
+        schedule=schedule,
+        initial_state=initial_state,
+        updater=updater,
+        sparse=sparse,
+        reinitialize_state=reinitialize_state,
+        seed=seed,
+    )
+    return response_to_samples(response)

ommx_openjij_adapter-1.6.0/ommx_openjij_adapter.egg-info/PKG-INFO

@@ -0,0 +1,23 @@
+Metadata-Version: 2.1
+Name: ommx_openjij_adapter
+Version: 1.6.0
+Summary: OMMX Adapter for OpenJij.
+Author-email: "Jij Inc." <info@j-ij.com>
+Project-URL: Repository, https://github.com/Jij-Inc/ommx
+Project-URL: Issues, https://github.com/Jij-Inc/ommx/issues
+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
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: <3.13,>=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: ommx<2.0.0,>=1.4.0
+Requires-Dist: openjij>=0.9.2
+Provides-Extra: dev
+
+OMMX Adapter for OpenJij
+=========================
+

ommx_openjij_adapter-1.6.0/ommx_openjij_adapter.egg-info/SOURCES.txt

@@ -0,0 +1,9 @@
+README.md
+pyproject.toml
+ommx_openjij_adapter/__init__.py
+ommx_openjij_adapter.egg-info/PKG-INFO
+ommx_openjij_adapter.egg-info/SOURCES.txt
+ommx_openjij_adapter.egg-info/dependency_links.txt
+ommx_openjij_adapter.egg-info/requires.txt
+ommx_openjij_adapter.egg-info/top_level.txt
+tests/test_sample.py

ommx_openjij_adapter-1.6.0/ommx_openjij_adapter.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ommx_openjij_adapter-1.6.0/ommx_openjij_adapter.egg-info/requires.txt

@@ -0,0 +1,4 @@
+ommx<2.0.0,>=1.4.0
+openjij>=0.9.2
+
+[dev]

ommx_openjij_adapter-1.6.0/ommx_openjij_adapter.egg-info/top_level.txt

@@ -0,0 +1 @@
+ommx_openjij_adapter

ommx_openjij_adapter-1.6.0/pyproject.toml

@@ -0,0 +1,30 @@
+[build-system]
+requires = ["setuptools>=64", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ommx_openjij_adapter"
+version = "1.6.0"
+
+description = "OMMX Adapter for OpenJij."
+authors = [{ name = "Jij Inc.", email = "info@j-ij.com" }]
+readme = "README.md"
+
+requires-python = ">=3.9, <3.13"
+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",
+    "License :: OSI Approved :: MIT License",
+]
+dependencies = ["ommx>=1.4.0,<2.0.0", "openjij>=0.9.2"]
+
+[project.urls]
+Repository = "https://github.com/Jij-Inc/ommx"
+Issues = "https://github.com/Jij-Inc/ommx/issues"
+
+[project.optional-dependencies]
+dev = []

ommx_openjij_adapter-1.6.0/setup.cfg

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

ommx_openjij_adapter-1.6.0/tests/test_sample.py

@@ -0,0 +1,37 @@
+from ommx.v1 import Instance, DecisionVariable
+import ommx_openjij_adapter as adapter
+
+
+def test_minimize():
+    x0 = DecisionVariable.binary(0, name="x", subscripts=[0])
+    x1 = DecisionVariable.binary(1, name="x", subscripts=[1])
+
+    instance = Instance.from_components(
+        decision_variables=[x0, x1],
+        objective=x0 + x1,
+        constraints=[],
+        sense=Instance.MINIMIZE,
+    )
+    samples = adapter.sample_qubo_sa(instance, num_reads=1)
+    sample_set = instance.evaluate_samples(samples)
+
+    # x0 = x1 = 0 is minimum
+    assert sample_set.extract_decision_variables("x", 0) == {(0,): 0.0, (1,): 0.0}
+
+
+def test_maximize():
+    x0 = DecisionVariable.binary(0, name="x", subscripts=[0])
+    x1 = DecisionVariable.binary(1, name="x", subscripts=[1])
+
+    instance = Instance.from_components(
+        decision_variables=[x0, x1],
+        objective=x0 + x1,
+        constraints=[],
+        sense=Instance.MAXIMIZE,
+    )
+    instance.as_minimization_problem()
+    samples = adapter.sample_qubo_sa(instance, num_reads=1)
+    sample_set = instance.evaluate_samples(samples)
+
+    # x0 = x1 = 1 is maximum
+    assert sample_set.extract_decision_variables("x", 0) == {(0,): 1.0, (1,): 1.0}