Skip to content

Commit 63c98d8

Browse files
ksk-jijksk-jij
authored
Merge pull request #33 from Jij-Inc/sort/docs
Sort code
2 parents 2996b31 + cf28f8c commit 63c98d8

File tree

12 files changed

+1322
-194
lines changed

12 files changed

+1322
-194
lines changed

‎.github/workflows/test.yml‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@ name: Python Test
22

33
on:
44
workflow_dispatch:
5-
# push:
6-
# branches:
7-
# - main
8-
# pull_request:
9-
# types:
10-
# - opened
11-
# - reopened
12-
# - synchronize
5+
push:
6+
branches:
7+
- main
8+
pull_request:
9+
types:
10+
- opened
11+
- reopened
12+
- synchronize
1313

1414
permissions:
1515
contents: read

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# OMMX Quantum Benchmarks
22
OMMX Quantum Benchmarks provides access to quantum optimization benchmark datasets in [OMMX](https://jij-inc.github.io/ommx/en/introduction.html) format for easier integration with quantum and classical optimization workflows.
33

4-
Documentation: https://jij-inc.github.io/QmmxQuantumBenchmarks/
4+
Documentation: https://jij-inc.github.io/OmmxQuantumBenchmarks/
55

66
## Quick Start
77
### Installation

‎docs/en/_config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ sphinx:
5959
- show-module-summary
6060
- imported-members
6161
- no-index
62+
- special-members
6263
autoapi_ignore:
6364
- "**/uploader.py"
6465
- "**/uploader/*"

‎docs/en/_toc.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,6 @@ parts:
3030
chapters:
3131
- file: autoapi/index
3232

33-
- caption: "Release Notes"
34-
chapters:
35-
- file: release_note/index
33+
# - caption: "Release Notes"
34+
# chapters:
35+
# - file: release_note/index

‎docs/en/release_note/index.ipynb‎

Lines changed: 2 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,7 @@
44
"cell_type": "markdown",
55
"id": "8ecdc601",
66
"metadata": {},
7-
"source": [
8-
"# Release Notes\n",
9-
"\n",
10-
"## Version 0.1.0\n",
11-
"\n",
12-
"**Initial Release - QOBLIB Dataset Collection**\n",
13-
"\n",
14-
"### Overview\n",
15-
"This initial release establishes OMMX Quantum Benchmarks as a collection of optimization benchmark datasets in OMMX format. The first collection includes selected datasets from the [QOBLIB (Quantum Optimization Benchmarking Library)](https://git.zib.de/qopt/qoblib-quantum-optimization-benchmarking-library).\n",
16-
"\n",
17-
"**Scope**: This release focuses on QOBLIB datasets, with framework designed to accommodate additional benchmark sources in future releases.\n",
18-
"\n",
19-
"### Features\n",
20-
"- Python API for accessing quantum optimization benchmark datasets\n",
21-
"- OMMX format conversion and standardization\n",
22-
"- GitHub Container Registry integration for distributed data access\n",
23-
"- Consistent interface across all dataset categories\n",
24-
"\n",
25-
"### Currently Available Data\n",
26-
"**From QOBLIB Collection**:\n",
27-
"- **Marketsplit** (01): 160+ instances with binary linear and unconstrained formulations\n",
28-
"- **Labs** (02): 99 instances with integer and quadratic unconstrained formulations\n",
29-
"\n",
30-
"### Attribution\n",
31-
"All converted data is derived from the original QOBLIB repository created by Thorsten Koch, David E. Bernal Neira, and colleagues, licensed under CC BY 4.0."
32-
]
7+
"source": "# Release Notes\n\n## Version 0.1.0\n\n**Initial Release - QOBLIB Dataset Collection**\n\n### Overview\nThis initial release establishes OMMX Quantum Benchmarks as a collection of optimization benchmark datasets in OMMX format. The first collection includes selected datasets from the [QOBLIB (Quantum Optimization Benchmarking Library)](https://git.zib.de/qopt/qoblib-quantum-optimization-benchmarking-library).\n\n**Scope**: This release focuses on QOBLIB datasets, with framework designed to accommodate additional benchmark sources in future releases.\n\n### Features\n- Python API for accessing quantum optimization benchmark datasets\n- OMMX format conversion and standardization\n- GitHub Container Registry integration for distributed data access\n- Consistent interface across all dataset categories\n\n### Currently Available Data\n**From QOBLIB Collection**:\n- **Labs** (02): 99 instances with integer and quadratic unconstrained formulations\n- **Birkhoff** (03): 800 instances with integer linear formulations\n- **Steiner** (04): 31 instances with integer linear formulations\n- **Topology** (10): 16 instances with flow MIP, Seidel linear, and Seidel quadratic formulations\n\n### Attribution\nAll converted data is derived from the original QOBLIB repository created by Thorsten Koch, David E. Bernal Neira, and colleagues, licensed under CC BY 4.0."
338
}
349
],
3510
"metadata": {
@@ -41,4 +16,4 @@
4116
},
4217
"nbformat": 4,
4318
"nbformat_minor": 5
44-
}
19+
}

