ommx-openjij-adapter 1.8.4__tar.gz → 1.8.5__tar.gz

{ommx_openjij_adapter-1.8.4 → ommx_openjij_adapter-1.8.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ommx_openjij_adapter
-Version: 1.8.4
+Version: 1.8.5
 Summary: OMMX Adapter for OpenJij.
 Author-email: "Jij Inc." <info@j-ij.com>
 Project-URL: Repository, https://github.com/Jij-Inc/ommx
@@ -14,7 +14,7 @@ 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.8.4
+Requires-Dist: ommx<2.0.0,>=1.8.5
 Requires-Dist: openjij>=0.9.2
 
 OMMX Adapter for OpenJij

ommx_openjij_adapter-1.8.5/ommx_openjij_adapter/__init__.py

@@ -0,0 +1,207 @@
+from __future__ import annotations
+
+from ommx.v1 import Instance, State, Samples, SampleSet
+from ommx.adapter import SamplerAdapter
+import openjij as oj
+from typing_extensions import deprecated
+
+
+class OMMXOpenJijSAAdapter(SamplerAdapter):
+    """
+    Sampling QUBO with Simulated Annealing (SA) by `openjij.SASampler <https://openjij.github.io/OpenJij/reference/openjij/index.html#openjij.SASampler>`_
+    """
+
+    ommx_instance: Instance
+    """
+    ommx.v1.Instance representing a QUBO problem
+
+    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 an instance to QUBO via :meth:`ommx.v1.Instance.penalty_method` or other corresponding method.
+    """
+
+    beta_min: float | None = None
+    """ minimal value of inverse temperature """
+    beta_max: float | None = None
+    """ maximum value of inverse temperature """
+    num_sweeps: int | None = None
+    """ number of sweeps """
+    num_reads: int | None = None
+    """ number of reads """
+    schedule: list | None = None
+    """ list of inverse temperature """
+    initial_state: list | dict | None = None
+    """ initial state """
+    updater: str | None = None
+    """ updater algorithm """
+    sparse: bool | None = None
+    """ use sparse matrix or not """
+    reinitialize_state: bool | None = None
+    """ if true reinitialize state for each run """
+    seed: int | None = None
+    """ seed for Monte Carlo algorithm """
+
+    @classmethod
+    def sample(
+        cls,
+        ommx_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,
+    ) -> SampleSet:
+        sampler = cls(
+            ommx_instance,
+            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,
+        )
+        response = sampler._sample()
+        return sampler.decode_to_sampleset(response)
+
+    def __init__(
+        self,
+        ommx_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,
+    ):
+        self.ommx_instance = ommx_instance
+        self.beta_min = beta_min
+        self.beta_max = beta_max
+        self.num_sweeps = num_sweeps
+        self.num_reads = num_reads
+        self.schedule = schedule
+        self.initial_state = initial_state
+        self.updater = updater
+        self.sparse = sparse
+        self.reinitialize_state = reinitialize_state
+        self.seed = seed
+
+    def decode_to_sampleset(self, data: oj.Response) -> SampleSet:
+        samples = decode_to_samples(data)
+        return self.ommx_instance.evaluate_samples(samples)
+
+    def decode_to_samples(self, data: oj.Response) -> Samples:
+        """
+        Convert `openjij.Response <https://openjij.github.io/OpenJij/reference/openjij/index.html#openjij.Response>`_ to :class:`Samples`
+
+        There is a static method :meth:`decode_to_samples` that does the same thing.
+        """
+        return decode_to_samples(data)
+
+    @property
+    def sampler_input(self) -> dict[tuple[int, int], float]:
+        qubo, _offset = self.ommx_instance.as_qubo_format()
+        return qubo
+
+    def _sample(self) -> oj.Response:
+        sampler = oj.SASampler()
+        qubo, _offset = self.ommx_instance.as_qubo_format()
+        return sampler.sample_qubo(
+            qubo,  # type: ignore
+            beta_min=self.beta_min,
+            beta_max=self.beta_max,
+            num_sweeps=self.num_sweeps,
+            num_reads=self.num_reads,
+            schedule=self.schedule,
+            initial_state=self.initial_state,
+            updater=self.updater,
+            sparse=self.sparse,
+            reinitialize_state=self.reinitialize_state,
+            seed=self.seed,
+        )
+
+
+@deprecated("Renamed to `decode_to_samples`")
+def response_to_samples(response: oj.Response) -> Samples:
+    """
+    Deprecated: renamed to :meth:`decode_to_samples`
+    """
+    return decode_to_samples(response)
+
+
+def decode_to_samples(response: oj.Response) -> Samples:
+    """
+    Convert `openjij.Response <https://openjij.github.io/OpenJij/reference/openjij/index.html#openjij.Response>`_ to :class:`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)
+
+
+@deprecated("Use `OMMXOpenJijSAAdapter.sample` instead")
+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:
+    """
+    Deprecated: Use :meth:`OMMXOpenJijSAAdapter.sample` instead
+    """
+    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 decode_to_samples(response)

{ommx_openjij_adapter-1.8.4 → ommx_openjij_adapter-1.8.5}/ommx_openjij_adapter.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ommx_openjij_adapter
-Version: 1.8.4
+Version: 1.8.5
 Summary: OMMX Adapter for OpenJij.
 Author-email: "Jij Inc." <info@j-ij.com>
 Project-URL: Repository, https://github.com/Jij-Inc/ommx
@@ -14,7 +14,7 @@ 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.8.4
+Requires-Dist: ommx<2.0.0,>=1.8.5
 Requires-Dist: openjij>=0.9.2
 
 OMMX Adapter for OpenJij

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

@@ -0,0 +1,2 @@
+ommx<2.0.0,>=1.8.5
+openjij>=0.9.2

{ommx_openjij_adapter-1.8.4 → ommx_openjij_adapter-1.8.5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ommx_openjij_adapter"
-version = "1.8.4"
+version = "1.8.5"
 
 description = "OMMX Adapter for OpenJij."
 authors = [{ name = "Jij Inc.", email = "info@j-ij.com" }]
@@ -20,7 +20,7 @@ classifiers = [
     "License :: OSI Approved :: Apache Software License",
     "License :: OSI Approved :: MIT License",
 ]
-dependencies = ["ommx>=1.8.4,<2.0.0", "openjij>=0.9.2"]
+dependencies = ["ommx>=1.8.5,<2.0.0","openjij>=0.9.2"]
 
 [project.urls]
 Repository = "https://github.com/Jij-Inc/ommx"

{ommx_openjij_adapter-1.8.4 → ommx_openjij_adapter-1.8.5}/tests/test_sample.py

@@ -1,5 +1,5 @@
 from ommx.v1 import Instance, DecisionVariable
-import ommx_openjij_adapter as adapter
+from ommx_openjij_adapter import OMMXOpenJijSAAdapter
 
 
 def test_minimize():
@@ -12,8 +12,7 @@ def test_minimize():
         constraints=[],
         sense=Instance.MINIMIZE,
     )
-    samples = adapter.sample_qubo_sa(instance, num_reads=1)
-    sample_set = instance.evaluate_samples(samples)
+    sample_set = OMMXOpenJijSAAdapter.sample(instance, num_reads=1)
 
     # x0 = x1 = 0 is minimum
     assert sample_set.extract_decision_variables("x", 0) == {(0,): 0.0, (1,): 0.0}
@@ -30,8 +29,7 @@ def test_maximize():
         sense=Instance.MAXIMIZE,
     )
     instance.as_minimization_problem()
-    samples = adapter.sample_qubo_sa(instance, num_reads=1)
-    sample_set = instance.evaluate_samples(samples)
+    sample_set = OMMXOpenJijSAAdapter.sample(instance, num_reads=1)
 
     # x0 = x1 = 1 is maximum
     assert sample_set.extract_decision_variables("x", 0) == {(0,): 1.0, (1,): 1.0}

ommx_openjij_adapter-1.8.4/ommx_openjij_adapter/__init__.py

@@ -1,87 +0,0 @@
-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.8.4/ommx_openjij_adapter.egg-info/requires.txt

@@ -1,2 +0,0 @@
-ommx<2.0.0,>=1.8.4
-openjij>=0.9.2