ommx-python-mip-adapter 0.0.2__tar.gz → 0.1.1__tar.gz

ommx_python_mip_adapter-0.1.1/.github/workflows/docs.yml

@@ -0,0 +1,72 @@
+name: Documents
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+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.8"
+      
+      - name: Install dependencies
+        run: |
+          python -m pip install ".[dev]"
+      
+      - name: Build Python 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:
+    if: github.ref == 'refs/heads/main'
+    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@v4
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: "."
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

{ommx_python_mip_adapter-0.0.2 → ommx_python_mip_adapter-0.1.1}/.github/workflows/test_and_lint.yml

@@ -28,7 +28,7 @@ jobs:
 
       - name: Run Tests
         run: |
-          python -m pytest
+          python -m pytest --doctest-modules -vv
 
   lint:
     runs-on: ubuntu-latest
@@ -50,5 +50,26 @@ jobs:
 
       - name: Lint
         run: |
-          python -m mypy ./ommx_python_mip_adapter
           python -m pyright ./ommx_python_mip_adapter
+
+  markdown-code-runner:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.8", "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: |
+          python -m pip install ".[dev]"
+
+      - name: Lint
+        run: |
+          markdown-code-runner --verbose README.md

ommx_python_mip_adapter-0.1.1/PKG-INFO