‎docs/en/tutorial/usage/dataset_overview.ipynb‎

Lines changed: 118 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,7 @@
2121
"\n",
2222
"**Problem Type**: Laboratory assignment problems \n",
2323
"**Models**: Integer, Quadratic unconstrained \n",
24-
"**Instances**: 99 instances (labs002 - labs100)\n",
25-
"\n",
26-
"Laboratory problems typically involve resource allocation and scheduling in laboratory environments."
24+
"**Instances**: 99 instances (labs002 - labs100)"
2725
]
2826
},
2927
{
@@ -56,20 +54,130 @@
5654
"cell_type": "markdown",
5755
"id": "704f1da4",
5856
"metadata": {},
57+
"source": [
58+
"## Birkhoff (`03_birkhoff`)\n",
59+
"\n",
60+
"**Problem Type**: Birkhoff polytope problems \n",
61+
"**Models**: Integer linear \n",
62+
"**Instances**: 800 instances (bhD-3-001 - bhS-6-100)"
63+
]
64+
},
65+
{
66+
"cell_type": "code",
67+
"execution_count": 2,
68+
"id": "yt34ivrq2v",
69+
"metadata": {},
70+
"outputs": [
71+
{
72+
"name": "stdout",
73+
"output_type": "stream",
74+
"text": [
75+
"Available models: ['integer_linear']\n",
76+
"integer_linear: 800 instances\n"
77+
]
78+
}
79+
],
80+
"source": [
81+
"from ommx_quantum_benchmarks.qoblib import Birkhoff\n",
82+
"\n",
83+
"dataset = Birkhoff()\n",
84+
"print(f\"Available models: {dataset.model_names}\")\n",
85+
"for model in dataset.model_names:\n",
86+
" instances = dataset.available_instances[model]\n",
87+
" print(f\"{model}: {len(instances)} instances\")"
88+
]
89+
},
90+
{
91+
"cell_type": "markdown",
92+
"id": "srqvnex133",
93+
"metadata": {},
94+
"source": [
95+
"## Steiner (`04_steiner`)\n",
96+
"\n",
97+
"**Problem Type**: Steiner tree problems \n",
98+
"**Models**: Integer linear \n",
99+
"**Instances**: 31 instances (stp_s020_l2_t3_h2_rs24098 - stp_s040_l2_t4_h3_rs123)"
100+
]
101+
},
102+
{
103+
"cell_type": "code",
104+
"execution_count": 3,
105+
"id": "2rs94wyke07",
106+
"metadata": {},
107+
"outputs": [
108+
{
109+
"name": "stdout",
110+
"output_type": "stream",
111+
"text": [
112+
"Available models: ['integer_linear']\n",
113+
"integer_linear: 31 instances\n"
114+
]
115+
}
116+
],
117+
"source": [
118+
"from ommx_quantum_benchmarks.qoblib import Steiner\n",
119+
"\n",
120+
"dataset = Steiner()\n",
121+
"print(f\"Available models: {dataset.model_names}\")\n",
122+
"for model in dataset.model_names:\n",
123+
" instances = dataset.available_instances[model]\n",
124+
" print(f\"{model}: {len(instances)} instances\")"
125+
]
126+
},
127+
{
128+
"cell_type": "markdown",
129+
"id": "mynxdaz9bc7",
130+
"metadata": {},
131+
"source": [
132+
"## Topology (`10_topology`)\n",
133+
"\n",
134+
"**Problem Type**: Network topology optimization \n",
135+
"**Models**: Flow MIP, Seidel linear, Seidel quadratic \n",
136+
"**Instances**: 16 instances per model (topology_15_3 - topology_50_4)"
137+
]
138+
},
139+
{
140+
"cell_type": "code",
141+
"execution_count": 4,
142+
"id": "gngmnigjefn",
143+
"metadata": {},
144+
"outputs": [
145+
{
146+
"name": "stdout",
147+
"output_type": "stream",
148+
"text": [
149+
"Available models: ['flow_mip', 'seidel_linear', 'seidel_quadratic']\n",
150+
"flow_mip: 16 instances\n",
151+
"seidel_linear: 16 instances\n",
152+
"seidel_quadratic: 16 instances\n"
153+
]
154+
}
155+
],
156+
"source": [
157+
"from ommx_quantum_benchmarks.qoblib import Topology\n",
158+
"\n",
159+
"dataset = Topology()\n",
160+
"print(f\"Available models: {dataset.model_names}\")\n",
161+
"for model in dataset.model_names:\n",
162+
" instances = dataset.available_instances[model]\n",
163+
" print(f\"{model}: {len(instances)} instances\")"
164+
]
165+
},
166+
{
167+
"cell_type": "markdown",
168+
"id": "n0vhnnrkmla",
169+
"metadata": {},
59170
"source": [
60171
"## Other Dataset Categories\n",
61172
"\n",
62173
"The following dataset categories are defined in the framework but currently contain no instances. These represent problem types that may be expanded in future releases:\n",
63174
"\n",
64175
"- **Market Split** (`01_marketsplit`) - Binary linear and binary unconstrained market split problems\n",
65-
"- **Birkhoff** (`03_birkhoff`) - Integer linear problems related to doubly stochastic matrices\n",
66-
"- **Steiner** (`04_steiner`) - Integer linear Steiner tree problems\n",
67176
"- **Sports** (`05_sports`) - Mixed integer linear sports scheduling problems\n",
68177
"- **Portfolio** (`06_portfolio`) - Binary quadratic and quadratic unconstrained portfolio optimization\n",
69178
"- **Independent Set** (`07_independent_set`) - Binary linear and unconstrained graph problems\n",
70179
"- **Network** (`08_network`) - Integer linear network optimization\n",
71-
"- **Routing** (`09_routing`) - Integer linear vehicle routing problems \n",
72-
"- **Topology** (`10_topology`) - Network topology problems with multiple formulations\n",
180+
"- **Routing** (`09_routing`) - Integer linear vehicle routing problems\n",
73181
"\n",
74182
"**Note**: These datasets can be instantiated but will return empty instance lists. Check the `available_instances` property to see current availability.\n",
75183
"\n",
@@ -79,14 +187,14 @@
79187
"|---------|--------|----------------|---------|\n",
80188
"| Marketsplit | 2 | 0 | 🚧 Defined, no instances |\n",
81189
"| Labs | 2 | 99 | ✅ Available |\n",
82-
"| Birkhoff | 1 | 0 | 🚧 Defined, no instances |\n",
83-
"| Steiner | 1 | 0 | 🚧 Defined, no instances |\n",
190+
"| Birkhoff | 1 | 800 | ✅ Available |\n",
191+
"| Steiner | 1 | 31 | ✅ Available |\n",
84192
"| Sports | 1 | 0 | 🚧 Defined, no instances |\n",
85193
"| Portfolio | 2 | 0 | 🚧 Defined, no instances |\n",
86194
"| IndependentSet | 2 | 0 | 🚧 Defined, no instances |\n",
87195
"| Network | 1 | 0 | 🚧 Defined, no instances |\n",
88196
"| Routing | 1 | 0 | 🚧 Defined, no instances |\n",
89-
"| Topology | 3 | 0 | 🚧 Defined, no instances |\n",
197+
"| Topology | 3 | 16 | ✅ Available |\n",
90198
"\n",
91199
"**Legend**: \n",
92200
"- ✅ Available: Instances have been converted and are accessible\n",

‎docs/ja/_config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ sphinx:
5959
- show-module-summary
6060
- imported-members
6161
- no-index
62+
- special-members
6263
autoapi_ignore:
6364
- "**/uploader.py"
6465
- "**/uploader/*"

‎docs/ja/_toc.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,6 @@ parts:
3030
chapters:
3131
- file: autoapi/index
3232

33-
- caption: "リリースノート"
34-
chapters:
35-
- file: release_note/index
33+
# - caption: "リリースノート"
34+
# chapters:
35+
# - file: release_note/index

‎docs/ja/release_note/index.ipynb‎

Lines changed: 2 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,7 @@
44
"cell_type": "markdown",
55
"id": "c1f5f8b4",
66
"metadata": {},
7-
"source": [
8-
"# リリースノート\n",
9-
"\n",
10-
"## バージョン 0.1.0\n",
11-
"\n",
12-
"**初回リリース - QOBLIBデータセットコレクション**\n",
13-
"\n",
14-
"### 概要\n",
15-
"この初回リリースでは、OMMX Quantum BenchmarksをOMMX形式の最適化ベンチマークデータセットのコレクションとして確立します。最初のコレクションには、[QOBLIB（Quantum Optimization Benchmarking Library）](https://git.zib.de/qopt/qoblib-quantum-optimization-benchmarking-library)から選択されたデータセットが含まれています。\n",
16-
"\n",
17-
"**範囲**: このリリースはQOBLIBデータセットに焦点を当てており、将来のリリースで追加のベンチマークソースに対応するためのフレームワークが設計されています。\n",
18-
"\n",
19-
"### 機能\n",
20-
"- 量子最適化ベンチマークデータセットにアクセスするためのPython API\n",
21-
"- OMMX形式の変換と標準化\n",
22-
"- 分散データアクセスのためのGitHub Container Registry統合\n",
23-
"- 全データセットカテゴリにわたる一貫したインターフェース\n",
24-
"\n",
25-
"### 現在利用可能なデータ\n",
26-
"**QOBLIBコレクションから**:\n",
27-
"- **Labs** (02): 整数および二次制約なし定式化による99インスタンス\n",
28-
"\n",
29-
"### 帰属\n",
30-
"変換されたすべてのデータは、Thorsten Koch、David E. Bernal Neira、および同僚によって作成された元のQOBLIBリポジトリから派生しており、CC BY 4.0ライセンスの下で提供されています。"
31-
]
7+
"source": "# リリースノート\n\n## バージョン 0.1.0\n\n**初回リリース - QOBLIBデータセットコレクション**\n\n### 概要\nこの初回リリースでは、OMMX Quantum BenchmarksをOMMX形式の最適化ベンチマークデータセットのコレクションとして確立します。最初のコレクションには、[QOBLIB（Quantum Optimization Benchmarking Library）](https://git.zib.de/qopt/qoblib-quantum-optimization-benchmarking-library)から選択されたデータセットが含まれています。\n\n**範囲**: このリリースはQOBLIBデータセットに焦点を当てており、将来のリリースで追加のベンチマークソースに対応するためのフレームワークが設計されています。\n\n### 機能\n- 量子最適化ベンチマークデータセットにアクセスするためのPython API\n- OMMX形式の変換と標準化\n- 分散データアクセスのためのGitHub Container Registry統合\n- 全データセットカテゴリにわたる一貫したインターフェース\n\n### 現在利用可能なデータ\n**QOBLIBコレクションから**:\n- **Labs** (02): 整数および二次制約なし定式化による99インスタンス\n- **Birkhoff** (03): 整数線形定式化による800インスタンス\n- **Steiner** (04): 整数線形定式化による31インスタンス\n- **Topology** (10): フローMIP、Seidel線形、Seidel二次定式化による16インスタンス\n\n### 帰属\n変換されたすべてのデータは、Thorsten Koch、David E. Bernal Neira、および同僚によって作成された元のQOBLIBリポジトリから派生しており、CC BY 4.0ライセンスの下で提供されています。"
328
}
339
],
3410
"metadata": {
@@ -52,4 +28,4 @@
5228
},
5329
"nbformat": 4,
5430
"nbformat_minor": 5
55-
}
31+
}

0 commit comments

Comments
 (0)