Read the Docs build information Build id: 3914046 Project: jij-inc-ommx Version: 782 Commit: 22d5645ce0d2546d0c239417aa4ea92d5f020067 Date: 2026-04-10T08:23:19.158145Z State: finished Success: True [rtd-command-info] start-time: 2026-04-10T08:23:19.875195Z, end-time: 2026-04-10T08:23:20.516574Z, duration: 0, exit-code: 0 git clone --depth 1 https://github.com/Jij-Inc/ommx.git . Cloning into '.'... [rtd-command-info] start-time: 2026-04-10T08:23:20.595512Z, end-time: 2026-04-10T08:23:21.721596Z, duration: 1, exit-code: 0 git fetch origin --force --prune --prune-tags --depth 50 pull/782/head:external-782 From https://github.com/Jij-Inc/ommx * [new ref] refs/pull/782/head -> external-782 * [new tag] python-2.4.0 -> python-2.4.0 * [new tag] python-2.5.0 -> python-2.5.0 * [new tag] python-2.5.1 -> python-2.5.1 * [new tag] rust-2.3.1 -> rust-2.3.1 * [new tag] rust-2.4.0 -> rust-2.4.0 * [new tag] rust-2.5.0 -> rust-2.5.0 * [new tag] rust-2.5.1 -> rust-2.5.1 [rtd-command-info] start-time: 2026-04-10T08:23:22.506741Z, end-time: 2026-04-10T08:23:22.582317Z, duration: 0, exit-code: 0 git checkout --force 22d5645ce0d2546d0c239417aa4ea92d5f020067 Note: switching to '22d5645ce0d2546d0c239417aa4ea92d5f020067'. You are in 'detached HEAD' state. You can look around, make experimental changes and commit them, and you can discard any commits you make in this state without impacting any branches by switching back to a branch. If you want to create a new branch to retain commits you create, you may do so (now or later) by using -c with the switch command. Example: git switch -c Or undo this operation with: git switch - Turn off this advice by setting config variable advice.detachedHead to false HEAD is now at 22d5645 fix: Make Rust docstrings MyST-compatible for API reference (#781) [rtd-command-info] start-time: 2026-04-10T08:23:22.672669Z, end-time: 2026-04-10T08:23:22.705912Z, duration: 0, exit-code: 0 cat .readthedocs.yaml # .readthedocs.yaml # Read the Docs configuration file # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details # Required version: 2 # Set the OS, Python version and other tools you might need build: os: ubuntu-24.04 tools: python: "3.12" # You can also specify other tool versions: # nodejs: "23" # rust: "1.82" # golang: "1.23" # Build documentation in the "docs/" directory with Sphinx sphinx: configuration: docs/api_reference/conf.py # Optionally build your docs in additional formats such as PDF and ePub # formats: # - pdf # - epub # Optional but recommended, declare the Python requirements required # to build your documentation # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html python: install: - requirements: docs/api_reference/requirements.txt [rtd-command-info] start-time: 2026-04-10T08:23:29.760363Z, end-time: 2026-04-10T08:23:29.943076Z, duration: 0, exit-code: 0 asdf global python 3.12.10 [rtd-command-info] start-time: 2026-04-10T08:23:30.489045Z, end-time: 2026-04-10T08:23:31.200753Z, duration: 0, exit-code: 0 python -mvirtualenv $READTHEDOCS_VIRTUALENV_PATH created virtual environment CPython3.12.10.final.0-64 in 283ms creator CPython3Posix(dest=/home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/envs/782, clear=False, no_vcs_ignore=False, global=False) seeder FromAppData(download=False, pip=bundle, setuptools=bundle, wheel=bundle, via=copy, app_data_dir=/home/docs/.local/share/virtualenv) added seed packages: pip==23.1, setuptools==67.6.1, wheel==0.40.0 activators BashActivator,CShellActivator,FishActivator,NushellActivator,PowerShellActivator,PythonActivator [rtd-command-info] start-time: 2026-04-10T08:23:31.287058Z, end-time: 2026-04-10T08:23:35.394561Z, duration: 4, exit-code: 0 python -m pip install --upgrade --no-cache-dir pip setuptools Requirement already satisfied: pip in /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/envs/782/lib/python3.12/site-packages (23.1) Collecting pip Downloading pip-26.0.1-py3-none-any.whl (1.8 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.8/1.8 MB 29.1 MB/s eta 0:00:00 Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/envs/782/lib/python3.12/site-packages (67.6.1) Collecting setuptools Downloading setuptools-82.0.1-py3-none-any.whl (1.0 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.0/1.0 MB 130.8 MB/s eta 0:00:00 Installing collected packages: setuptools, pip Attempting uninstall: setuptools Found existing installation: setuptools 67.6.1 Uninstalling setuptools-67.6.1: Successfully uninstalled setuptools-67.6.1 Attempting uninstall: pip Found existing installation: pip 23.1 Uninstalling pip-23.1: Successfully uninstalled pip-23.1 Successfully installed pip-26.0.1 setuptools-82.0.1 [rtd-command-info] start-time: 2026-04-10T08:23:35.477063Z, end-time: 2026-04-10T08:23:40.097269Z, duration: 4, exit-code: 0 python -m pip install --upgrade --no-cache-dir sphinx Collecting sphinx Downloading sphinx-9.1.0-py3-none-any.whl.metadata (5.8 kB) Collecting sphinxcontrib-applehelp>=1.0.7 (from sphinx) Downloading sphinxcontrib_applehelp-2.0.0-py3-none-any.whl.metadata (2.3 kB) Collecting sphinxcontrib-devhelp>=1.0.6 (from sphinx) Downloading sphinxcontrib_devhelp-2.0.0-py3-none-any.whl.metadata (2.3 kB) Collecting sphinxcontrib-htmlhelp>=2.0.6 (from sphinx) Downloading sphinxcontrib_htmlhelp-2.1.0-py3-none-any.whl.metadata (2.3 kB) Collecting sphinxcontrib-jsmath>=1.0.1 (from sphinx) Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl.metadata (1.4 kB) Collecting sphinxcontrib-qthelp>=1.0.6 (from sphinx) Downloading sphinxcontrib_qthelp-2.0.0-py3-none-any.whl.metadata (2.3 kB) Collecting sphinxcontrib-serializinghtml>=1.1.9 (from sphinx) Downloading sphinxcontrib_serializinghtml-2.0.0-py3-none-any.whl.metadata (2.4 kB) Collecting Jinja2>=3.1 (from sphinx) Downloading jinja2-3.1.6-py3-none-any.whl.metadata (2.9 kB) Collecting Pygments>=2.17 (from sphinx) Downloading pygments-2.20.0-py3-none-any.whl.metadata (2.5 kB) Collecting docutils<0.23,>=0.21 (from sphinx) Downloading docutils-0.22.4-py3-none-any.whl.metadata (15 kB) Collecting snowballstemmer>=2.2 (from sphinx) Downloading snowballstemmer-3.0.1-py3-none-any.whl.metadata (7.9 kB) Collecting babel>=2.13 (from sphinx) Downloading babel-2.18.0-py3-none-any.whl.metadata (2.2 kB) Collecting alabaster>=0.7.14 (from sphinx) Downloading alabaster-1.0.0-py3-none-any.whl.metadata (2.8 kB) Collecting imagesize>=1.3 (from sphinx) Downloading imagesize-2.0.0-py2.py3-none-any.whl.metadata (1.5 kB) Collecting requests>=2.30.0 (from sphinx) Downloading requests-2.33.1-py3-none-any.whl.metadata (4.8 kB) Collecting roman-numerals>=1.0.0 (from sphinx) Downloading roman_numerals-4.1.0-py3-none-any.whl.metadata (3.3 kB) Collecting packaging>=23.0 (from sphinx) Downloading packaging-26.0-py3-none-any.whl.metadata (3.3 kB) Collecting MarkupSafe>=2.0 (from Jinja2>=3.1->sphinx) Downloading markupsafe-3.0.3-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl.metadata (2.7 kB) Collecting charset_normalizer<4,>=2 (from requests>=2.30.0->sphinx) Downloading charset_normalizer-3.4.7-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl.metadata (40 kB) Collecting idna<4,>=2.5 (from requests>=2.30.0->sphinx) Downloading idna-3.11-py3-none-any.whl.metadata (8.4 kB) Collecting urllib3<3,>=1.26 (from requests>=2.30.0->sphinx) Downloading urllib3-2.6.3-py3-none-any.whl.metadata (6.9 kB) Collecting certifi>=2023.5.7 (from requests>=2.30.0->sphinx) Downloading certifi-2026.2.25-py3-none-any.whl.metadata (2.5 kB) Downloading sphinx-9.1.0-py3-none-any.whl (3.9 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.9/3.9 MB 76.3 MB/s 0:00:00 Downloading docutils-0.22.4-py3-none-any.whl (633 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 633.2/633.2 kB 954.1 MB/s 0:00:00 Downloading alabaster-1.0.0-py3-none-any.whl (13 kB) Downloading babel-2.18.0-py3-none-any.whl (10.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 10.2/10.2 MB 341.3 MB/s 0:00:00 Downloading imagesize-2.0.0-py2.py3-none-any.whl (9.4 kB) Downloading jinja2-3.1.6-py3-none-any.whl (134 kB) Downloading markupsafe-3.0.3-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl (22 kB) Downloading packaging-26.0-py3-none-any.whl (74 kB) Downloading pygments-2.20.0-py3-none-any.whl (1.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.2/1.2 MB 1.1 GB/s 0:00:00 Downloading requests-2.33.1-py3-none-any.whl (64 kB) Downloading charset_normalizer-3.4.7-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl (216 kB) Downloading idna-3.11-py3-none-any.whl (71 kB) Downloading urllib3-2.6.3-py3-none-any.whl (131 kB) Downloading certifi-2026.2.25-py3-none-any.whl (153 kB) Downloading roman_numerals-4.1.0-py3-none-any.whl (7.7 kB) Downloading snowballstemmer-3.0.1-py3-none-any.whl (103 kB) Downloading sphinxcontrib_applehelp-2.0.0-py3-none-any.whl (119 kB) Downloading sphinxcontrib_devhelp-2.0.0-py3-none-any.whl (82 kB) Downloading sphinxcontrib_htmlhelp-2.1.0-py3-none-any.whl (98 kB) Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB) Downloading sphinxcontrib_qthelp-2.0.0-py3-none-any.whl (88 kB) Downloading sphinxcontrib_serializinghtml-2.0.0-py3-none-any.whl (92 kB) Installing collected packages: urllib3, sphinxcontrib-serializinghtml, sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, snowballstemmer, roman-numerals, Pygments, packaging, MarkupSafe, imagesize, idna, docutils, charset_normalizer, certifi, babel, alabaster, requests, Jinja2, sphinx Successfully installed Jinja2-3.1.6 MarkupSafe-3.0.3 Pygments-2.20.0 alabaster-1.0.0 babel-2.18.0 certifi-2026.2.25 charset_normalizer-3.4.7 docutils-0.22.4 idna-3.11 imagesize-2.0.0 packaging-26.0 requests-2.33.1 roman-numerals-4.1.0 snowballstemmer-3.0.1 sphinx-9.1.0 sphinxcontrib-applehelp-2.0.0 sphinxcontrib-devhelp-2.0.0 sphinxcontrib-htmlhelp-2.1.0 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-2.0.0 sphinxcontrib-serializinghtml-2.0.0 urllib3-2.6.3 [rtd-command-info] start-time: 2026-04-10T08:23:40.177616Z, end-time: 2026-04-10T08:23:44.700371Z, duration: 4, exit-code: 0 python -m pip install --exists-action=w --no-cache-dir -r docs/api_reference/requirements.txt Ignoring colorama: markers 'sys_platform == "win32"' don't match your environment Requirement already satisfied: alabaster==1.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/envs/782/lib/python3.12/site-packages (from -r docs/api_reference/requirements.txt (line 3)) (1.0.0) Collecting astroid==4.1.2 (from -r docs/api_reference/requirements.txt (line 7)) Downloading astroid-4.1.2-py3-none-any.whl (279 kB) Requirement already satisfied: babel==2.18.0 in /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/envs/782/lib/python3.12/site-packages (from -r docs/api_reference/requirements.txt (line 11)) (2.18.0) Requirement already satisfied: certifi==2026.2.25 in /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/envs/782/lib/python3.12/site-packages (from -r docs/api_reference/requirements.txt (line 15)) (2026.2.25) Collecting charset-normalizer==3.4.6 (from -r docs/api_reference/requirements.txt (line 19)) Downloading charset_normalizer-3.4.6-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl (207 kB) Requirement already satisfied: docutils==0.22.4 in /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/envs/782/lib/python3.12/site-packages (from -r docs/api_reference/requirements.txt (line 59)) (0.22.4) Requirement already satisfied: idna==3.11 in /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/envs/782/lib/python3.12/site-packages (from -r docs/api_reference/requirements.txt (line 66)) (3.11) Requirement already satisfied: imagesize==2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/envs/782/lib/python3.12/site-packages (from -r docs/api_reference/requirements.txt (line 70)) (2.0.0) Requirement already satisfied: jinja2==3.1.6 in /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/envs/782/lib/python3.12/site-packages (from -r docs/api_reference/requirements.txt (line 74)) (3.1.6) Collecting markdown-it-py==4.0.0 (from -r docs/api_reference/requirements.txt (line 81)) Downloading markdown_it_py-4.0.0-py3-none-any.whl (87 kB) Requirement already satisfied: markupsafe==3.0.3 in /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/envs/782/lib/python3.12/site-packages (from -r docs/api_reference/requirements.txt (line 87)) (3.0.3) Collecting mdit-py-plugins==0.5.0 (from -r docs/api_reference/requirements.txt (line 123)) Downloading mdit_py_plugins-0.5.0-py3-none-any.whl (57 kB) Collecting mdurl==0.1.2 (from -r docs/api_reference/requirements.txt (line 127)) Downloading mdurl-0.1.2-py3-none-any.whl (10.0 kB) Collecting myst-parser==5.0.0 (from -r docs/api_reference/requirements.txt (line 131)) Downloading myst_parser-5.0.0-py3-none-any.whl (84 kB) Requirement already satisfied: packaging==26.0 in /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/envs/782/lib/python3.12/site-packages (from -r docs/api_reference/requirements.txt (line 135)) (26.0) Requirement already satisfied: pygments==2.20.0 in /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/envs/782/lib/python3.12/site-packages (from -r docs/api_reference/requirements.txt (line 139)) (2.20.0) Collecting pyyaml==6.0.3 (from -r docs/api_reference/requirements.txt (line 143)) Downloading pyyaml-6.0.3-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl (807 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 807.9/807.9 kB 18.2 MB/s 0:00:00 Collecting requests==2.33.0 (from -r docs/api_reference/requirements.txt (line 168)) Downloading requests-2.33.0-py3-none-any.whl (65 kB) Requirement already satisfied: roman-numerals==4.1.0 in /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/envs/782/lib/python3.12/site-packages (from -r docs/api_reference/requirements.txt (line 172)) (4.1.0) Requirement already satisfied: snowballstemmer==3.0.1 in /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/envs/782/lib/python3.12/site-packages (from -r docs/api_reference/requirements.txt (line 176)) (3.0.1) Requirement already satisfied: sphinx==9.1.0 in /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/envs/782/lib/python3.12/site-packages (from -r docs/api_reference/requirements.txt (line 180)) (9.1.0) Collecting sphinx-autoapi==3.8.0 (from -r docs/api_reference/requirements.txt (line 190)) Downloading sphinx_autoapi-3.8.0-py3-none-any.whl (35 kB) Collecting sphinx-fontawesome==0.0.6 (from -r docs/api_reference/requirements.txt (line 194)) Downloading sphinx_fontawesome-0.0.6.tar.gz (22 kB) Installing build dependencies: started Installing build dependencies: finished with status 'done' Getting requirements to build wheel: started Getting requirements to build wheel: finished with status 'done' Preparing metadata (pyproject.toml): started Preparing metadata (pyproject.toml): finished with status 'done' Collecting sphinx-rtd-theme==3.1.0 (from -r docs/api_reference/requirements.txt (line 197)) Downloading sphinx_rtd_theme-3.1.0-py2.py3-none-any.whl (7.7 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 7.7/7.7 MB 44.8 MB/s 0:00:00 Requirement already satisfied: sphinxcontrib-applehelp==2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/envs/782/lib/python3.12/site-packages (from -r docs/api_reference/requirements.txt (line 201)) (2.0.0) Requirement already satisfied: sphinxcontrib-devhelp==2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/envs/782/lib/python3.12/site-packages (from -r docs/api_reference/requirements.txt (line 205)) (2.0.0) Requirement already satisfied: sphinxcontrib-htmlhelp==2.1.0 in /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/envs/782/lib/python3.12/site-packages (from -r docs/api_reference/requirements.txt (line 209)) (2.1.0) Collecting sphinxcontrib-jquery==4.1 (from -r docs/api_reference/requirements.txt (line 213)) Downloading sphinxcontrib_jquery-4.1-py2.py3-none-any.whl (121 kB) Requirement already satisfied: sphinxcontrib-jsmath==1.0.1 in /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/envs/782/lib/python3.12/site-packages (from -r docs/api_reference/requirements.txt (line 217)) (1.0.1) Requirement already satisfied: sphinxcontrib-qthelp==2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/envs/782/lib/python3.12/site-packages (from -r docs/api_reference/requirements.txt (line 221)) (2.0.0) Requirement already satisfied: sphinxcontrib-serializinghtml==2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/envs/782/lib/python3.12/site-packages (from -r docs/api_reference/requirements.txt (line 225)) (2.0.0) Collecting tomlkit==0.14.0 (from -r docs/api_reference/requirements.txt (line 229)) Downloading tomlkit-0.14.0-py3-none-any.whl (39 kB) Requirement already satisfied: urllib3==2.6.3 in /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/envs/782/lib/python3.12/site-packages (from -r docs/api_reference/requirements.txt (line 233)) (2.6.3) Building wheels for collected packages: sphinx-fontawesome Building wheel for sphinx-fontawesome (pyproject.toml): started Building wheel for sphinx-fontawesome (pyproject.toml): finished with status 'done' Created wheel for sphinx-fontawesome: filename=sphinx_fontawesome-0.0.6-py3-none-any.whl size=22697 sha256=1aee5dba32939dab8142e663a5182b5d028f7a252f8e8ee23d8395df7801b921 Stored in directory: /tmp/pip-ephem-wheel-cache-3rijwax7/wheels/f0/ad/51/d5b6217ecfa1ed23fa88f0bdf71267b502e69a26bd8c6bc1e5 Successfully built sphinx-fontawesome Installing collected packages: tomlkit, pyyaml, mdurl, charset-normalizer, astroid, requests, markdown-it-py, mdit-py-plugins, sphinxcontrib-jquery, sphinx-fontawesome, sphinx-autoapi, myst-parser, sphinx-rtd-theme Attempting uninstall: charset-normalizer Found existing installation: charset-normalizer 3.4.7 Uninstalling charset-normalizer-3.4.7: Successfully uninstalled charset-normalizer-3.4.7 Attempting uninstall: requests Found existing installation: requests 2.33.1 Uninstalling requests-2.33.1: Successfully uninstalled requests-2.33.1 Successfully installed astroid-4.1.2 charset-normalizer-3.4.6 markdown-it-py-4.0.0 mdit-py-plugins-0.5.0 mdurl-0.1.2 myst-parser-5.0.0 pyyaml-6.0.3 requests-2.33.0 sphinx-autoapi-3.8.0 sphinx-fontawesome-0.0.6 sphinx-rtd-theme-3.1.0 sphinxcontrib-jquery-4.1 tomlkit-0.14.0 [rtd-command-info] start-time: 2026-04-10T08:23:44.847891Z, end-time: 2026-04-10T08:23:44.884166Z, duration: 0, exit-code: 0 cat docs/api_reference/conf.py import sys from pathlib import Path import sphinx_rtd_theme import tomlkit # -- Path setup -------------------------------------------------------------- here = Path(__file__).parent python_root = here.parent.parent / "python" # ${REPO_ROOT}/python # Add the API docs directory to Python path for pyo3_stub_gen_ext sys.path.insert(0, str(here / "api")) # -- Project information ----------------------------------------------------- project = "OMMX Python SDK" copyright = "2024, Jij Inc." author = "Jij Inc." pyproject_toml = tomlkit.loads((python_root / "ommx" / "pyproject.toml").read_text()) version = str(pyproject_toml["project"]["version"]) # type: ignore release = version # -- General configuration --------------------------------------------------- extensions = [ "sphinx.ext.autodoc", "sphinx.ext.intersphinx", "sphinx_rtd_theme", "sphinx_fontawesome", "myst_parser", "autoapi.extension", "pyo3_stub_gen_ext", ] source_suffix = { ".rst": "restructuredtext", ".md": "markdown", } myst_enable_extensions = ["dollarmath"] templates_path = ["_templates"] language = "en" exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] # -- 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 = [] # Display class names only, without module prefix add_module_names = False python_use_unqualified_type_names = True # -- AutoAPI settings (adapters only) ---------------------------------------- autoapi_dirs = [ python_root / "ommx-python-mip-adapter", python_root / "ommx-pyscipopt-adapter", python_root / "ommx-highs-adapter", python_root / "ommx-openjij-adapter", ] autoapi_options = [ "members", "inherited-members", "undoc-members", "show-module-summary", ] autoapi_member_order = "groupwise" autoapi_file_patterns = ["*.pyi", "*.py"] autoapi_ignore = ["**/tests/**", "**/conftest.py"] autoapi_add_toctree_entry = False # -- Intersphinx Configuration ----------------------------------------------- intersphinx_mapping = { "python": ("https://docs.python.org/3", None), "numpy": ("https://numpy.org/doc/stable", None), "pandas": ("https://pandas.pydata.org/docs", None), } [rtd-command-info] start-time: 2026-04-10T08:23:44.969015Z, end-time: 2026-04-10T08:24:07.210865Z, duration: 22, exit-code: 0 python -m sphinx -T -j auto -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html Running Sphinx v9.1.0 WARNING: Calling get_html_theme_path is deprecated. If you are calling it to define html_theme_path, you are safe to remove that code. loading translations [en]... done loading intersphinx inventory 'python' from https://docs.python.org/3/objects.inv ... loading intersphinx inventory 'numpy' from https://numpy.org/doc/stable/objects.inv ... loading intersphinx inventory 'pandas' from https://pandas.pydata.org/docs/objects.inv ... myst v5.0.0: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions={'dollarmath'}, disable_syntax=[], all_links_external=False, links_external_new_tab=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, fence_as_directive=set(), number_code_blocks=[], title_to_header=False, heading_anchors=0, heading_slug_func=None, html_meta={}, footnote_sort=True, footnote_transition=True, words_per_minute=200, substitutions={}, linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True, dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True, mathjax_classes='tex2jax_process|mathjax_process|math|output_area', enable_checkboxes=False, suppress_warnings=[], highlight_code_blocks=True) [AutoAPI] Ignoring file: /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-python-mip-adapter/tests/test_integration.py [AutoAPI] Ignoring file: /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-python-mip-adapter/tests/test_model_to_instance.py [AutoAPI] Ignoring file: /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-python-mip-adapter/tests/conftest.py [AutoAPI] Ignoring file: /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-python-mip-adapter/tests/test_adapter.py [AutoAPI] Ignoring file: /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-python-mip-adapter/tests/test_constant_constraint.py [AutoAPI] Ignoring file: /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-pyscipopt-adapter/tests/test_ommx_pyscipopt.py [AutoAPI] Ignoring file: /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-pyscipopt-adapter/tests/test_integration.py [AutoAPI] Ignoring file: /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-pyscipopt-adapter/tests/test_sos1_working.py [AutoAPI] Ignoring file: /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-pyscipopt-adapter/tests/test_initial_state.py [AutoAPI] Ignoring file: /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-pyscipopt-adapter/tests/test_sos1_partial_evaluate.py [AutoAPI] Ignoring file: /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-pyscipopt-adapter/tests/test_error.py [AutoAPI] Ignoring file: /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-highs-adapter/tests/test_error.py [AutoAPI] Ignoring file: /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-highs-adapter/tests/test_adapter.py [AutoAPI] Ignoring file: /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-openjij-adapter/tests/test_sample.py [AutoAPI] Reading files... [ 9%] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-python-mip-adapter/ommx_python_mip_adapter/exception.py [AutoAPI] Reading files... [ 18%] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-python-mip-adapter/ommx_python_mip_adapter/adapter.py [AutoAPI] Reading files... [ 27%] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-python-mip-adapter/ommx_python_mip_adapter/python_mip_to_ommx.py [AutoAPI] Reading files... [ 36%] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-python-mip-adapter/ommx_python_mip_adapter/__init__.py [AutoAPI] Reading files... [ 45%] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-pyscipopt-adapter/ommx_pyscipopt_adapter/exception.py [AutoAPI] Reading files... [ 55%] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-pyscipopt-adapter/ommx_pyscipopt_adapter/adapter.py [AutoAPI] Reading files... [ 64%] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-pyscipopt-adapter/ommx_pyscipopt_adapter/__init__.py [AutoAPI] Reading files... [ 73%] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-highs-adapter/ommx_highs_adapter/exception.py [AutoAPI] Reading files... [ 82%] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-highs-adapter/ommx_highs_adapter/adapter.py [AutoAPI] Reading files... [ 91%] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-highs-adapter/ommx_highs_adapter/__init__.py [AutoAPI] Reading files... [100%] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-openjij-adapter/ommx_openjij_adapter/__init__.py [AutoAPI] Mapping Data... [ 9%] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-python-mip-adapter/ommx_python_mip_adapter/exception.py [AutoAPI] Mapping Data... [ 18%] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-python-mip-adapter/ommx_python_mip_adapter/adapter.py [AutoAPI] Mapping Data... [ 27%] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-python-mip-adapter/ommx_python_mip_adapter/python_mip_to_ommx.py [AutoAPI] Mapping Data... [ 36%] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-python-mip-adapter/ommx_python_mip_adapter/__init__.py [AutoAPI] Mapping Data... [ 45%] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-pyscipopt-adapter/ommx_pyscipopt_adapter/exception.py [AutoAPI] Mapping Data... [ 55%] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-pyscipopt-adapter/ommx_pyscipopt_adapter/adapter.py [AutoAPI] Mapping Data... [ 64%] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-pyscipopt-adapter/ommx_pyscipopt_adapter/__init__.py [AutoAPI] Mapping Data... [ 73%] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-highs-adapter/ommx_highs_adapter/exception.py [AutoAPI] Mapping Data... [ 82%] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-highs-adapter/ommx_highs_adapter/adapter.py [AutoAPI] Mapping Data... [ 91%] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-highs-adapter/ommx_highs_adapter/__init__.py [AutoAPI] Mapping Data... [100%] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/python/ommx-openjij-adapter/ommx_openjij_adapter/__init__.py [AutoAPI] Rendering Data... [ 9%] ommx_highs_adapter [AutoAPI] Rendering Data... [ 18%] ommx_openjij_adapter [AutoAPI] Rendering Data... [ 27%] ommx_pyscipopt_adapter [AutoAPI] Rendering Data... [ 36%] ommx_python_mip_adapter [AutoAPI] Rendering Data... [ 45%] ommx_highs_adapter.adapter [AutoAPI] Rendering Data... [ 55%] ommx_highs_adapter.exception [AutoAPI] Rendering Data... [ 64%] ommx_pyscipopt_adapter.adapter [AutoAPI] Rendering Data... [ 73%] ommx_python_mip_adapter.adapter [AutoAPI] Rendering Data... [ 82%] ommx_pyscipopt_adapter.exception [AutoAPI] Rendering Data... [ 91%] ommx_python_mip_adapter.exception [AutoAPI] Rendering Data... [100%] ommx_python_mip_adapter.python_mip_to_ommx [autosummary] generating autosummary for: api/_items/ommx.artifact.Artifact.rst, api/_items/ommx.artifact.ArtifactBuilder.rst, api/_items/ommx.artifact.Descriptor.rst, api/_items/ommx.artifact.get_image_dir.rst, api/_items/ommx.artifact.get_images.rst, api/_items/ommx.artifact.get_local_registry_root.rst, api/_items/ommx.artifact.set_local_registry_root.rst, api/_items/ommx.v1.Bound.rst, api/_items/ommx.v1.Constraint.rst, api/_items/ommx.v1.ConstraintHints.rst, ..., api/_items/ommx.v1.Sense.rst, api/_items/ommx.v1.Solution.rst, api/_items/ommx.v1.Sos1.rst, api/_items/ommx.v1.State.rst, api/_items/ommx.v1.ToSamples.rst, api/_items/ommx.v1.ToState.rst, api/index.rst, api/ommx.artifact.rst, api/ommx.v1.rst, index.rst building [mo]: targets for 0 po files that are out of date writing output... building [html]: targets for 45 source files that are out of date updating environment: [new config] 56 added, 0 changed, 0 removed reading sources... [ 2%] api/_items/ommx.artifact.Artifact reading sources... [ 4%] api/_items/ommx.artifact.ArtifactBuilder reading sources... [ 5%] api/_items/ommx.artifact.Descriptor reading sources... [ 7%] api/_items/ommx.artifact.get_image_dir reading sources... [ 9%] api/_items/ommx.artifact.get_images reading sources... [ 11%] api/_items/ommx.artifact.get_local_registry_root reading sources... [ 12%] api/_items/ommx.artifact.set_local_registry_root reading sources... [ 14%] api/_items/ommx.v1.Bound reading sources... [ 16%] api/_items/ommx.v1.Constraint reading sources... [ 18%] api/_items/ommx.v1.ConstraintHints reading sources... [ 20%] api/_items/ommx.v1.DecisionVariable reading sources... [ 21%] api/_items/ommx.v1.DecisionVariableAnalysis reading sources... [ 23%] api/_items/ommx.v1.Equality reading sources... [ 25%] api/_items/ommx.v1.EvaluatedConstraint reading sources... [ 27%] api/_items/ommx.v1.EvaluatedDecisionVariable reading sources... [ 29%] api/_items/ommx.v1.EvaluatedNamedFunction reading sources... [ 30%] api/_items/ommx.v1.Function reading sources... [ 32%] api/_items/ommx.v1.Instance reading sources... [ 34%] api/_items/ommx.v1.Kind reading sources... [ 36%] api/_items/ommx.v1.Linear reading sources... [ 38%] api/_items/ommx.v1.NamedFunction reading sources... [ 39%] api/_items/ommx.v1.OneHot reading sources... [ 41%] api/_items/ommx.v1.Optimality reading sources... [ 43%] api/_items/ommx.v1.Parameter reading sources... [ 45%] api/_items/ommx.v1.ParametricInstance reading sources... [ 46%] api/_items/ommx.v1.Polynomial reading sources... [ 48%] api/_items/ommx.v1.Quadratic reading sources... [ 50%] api/_items/ommx.v1.Relaxation reading sources... [ 52%] api/_items/ommx.v1.RemovedConstraint reading sources... [ 54%] api/_items/ommx.v1.Rng reading sources... [ 55%] api/_items/ommx.v1.SampleSet reading sources... [ 57%] api/_items/ommx.v1.SampledConstraint reading sources... [ 59%] api/_items/ommx.v1.SampledDecisionVariable reading sources... [ 61%] api/_items/ommx.v1.SampledNamedFunction reading sources... [ 62%] api/_items/ommx.v1.Samples reading sources... [ 64%] api/_items/ommx.v1.Sense reading sources... [ 66%] api/_items/ommx.v1.Solution reading sources... [ 68%] api/_items/ommx.v1.Sos1 reading sources... [ 70%] api/_items/ommx.v1.State reading sources... [ 71%] api/_items/ommx.v1.ToSamples reading sources... [ 73%] api/_items/ommx.v1.ToState reading sources... [ 75%] api/index reading sources... [ 77%] api/ommx.artifact reading sources... [ 79%] api/ommx.v1 reading sources... [ 80%] autoapi/ommx_highs_adapter/adapter/index reading sources... [ 82%] autoapi/ommx_highs_adapter/exception/index reading sources... [ 84%] autoapi/ommx_highs_adapter/index reading sources... [ 86%] autoapi/ommx_openjij_adapter/index reading sources... [ 88%] autoapi/ommx_pyscipopt_adapter/adapter/index reading sources... [ 89%] autoapi/ommx_pyscipopt_adapter/exception/index reading sources... [ 91%] autoapi/ommx_pyscipopt_adapter/index reading sources... [ 93%] autoapi/ommx_python_mip_adapter/adapter/index reading sources... [ 95%] autoapi/ommx_python_mip_adapter/exception/index reading sources... [ 96%] autoapi/ommx_python_mip_adapter/index reading sources... [ 98%] autoapi/ommx_python_mip_adapter/python_mip_to_ommx/index reading sources... [100%] index WARNING: the sphinx_fontawesome extension does not declare if it is safe for parallel reading, assuming it isn't - please ask the extension author to check and make it explicit WARNING: doing serial read /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/docs/api_reference/autoapi/ommx_highs_adapter/adapter/index.rst:42: WARNING: Line block ends without a blank line. [docutils] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/docs/api_reference/autoapi/ommx_highs_adapter/adapter/index.rst:61: WARNING: Line block ends without a blank line. [docutils] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/docs/api_reference/autoapi/ommx_highs_adapter/adapter/index.rst:77: WARNING: Line block ends without a blank line. [docutils] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/docs/api_reference/autoapi/ommx_highs_adapter/adapter/index.rst:102: WARNING: Line block ends without a blank line. [docutils] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/docs/api_reference/autoapi/ommx_highs_adapter/adapter/index.rst:265: ERROR: Unexpected indentation. [docutils] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/docs/api_reference/autoapi/ommx_highs_adapter/adapter/index.rst:266: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/docs/api_reference/autoapi/ommx_highs_adapter/adapter/index.rst:42: ERROR: Undefined substitution referenced: "-----------". [docutils] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/docs/api_reference/autoapi/ommx_highs_adapter/adapter/index.rst:42: ERROR: Undefined substitution referenced: "---------". [docutils] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/docs/api_reference/autoapi/ommx_highs_adapter/adapter/index.rst:61: ERROR: Undefined substitution referenced: "-----------------". [docutils] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/docs/api_reference/autoapi/ommx_highs_adapter/adapter/index.rst:61: ERROR: Undefined substitution referenced: "------------------". [docutils] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/docs/api_reference/autoapi/ommx_highs_adapter/adapter/index.rst:65: ERROR: Undefined substitution referenced: "constant". [docutils] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/docs/api_reference/autoapi/ommx_highs_adapter/adapter/index.rst:65: ERROR: Undefined substitution referenced: "constant". [docutils] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/docs/api_reference/autoapi/ommx_highs_adapter/adapter/index.rst:77: ERROR: Undefined substitution referenced: "----------------". [docutils] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/docs/api_reference/autoapi/ommx_highs_adapter/adapter/index.rst:102: ERROR: Undefined substitution referenced: "--------------". [docutils] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/docs/api_reference/autoapi/ommx_pyscipopt_adapter/adapter/index.rst:46: ERROR: Unknown directive type "doctest". .. doctest:: >>> from ommx_pyscipopt_adapter import OMMXPySCIPOptAdapter >>> from ommx.v1 import Instance, DecisionVariable >>> p = [10, 13, 18, 32, 7, 15] >>> w = [11, 15, 20, 35, 10, 33] >>> x = [DecisionVariable.binary(i) for i in range(6)] >>> instance = Instance.from_components( ... decision_variables=x, ... objective=sum(p[i] * x[i] for i in range(6)), ... constraints=[sum(w[i] * x[i] for i in range(6)) <= 47], ... sense=Instance.MAXIMIZE, ... ) >>> adapter = OMMXPySCIPOptAdapter(instance) >>> model = adapter.solver_input >>> # ... some modification of model's parameters >>> model.optimize() >>> solution = adapter.decode(model) >>> solution.objective 42.0 [docutils] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/docs/api_reference/autoapi/ommx_pyscipopt_adapter/adapter/index.rst:80: ERROR: Unknown directive type "doctest". .. doctest:: The following example shows how to solve an unconstrained linear optimization problem with `x1` as the objective function. >>> from ommx_pyscipopt_adapter import OMMXPySCIPOptAdapter >>> 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, ... ) >>> adapter = OMMXPySCIPOptAdapter(ommx_instance) >>> model = adapter.solver_input >>> model.optimize() >>> ommx_state = adapter.decode_to_state(model) >>> ommx_state.entries {1: 0.0} [docutils] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/docs/api_reference/autoapi/ommx_pyscipopt_adapter/adapter/index.rst:123: ERROR: Unknown directive type "doctest". .. doctest:: >>> from ommx.v1 import Instance, DecisionVariable >>> from ommx.v1 import Solution >>> from ommx_pyscipopt_adapter import OMMXPySCIPOptAdapter >>> p = [10, 13, 18, 32, 7, 15] >>> w = [11, 15, 20, 35, 10, 33] >>> x = [DecisionVariable.binary(i) for i in range(6)] >>> instance = Instance.from_components( ... decision_variables=x, ... objective=sum(p[i] * x[i] for i in range(6)), ... constraints=[(sum(w[i] * x[i] for i in range(6)) <= 47).set_id(0)], ... sense=Instance.MAXIMIZE, ... ) Solve it >>> solution = OMMXPySCIPOptAdapter.solve(instance) Check output >>> sorted([(id, value) for id, value in solution.state.entries.items()]) [(0, 1.0), (1, 0.0), (2, 0.0), (3, 1.0), (4, 0.0), (5, 0.0)] >>> solution.feasible True >>> assert solution.optimality == Solution.OPTIMAL p[0] + p[3] = 42 w[0] + w[3] = 46 <= 47 >>> solution.objective 42.0 >>> solution.get_constraint_value(0) -1.0 [docutils] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/docs/api_reference/autoapi/ommx_pyscipopt_adapter/adapter/index.rst:161: ERROR: Unknown directive type "doctest". .. doctest:: >>> from ommx.v1 import Instance, DecisionVariable >>> from ommx_pyscipopt_adapter import OMMXPySCIPOptAdapter >>> x = DecisionVariable.integer(0, upper=3, lower=0) >>> instance = Instance.from_components( ... decision_variables=[x], ... objective=x, ... constraints=[x >= 4], ... sense=Instance.MAXIMIZE, ... ) >>> OMMXPySCIPOptAdapter.solve(instance) Traceback (most recent call last): ... ommx.adapter.InfeasibleDetected: Model was infeasible [docutils] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/docs/api_reference/autoapi/ommx_pyscipopt_adapter/adapter/index.rst:181: ERROR: Unknown directive type "doctest". .. doctest:: >>> from ommx.v1 import Instance, DecisionVariable >>> from ommx_pyscipopt_adapter import OMMXPySCIPOptAdapter >>> x = DecisionVariable.integer(0, lower=0) >>> instance = Instance.from_components( ... decision_variables=[x], ... objective=x, ... constraints=[], ... sense=Instance.MAXIMIZE, ... ) >>> OMMXPySCIPOptAdapter.solve(instance) Traceback (most recent call last): ... ommx.adapter.UnboundedDetected: Model was unbounded [docutils] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/docs/api_reference/autoapi/ommx_python_mip_adapter/adapter/index.rst:46: ERROR: Unknown directive type "doctest". .. doctest:: >>> from ommx.v1 import Instance, DecisionVariable >>> from ommx_python_mip_adapter import OMMXPythonMIPAdapter >>> p = [10, 13, 18, 32, 7, 15] >>> w = [11, 15, 20, 35, 10, 33] >>> x = [DecisionVariable.binary(i) for i in range(6)] >>> instance = Instance.from_components( ... decision_variables=x, ... objective=sum(p[i] * x[i] for i in range(6)), ... constraints=[sum(w[i] * x[i] for i in range(6)) <= 47], ... sense=Instance.MAXIMIZE, ... ) >>> adapter = OMMXPythonMIPAdapter(instance) >>> model = adapter.solver_input >>> # ... some modification of model's parameters >>> model.optimize() >>> solution = adapter.decode(model) >>> solution.objective 42.0 [docutils] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/docs/api_reference/autoapi/ommx_python_mip_adapter/adapter/index.rst:81: ERROR: Unknown directive type "doctest". .. doctest:: The following example of solving an unconstrained linear optimization problem with x1 as the objective function. >>> from ommx_python_mip_adapter import OMMXPythonMIPAdapter >>> 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, ... ) >>> adapter = OMMXPythonMIPAdapter(ommx_instance) >>> model = adapter.solver_input >>> model.optimize() >>> ommx_state = adapter.decode_to_state(model) >>> ommx_state.entries {1: 0.0} [docutils] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/docs/api_reference/autoapi/ommx_python_mip_adapter/adapter/index.rst:121: ERROR: Unknown directive type "doctest". .. doctest:: >>> from ommx.v1 import Instance, DecisionVariable >>> from ommx_python_mip_adapter import OMMXPythonMIPAdapter >>> p = [10, 13, 18, 32, 7, 15] >>> w = [11, 15, 20, 35, 10, 33] >>> x = [DecisionVariable.binary(i) for i in range(6)] >>> instance = Instance.from_components( ... decision_variables=x, ... objective=sum(p[i] * x[i] for i in range(6)), ... constraints=[(sum(w[i] * x[i] for i in range(6)) <= 47).set_id(0)], ... sense=Instance.MAXIMIZE, ... ) Solve it >>> solution = OMMXPythonMIPAdapter.solve(instance) Check output >>> sorted([(id, value) for id, value in solution.state.entries.items()]) [(0, 1.0), (1, 0.0), (2, 0.0), (3, 1.0), (4, 0.0), (5, 0.0)] >>> solution.feasible True >>> assert solution.optimality == Solution.OPTIMAL p[0] + p[3] = 42 w[0] + w[3] = 46 <= 47 >>> solution.objective 42.0 >>> solution.get_constraint_value(0) -1.0 [docutils] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/docs/api_reference/autoapi/ommx_python_mip_adapter/adapter/index.rst:158: ERROR: Unknown directive type "doctest". .. doctest:: >>> from ommx.v1 import Instance, DecisionVariable >>> from ommx_python_mip_adapter import OMMXPythonMIPAdapter >>> x = DecisionVariable.integer(0, upper=3, lower=0) >>> instance = Instance.from_components( ... decision_variables=[x], ... objective=x, ... constraints=[x >= 4], ... sense=Instance.MAXIMIZE, ... ) >>> OMMXPythonMIPAdapter.solve(instance) Traceback (most recent call last): ... ommx.adapter.InfeasibleDetected: Model was infeasible [docutils] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/docs/api_reference/autoapi/ommx_python_mip_adapter/adapter/index.rst:178: ERROR: Unknown directive type "doctest". .. doctest:: >>> from ommx.v1 import Instance, DecisionVariable >>> from ommx_python_mip_adapter import OMMXPythonMIPAdapter >>> x = DecisionVariable.integer(0, lower=0) >>> instance = Instance.from_components( ... decision_variables=[x], ... objective=x, ... constraints=[], ... sense=Instance.MAXIMIZE, ... ) >>> OMMXPythonMIPAdapter.solve(instance) Traceback (most recent call last): ... ommx.adapter.UnboundedDetected: Model was unbounded [docutils] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/docs/api_reference/autoapi/ommx_python_mip_adapter/adapter/index.rst:198: ERROR: Unknown directive type "doctest". .. doctest:: >>> from ommx.v1 import Instance, DecisionVariable >>> from ommx_python_mip_adapter import OMMXPythonMIPAdapter >>> x = DecisionVariable.continuous(0, lower=0, upper=1) >>> y = DecisionVariable.continuous(1, lower=0, upper=1) >>> instance = Instance.from_components( ... decision_variables=[x, y], ... objective=x + y, ... constraints=[(x + y <= 1).set_id(0)], ... sense=Instance.MAXIMIZE, ... ) >>> solution = OMMXPythonMIPAdapter.solve(instance) >>> solution.get_dual_variable(0) 1.0 [docutils] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/docs/api_reference/autoapi/ommx_python_mip_adapter/python_mip_to_ommx/index.rst:63: ERROR: Unknown directive type "doctest". .. doctest:: >>> import mip >>> import ommx_python_mip_adapter as adapter >>> 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 >>> constr = model.add_constr(x1 + x2 - 6 <= 0) >>> ommx_instance = adapter.model_to_instance(model) [docutils] looking for now-outdated files... none found pickling environment... done checking consistency... /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/docs/api_reference/api/index.rst: WARNING: document isn't included in any toctree [toc.not_included] /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/docs/api_reference/api/ommx.artifact.rst: document is referenced in multiple toctrees: ['api/index', 'index'], selecting: index <- api/ommx.artifact /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/docs/api_reference/api/ommx.v1.rst: document is referenced in multiple toctrees: ['api/index', 'index'], selecting: index <- api/ommx.v1 done preparing documents... done copying assets... copying static files... Writing evaluated template result to /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/_readthedocs/html/_static/basic.css Writing evaluated template result to /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/_readthedocs/html/_static/language_data.js Writing evaluated template result to /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/_readthedocs/html/_static/documentation_options.js Writing evaluated template result to /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/_readthedocs/html/_static/js/versions.js copying static files: done copying extra files... copying extra files: done copying assets: done writing output... [ 20%] api/_items/ommx.artifact.ArtifactBuilder .. api/_items/ommx.v1.EvaluatedConstraint /home/docs/checkouts/readthedocs.org/user_builds/jij-inc-ommx/checkouts/782/docs/api_reference/:9: WARNING: Lexing literal_block '{\n "decision_variables": {\n "total": int,\n "by_kind": {\n "binary": int,\n "integer": int,\n "continuous": int,\n "semi_integer": int,\n "semi_continuous": int\n },\n "by_usage": {\n "used_in_objective": int,\n "used_in_constraints": int,\n "used": int,\n "fixed": int,\n "dependent": int,\n "irrelevant": int\n }\n },\n "constraints": {\n "total": int,\n "active": int,\n "removed": int\n }\n}\n' as "json" resulted in an error at token: 'i'. Retrying in relaxed mode. [misc.highlighting_failure] writing output... [ 40%] api/_items/ommx.v1.EvaluatedDecisionVariable .. api/_items/ommx.v1.Quadratic writing output... [ 60%] api/_items/ommx.v1.Relaxation .. api/_items/ommx.v1.ToSamples writing output... [ 80%] api/_items/ommx.v1.ToState .. autoapi/ommx_python_mip_adapter/exception/index writing output... [100%] autoapi/ommx_python_mip_adapter/index .. index generating indices... genindex py-modindex done writing additional pages... search done dumping search index in English (code: en)... done dumping object inventory... done build succeeded, 31 warnings. The HTML pages are in ../../_readthedocs/html.