OMMX Python SDK 1.8.2

What's Changed

Bug fix

• HotFix: bump up minimum ommx version to 1.8.1 in adapters using ommx.adapter.SolverAdapter by @termoshtt in #308

Others

• Start developing OMMX Python SDK 1.8.2 by @github-actions in #307
• Tighten required OMMX Python SDK version of adapters by @termoshtt in #309

Full Changelog: python-1.8.1...python-1.8.2

OMMX Python SDK 1.8.1

What's Changed

Protobuf update

• Supports SOS1 Detection by @konn in #301

Documentation update

• Enhance Documentation for docs/en/tutorial/download_miplib_instance.ipynb by @ahao27 in #296
• Enhance Documentation for docs/en/tutorial/solve_with_ommx_adapter.ipynb by @ahao27 in #294

Full Changelog: python-1.8.0...python-1.8.1

OMMX Rust SDK 2.0.0 Release candidate 1

What's Changed

Breaking Changes

• Revise Instance::validate* APIs by @termoshtt in #203

Bug fix

• Bug fix of as_{qubo,pubo}_format as it does not sum up the same terms. by @termoshtt in #238

Protobuf update

• Removed constraints by @termoshtt in #189
• OMMX Adapter for OpenJij, introduce ommx.v1.SampleSet by @termoshtt in #236
• feasible_unrelaxed field representing the feasibility including the removed constraints by @termoshtt in #251
• Add decision_variable_dependency to represent polynomial dependency between decision variables by @termoshtt in #257
• Deprecate feasible_unrelaxed in *.proto, and introduce feasible_relaxed by @termoshtt in #280

Rust SDK update

• Fill ommx.v1.Solution.state with substituted_value of DecisionVariable by @termoshtt in #207
• Uniform penalty method by @termoshtt in #227
• MPS: Only write used variables to output by @Zengor in #229
• QPLIB format parser by @Zengor in #250
• Get each sample as Solution from SampleSet by @termoshtt in #276
• ommx.v1.{SampleSet, ParametricInstance} support in OMMX Artifact by @termoshtt in #277
• Rename to Instance::as_{pubo, qubo}_format to emphasize the format change by @termoshtt in #202
• Add penalty weight parameter id to removed constraint for inverse lookup by @termoshtt in #228
• Remove zero coefficients in Instance::as_{pubo,qubo}_format by @termoshtt in #240
• Substitute polynomials by @termoshtt in #258
• Supports SOS1 Detection by @konn in #301
• OMMX Rust SDK 2.0.0-rc.1 by @termoshtt in #302

Full Changelog: rust-2.0.0-rc.0...rust-2.0.0-rc.1

OMMX Python SDK 1.8.0

Summary

• ⚠️ Breaking changes in OMMX Adapters due to the introduction of ommx.adapter.SolverAdapter abstract class.

What's Changed

Breaking changes

• Add SolverAdapter and OMMXPythonMIPAdapter by @Zengor in #272
• Add OMMXPySCIPOptAdapter by @Zengor in #292

Documentation update

• Enhance Documentation for docs/en/introduction.ipynb by @ahao27 in #289
• Fix URL of Binder/Colab for Jupyter Book by @termoshtt in #293
• Enhance Documentation for docs/en/ommx_ecosystem/solver_adapter_guide.ipynb by @ahao27 in #290

Others

• Fix redirect URL of GitHub Pages by @termoshtt in #291

New Contributors

• @ahao27 made their first contribution in #289

Full Changelog: python-1.7.0...python-1.8.0

OMMX Python SDK 1.7.0

Summary

• 🆕 English version of Jupyter Book
• 🆕 QPLIB format parser has been added
• 🆕 Useful APIs for ommx.v1.SampleSet and ommx.v1.ParametricInstance including OMMX Artifact integration.
• ⚠️ The feasible field in ommx.v1.Solution and ommx.v1.SampleSet changed to take into accout the removed_constraints in ommx.v1.Instance
  • In 1.6.0 where removed_constraints has been introduced, feasible does not see it. But it is not intuitive.

What's Changed

Protobuf update

• Add decision_variable_dependency to represent polynomial dependency between decision variables by @termoshtt in #257
• Deprecate feasible_unrelaxed in *.proto, and introduce feasible_relaxed by @termoshtt in #280

Python SDK update

• QPLIB format parser by @Zengor in #250
• Ignore type error from pandas with numpy 2.0 by @termoshtt in #274
• Get each sample as Solution from SampleSet by @termoshtt in #276
• ommx.v1.{SampleSet, ParametricInstance} support in OMMX Artifact by @termoshtt in #277

Documentation update

• Use Python SDK 1.6.0 in book by @termoshtt in #259
• Add OMMX adapter guide by @Zengor in #267
• Rename to "OMMX Solver Adapter" by @NY57 in #268
• OMMX Solver Adapter実装ガイドの微修正 by @NY57 in #273
• TSP tutorial does not contains t + 1 = N term in objective by @termoshtt in #279
• Move JupyterBook directory from doc/ to docs/ja to ready English version document by @termoshtt in #281
• English version of Jupyter Book by @termoshtt in #282

