Merge branch 'main' into on-disck-format

.github/release.yml

@@ -3,10 +3,10 @@ changelog:
     - title: Protobuf update
       labels:
         - proto
-    - title: Python binding update
+    - title: Python SDK update
       labels:
         - python
-    - title: Rust binding update
+    - title: Rust SDK update
       labels:
         - rust
     - title: Others

.github/workflows/python.yml

@@ -60,7 +60,7 @@ jobs:
 
       - name: Run tests
         run: |
-          python -m pytest
+          python -m pytest -vv --doctest-modules
 
   lint-python:
     runs-on: ubuntu-latest
@@ -81,5 +81,4 @@ jobs:
 
       - name: Lint
         run: |
-          python -m mypy python/ommx
           python -m pyright python/ommx

README.md

@@ -22,8 +22,8 @@ This project manages several versions as follows:
 - Schemas in `ommx.v1` will be compatible after [ommx.v1 schema release](https://github.com/Jij-Inc/ommx/milestone/3). Note that the schema can be changed incompatible way until this release.
 - `v2` schema with namespace `ommx.v2` will start developing if we need to change the schema in incompatible way after `ommx.v1` release. Compatible changes will be made in `v1` schema also after its release. We never create namespaces like `ommx.v1_1`.
 
-## Language specific bindings
-This project consists of main protobuf schema and language specific bindings.
+## Language specific SDK
+This project consists of main protobuf schema and language specific SDK.
 Their versions are managed independently, and adopts semantic versioning.
 
 # License
@@ -38,3 +38,7 @@ at your option.
 
 # Contribution
 TBW
+
+# Acknowledgement
+![BRIDGE](./BRIDGE.png)
+This work was performed for Council for Science, Technology and Innovation (CSTI), Cross-ministerial Strategic Innovation Promotion Program (SIP), “Promoting the application of advanced quantum technology platforms to social issues”(Funding agency : QST).

proto/ommx/v1/instance.proto

@@ -31,4 +31,18 @@ message Instance {
   //
   // TODO: Add semi-definite constraints to represent SDP
   // repeated SemiDefiniteConstraint semi_definite_constraints = ?;
+
+  // The sense of this instance
+  enum Sense {
+    SENSE_UNSPECIFIED = 0;
+    SENSE_MINIMIZE = 1;
+    SENSE_MAXIMIZE = 2;
+  }
+
+  // The sense of this problem, i.e. minimize the objective or maximize it.
+  //
+  // Design decision note:
+  // - This is a required field. Most mathematical modeling tools allow for an empty sense and default to minimization. Alternatively, some tools do not create such a field and represent maximization problems by negating the objective function. This project prefers explicit descriptions over implicit ones to avoid such ambiguity and to make it unnecessary for developers to look up the reference for the treatment of omitted cases.
+  //
+  Sense sense = 5;
 }

python/BRIDGE.png

@@ -0,0 +1 @@
+../BRIDGE.png

python/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ommx"
-version = "0.1.0"
+version = "0.2.0"
 description = "Open Mathematical prograMming eXchange (OMMX)"
 authors = [
     { name="Jij Inc.", email="info@j-ij.com" },
@@ -18,6 +18,7 @@ classifiers = [
     "License :: OSI Approved :: MIT License",
 ]
 dependencies = [
+    "numpy>=1.23.0, <2.0.0",
     "protobuf>=5.26.1, <6.0.0",
 ]
 

rust/ommx/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ommx"
-version = "0.1.0"
+version = "0.2.0"
 edition = "2021"
 license = "MIT OR Apache-2.0"