@@ -0,0 +1,132 @@
+Metadata-Version: 2.1
+Name: ommx_python_mip_adapter
+Version: 0.1.1
+Summary: An adapter for the Python-MIP from/to OMMX.
+Author-email: "Jij Inc." <info@j-ij.com>
+Project-URL: Repository, https://github.com/Jij-Inc/ommx-python-mip-adapter
+Project-URL: Issues, https://github.com/Jij-Inc/ommx-python-mip-adapter/issues
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+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.8
+Description-Content-Type: text/markdown
+License-File: LICENSE-APACHE
+License-File: LICENSE-MIT
+Requires-Dist: ommx<0.3.0,>=0.2.0
+Requires-Dist: mip
+Provides-Extra: dev
+Requires-Dist: markdown-code-runner; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: numpy; extra == "dev"
+Requires-Dist: pyright; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: sphinx; extra == "dev"
+Requires-Dist: sphinx_rtd_theme; extra == "dev"
+Requires-Dist: sphinx_fontawesome; extra == "dev"
+Requires-Dist: sphinx-autoapi; extra == "dev"
+
+OMMX adaptor for Python-MIP
+============================
+![PyPI - Version](https://img.shields.io/pypi/v/ommx-python-mip-adapter)
+
+This package provides an adaptor for the [Python-MIP](https://www.python-mip.com/) from/to [OMMX](https://github.com/Jij-Inc/ommx)
+
+Python-MIP as a solver in OMMX toolchain
+-----------------------------------------
+```mermaid
+sequenceDiagram
+    participant U as User
+    participant A as Adapter
+    participant P as Python-MIP
+    U->>A: ommx.v1.Instance
+    A->>U: Python-MIP model
+    U->>P: Python-MIP model and Parameters for Python-MIP;
+    P->>P: Solve with CBC, Gurobi, or other solvers
+    P->>U: Optimized model
+    U->>A: Optimized model and ommx.v1.Instance
+    A->>U: ommx:SolutionList
+```
+
+Python-MIP as a user interface to create OMMX instance
+-------------------------------------------------------
+```mermaid
+sequenceDiagram
+    participant U as User
+    participant A as Adapter
+    participant O as Other OMMX toolchain
+    U->>A: Python-MIP model
+    A->>U: ommx.v1.Instance
+    U->>O: ommx.v1.Instance and Parameters for other solver
+    O->>O: Solve the instance with other solver using other adapter
+    O->>U: ommx.v1.Solution
+```
+
+Usage
+======
+`ommx-python-mip-adapter` can be installed from PyPI as follows:
+
+```bash
+pip install ommx-python-mip-adapter
+```
+
+Python-MIP can be used through `ommx-python-mip-adapter` by using the following:
+
+```python markdown-code-runner
+import ommx_python_mip_adapter as adapter
+from ommx.v1.decision_variables_pb2 import DecisionVariable, Bound
+from ommx.v1.instance_pb2 import Instance
+from ommx.v1.function_pb2 import Function
+from ommx.v1.linear_pb2 import Linear
+from ommx.v1.solution_pb2 import SolutionList
+
+ommx_instance = Instance(
+    decision_variables=[
+        DecisionVariable(
+            id=1,
+            kind=DecisionVariable.KIND_INTEGER,
+            bound=Bound(lower=0, upper=5),
+        ),
+    ],
+    objective=Function(
+        linear=Linear(
+            terms=[Linear.Term(id=1, coefficient=1)]
+        ),
+    ),
+)
+ommx_instance_bytes = ommx_instance.SerializeToString()
+
+# Convert from `ommx.v1.Instance` to `mip.Model`
+model = adapter.instance_to_model(ommx_instance_bytes)
+model.optimize()
+# Create `ommx.v1.SolutionList` from Optimized `mip.Model`
+ommx_solutions_bytes = adapter.model_to_solution(
+    model, ommx_instance_bytes
+)
+
+print(SolutionList.FromString(ommx_solutions_bytes))
+```
+You can get `ommx.v1.Instance` from a Python-MIP model as the following:
+```python markdown-code-runner
+import mip
+import ommx_python_mip_adapter as adapter
+from ommx.v1.instance_pb2 import Instance
+
+model = mip.Model()
+x1=model.add_var(name="1", var_type=mip.INTEGER, lb=0, ub=5)
+x2=model.add_var(name="2", var_type=mip.CONTINUOUS, lb=0, ub=5)
+model.objective = - x1 - 2 * x2
+model.add_constr(x1 + x2 - 6 <= 0)
+
+ommx_instance_bytes = adapter.model_to_instance(model)
+
+print(Instance.FromString(ommx_instance_bytes))
+```
+
+Reference
+==============
+- [OMMX-Python-MIP-Adapter API Reference](https://jij-inc.github.io/ommx-python-mip-adapter/index.html)

ommx_python_mip_adapter-0.1.1/README.md

@@ -0,0 +1,100 @@
+OMMX adaptor for Python-MIP
+============================
+![PyPI - Version](https://img.shields.io/pypi/v/ommx-python-mip-adapter)
+
+This package provides an adaptor for the [Python-MIP](https://www.python-mip.com/) from/to [OMMX](https://github.com/Jij-Inc/ommx)
+
+Python-MIP as a solver in OMMX toolchain
+-----------------------------------------
+```mermaid
+sequenceDiagram
+    participant U as User
+    participant A as Adapter
+    participant P as Python-MIP
+    U->>A: ommx.v1.Instance
+    A->>U: Python-MIP model
+    U->>P: Python-MIP model and Parameters for Python-MIP;
+    P->>P: Solve with CBC, Gurobi, or other solvers
+    P->>U: Optimized model
+    U->>A: Optimized model and ommx.v1.Instance
+    A->>U: ommx:SolutionList
+```
+
+Python-MIP as a user interface to create OMMX instance
+-------------------------------------------------------
+```mermaid
+sequenceDiagram
+    participant U as User
+    participant A as Adapter
+    participant O as Other OMMX toolchain
+    U->>A: Python-MIP model
+    A->>U: ommx.v1.Instance
+    U->>O: ommx.v1.Instance and Parameters for other solver
+    O->>O: Solve the instance with other solver using other adapter
+    O->>U: ommx.v1.Solution
+```
+
+Usage
+======
+`ommx-python-mip-adapter` can be installed from PyPI as follows:
+
+```bash
+pip install ommx-python-mip-adapter
+```
+
+Python-MIP can be used through `ommx-python-mip-adapter` by using the following:
+
+```python markdown-code-runner
+import ommx_python_mip_adapter as adapter
+from ommx.v1.decision_variables_pb2 import DecisionVariable, Bound
+from ommx.v1.instance_pb2 import Instance
+from ommx.v1.function_pb2 import Function
+from ommx.v1.linear_pb2 import Linear
+from ommx.v1.solution_pb2 import SolutionList
+
+ommx_instance = Instance(
+    decision_variables=[
+        DecisionVariable(
+            id=1,
+            kind=DecisionVariable.KIND_INTEGER,
+            bound=Bound(lower=0, upper=5),
+        ),
+    ],
+    objective=Function(
+        linear=Linear(
+            terms=[Linear.Term(id=1, coefficient=1)]
+        ),
+    ),
+)
+ommx_instance_bytes = ommx_instance.SerializeToString()
+
+# Convert from `ommx.v1.Instance` to `mip.Model`
+model = adapter.instance_to_model(ommx_instance_bytes)
+model.optimize()
+# Create `ommx.v1.SolutionList` from Optimized `mip.Model`
+ommx_solutions_bytes = adapter.model_to_solution(
+    model, ommx_instance_bytes
+)
+
+print(SolutionList.FromString(ommx_solutions_bytes))
+```
+You can get `ommx.v1.Instance` from a Python-MIP model as the following:
+```python markdown-code-runner
+import mip
+import ommx_python_mip_adapter as adapter
+from ommx.v1.instance_pb2 import Instance
+
+model = mip.Model()
+x1=model.add_var(name="1", var_type=mip.INTEGER, lb=0, ub=5)
+x2=model.add_var(name="2", var_type=mip.CONTINUOUS, lb=0, ub=5)
+model.objective = - x1 - 2 * x2
+model.add_constr(x1 + x2 - 6 <= 0)
+
+ommx_instance_bytes = adapter.model_to_instance(model)
+
+print(Instance.FromString(ommx_instance_bytes))
+```
+
+Reference
+==============
+- [OMMX-Python-MIP-Adapter API Reference](https://jij-inc.github.io/ommx-python-mip-adapter/index.html)

ommx_python_mip_adapter-0.1.1/docs/source/conf.py

@@ -0,0 +1,50 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+import sphinx_rtd_theme
+import sphinx_fontawesome
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'ommx-python-mip-adapter'
+copyright = '2024, Jij Inc.'
+author = 'Jij Inc.'
+
+version = '0.1.0'
+release = '0.1.0'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'sphinx.ext.autodoc', 
+    'sphinx.ext.napoleon', 
+    'sphinx_rtd_theme', 
+    'sphinx_fontawesome', 
+    'autoapi.extension',
+]
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.md': 'markdown',
+}
+
+templates_path = ['_templates']
+language = 'en'
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "sphinx_rtd_theme"
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+html_show_sourcelink = False
+html_static_path = ['_static']
+
+# -- AutoAPI settings --------------------------------------------------------
+# https://sphinx-autoapi.readthedocs.io/en/latest/reference/config.html#event-autoapi-skip-member
+
+autoapi_dirs = ['../../ommx_python_mip_adapter']
+autoapi_member_order = 'groupwise'

ommx_python_mip_adapter-0.1.1/docs/source/index.rst

@@ -0,0 +1,20 @@
+.. ommx-python-mip-adapter documentation master file, created by
+   sphinx-quickstart on Mon Apr 22 14:29:19 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to ommx-python-mip-adapter's documentation!
+===================================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

ommx_python_mip_adapter-0.1.1/ommx_python_mip_adapter/__init__.py

@@ -0,0 +1,11 @@
+from ommx_python_mip_adapter.adapter import (
+    instance_to_model,
+    model_to_instance,
+    model_to_solution,
+)
+
+__all__ = [
+    "instance_to_model",
+    "model_to_instance",
+    "model_to_solution",
+]

{ommx_python_mip_adapter-0.0.2 → ommx_python_mip_adapter-0.1.1}/ommx_python_mip_adapter/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.0.2'
-__version_tuple__ = version_tuple = (0, 0, 2)
+__version__ = version = '0.1.1'
+__version_tuple__ = version_tuple = (0, 1, 1)