Others

• Start developing OMMX Python SDK 1.6.1 by @github-actions in #256
• Add badge for English book by @termoshtt in #284

Full Changelog: python-1.6.0...python-1.7.0

OMMX Python SDK 1.6.0

Summary

• OMMX starts to support QUBO.
  • New adapter package ommx-openjij-adapter has been added.
    • Please see its tutorial page (in Japanese)
  • Several APIs are added for converting ommx.v1.Instance into QUBO format. Please see the above tutorial.
• Python 3.8 support has been dropped due to its EOL

What's Changed

Breaking Changes

• Revise Instance::validate* APIs by @termoshtt in #203
• Do not use multi-index for dataframe property by @termoshtt in #208

Bug fix

• Restore Solution.annotations in Artifact.get_solution by @termoshtt in #212

Protobuf update

• OMMX Adapter for OpenJij, introduce ommx.v1.SampleSet by @termoshtt in #236
• feasible_unrelaxed field representing the feasibility including the removed constraints by @termoshtt in #251

Python SDK update

• ommx.v1.ParametericInstance and Instance.penalty_method in Python SDK by @termoshtt in #200
• Fill ommx.v1.Solution.state with substituted_value of DecisionVariable by @termoshtt in #207
• Drop Python 3.8 because it has been ended at 2024/10/7 by @termoshtt in #209
• Function.terms and related properties by @termoshtt in #214
• Introduce AsConstraint abstract class to share comparison operators by @termoshtt in #222
• Override __eq__ method also for Quadratic and others by @termoshtt in #224
• Uniform penalty method by @termoshtt in #227
• Release candidate of Python SDK 1.6.0rc1 by @termoshtt in #230
• MPS: Only write used variables to output by @Zengor in #229
• Fix project URLs in pyproject.toml of Adapters by @termoshtt in #237
• Extract values from ommx.v1.Solution with name and subscripts annotations by @termoshtt in #239
• Get optimality from model in adapters' model_to_solution by @Zengor in #241
• Support maximization problem for OpenJij Adapter by @termoshtt in #243
• Bump jinja2 from 3.1.4 to 3.1.5 in the pip group across 1 directory by @dependabot in #249
• Revise OpenJij-Adapter APIs by @termoshtt in #252

Rust SDK update

Since Python SDK uses Rust SDK internally, following changes are also related to this release:

• Add penalty weight parameter id to removed constraint for inverse lookup by @termoshtt in #228
• Remove zero coefficients in Instance::as_{pubo,qubo}_format by @termoshtt in #240

Documentation update

• Sphinx document of ommx.v1 module is broken by @termoshtt in #204
• Fix binder link of jupyter-book by @termoshtt in #205
• Release note for Python SDK 1.5.0 by @termoshtt in #206
• Generate requirements.txt for Binder using uv pip compile by @termoshtt in #213
• Show inherited members in the Python SDK documentation by @termoshtt in #221
• About ommx.v1.Function in Jupyter-Book by @termoshtt in #210
• About ommx.v1.Instance in Jupyter-Book by @termoshtt in #223
• About ommx.v1.Soluiton in Jupyter-Book by @termoshtt in #225
• Tutorial for OpenJij-Adapter by @termoshtt in #242

Full Changelog: python-1.5.1...python-1.6.0

OMMX Python SDK 1.6.0 Release Candidate 3

This is a draft for changes in 1.6.0 release note, not the change from 1.6.0rc2

What's Changed

Breaking Changes

• Do not use multi-index for dataframe property by @termoshtt in #208

Bug fix

• Restore Solution.annotations in Artifact.get_solution by @termoshtt in #212

Protobuf update

• OMMX Adapter for OpenJij, introduce ommx.v1.SampleSet by @termoshtt in #236
• feasible_unrelaxed field representing the feasibility including the removed constraints by @termoshtt in #251

Python SDK update

• ommx.v1.ParametericInstance and Instance.penalty_method in Python SDK by @termoshtt in #200
• Fill ommx.v1.Solution.state with substituted_value of DecisionVariable by @termoshtt in #207
• Drop Python 3.8 because it has been ended at 2024/10/7 by @termoshtt in #209
• Function.terms and related properties by @termoshtt in #214
• Introduce AsConstraint abstract class to share comparison operators by @termoshtt in #222
• Override __eq__ method also for Quadratic and others by @termoshtt in #224
• Uniform penalty method by @termoshtt in #227
• Release candidate of Python SDK 1.6.0rc1 by @termoshtt in #230
• MPS: Only write used variables to output by @Zengor in #229
• Fix project URLs in pyproject.toml of Adapters by @termoshtt in #237
• Extract values from ommx.v1.Solution with name and subscripts annotations by @termoshtt in #239
• Get optimality from model in adapters' model_to_solution by @Zengor in #241
• Support maximization problem for OpenJij Adapter by @termoshtt in #243
• Bump jinja2 from 3.1.4 to 3.1.5 in the pip group across 1 directory by @dependabot in #249
• Revise OpenJij-Adapter APIs by @termoshtt in #252

Rust SDK update

• Rename to Instance::as_{pubo, qubo}_format to emphasize the format change by @termoshtt in #202
• Bump the dependencies group with 16 updates by @dependabot in #216
• Add penalty weight parameter id to removed constraint for inverse lookup by @termoshtt in #228
• Bump the dependencies group with 3 updates by @dependabot in #235
• Remove zero coefficients in Instance::as_{pubo,qubo}_format by @termoshtt in #240
• Bump the dependencies group with 9 updates by @dependabot in #246

Documentation update

• Sphinx document of ommx.v1 module is broken by @termoshtt in #204
• Fix binder link of jupyter-book by @termoshtt in #205
• Release note for Python SDK 1.5.0 by @termoshtt in #206
• Generate requirements.txt for Binder using uv pip compile by @termoshtt in #213
• Show inherited members in the Python SDK documentation by @termoshtt in #221
• About ommx.v1.Function in Jupyter-Book by @termoshtt in #210
• About ommx.v1.Instance in Jupyter-Book by @termoshtt in #223
• About ommx.v1.Soluiton in Jupyter-Book by @termoshtt in #225

Others

• Start developing OMMX Python SDK 1.5.2 by @github-actions in #201
• Add Dependabot configuration for pip by @termoshtt in #215
• Start developing OMMX Python SDK 1.6.0rc2 by @github-actions in #231
• Specify the Python project directories for dependabot by @termoshtt in #233
• Bug fix of as_{qubo,pubo}_format as it does not sum up the same terms. by @termoshtt in #238
• Fix Python Release workflow by @termoshtt in #245
• Start developing OMMX Python SDK 1.6.0rc3 by @github-actions in #247

Full Changelog: python-1.5.1...python-1.6.0rc3

OMMX Python SDK 1.6.0 Release Candidate 2

Following are changes from 1.6.0rc1 release, not from 1.5.1

What's Changed

Protobuf update

• OMMX Adapter for OpenJij, introduce ommx.v1.SampleSet by @termoshtt in #236

Python SDK update

• MPS: Only write used variables to output by @Zengor in #229
• Fix project URLs in pyproject.toml of Adapters by @termoshtt in #237
• Extract values from ommx.v1.Solution with name and subscripts annotations by @termoshtt in #239
• Get optimality from model in adapters' model_to_solution by @Zengor in #241
• Support maximization problem for OpenJij Adapter by @termoshtt in #243

Documentation update

• About ommx.v1.Function in Jupyter-Book by @termoshtt in #210
• About ommx.v1.Instance in Jupyter-Book by @termoshtt in #223
• About ommx.v1.Soluiton in Jupyter-Book by @termoshtt in #225

Others

• Start developing OMMX Python SDK 1.6.0rc2 by @github-actions in #231
• Specify the Python project directories for dependabot by @termoshtt in #233
• Bug fix of as_{qubo,pubo}_format as it does not sum up the same terms. by @termoshtt in #238
• Fix Python Release workflow by @termoshtt in #245

Full Changelog: python-1.6.0rc1...python-1.6.0rc2

OMMX Python SDK 1.6.0 Release Candidate 1

What's Changed

Breaking Changes

• Do not use multi-index for dataframe property by @termoshtt in #208

Bug fix

• Restore Solution.annotations in Artifact.get_solution by @termoshtt in #212

Python SDK update

• ommx.v1.ParametericInstance and Instance.penalty_method in Python SDK by @termoshtt in #200
• Fill ommx.v1.Solution.state with substituted_value of DecisionVariable by @termoshtt in #207
• Drop Python 3.8 because it has been ended at 2024/10/7 by @termoshtt in #209
• Function.terms and related properties by @termoshtt in #214
• Introduce AsConstraint abstract class to share comparison operators by @termoshtt in #222
• Override __eq__ method also for Quadratic and others by @termoshtt in #224
• Uniform penalty method by @termoshtt in #227
• Add penalty weight parameter id to removed constraint for inverse lookup by @termoshtt in #228

Documentation update

• Sphinx document of ommx.v1 module is broken by @termoshtt in #204
• Fix binder link of jupyter-book by @termoshtt in #205
• Release note for Python SDK 1.5.0 by @termoshtt in #206
• Generate requirements.txt for Binder using uv pip compile by @termoshtt in #213
• Show inherited members in the Python SDK documentation by @termoshtt in #221

Others

• Start developing OMMX Python SDK 1.5.2 by @github-actions in #201
• Add Dependabot configuration for pip by @termoshtt in #215
• Release candidate of Python SDK 1.6.0rc1 by @termoshtt in #230

Full Changelog: python-1.5.1...python-1.6.0rc1

OMMX Python SDK 1.5.1

What's Changed

Protobuf update

• Removed constraints by @termoshtt in #189

Python SDK update

• Add py.typed and missing __all__ definitions to make pyright happy by @konn in #197

Others

• Start developing OMMX Python SDK 1.5.1 by @github-actions in #196

Full Changelog: python-1.5.0...python-1.5.1